PipelineRequestOptions interface

初始化要求的設定。 幾乎等同於 Partial<PipelineRequest>,但 url 是必填的。

屬性

abortSignal

用來在稍後中止要求。

body

HTTP 本文內容(如果有的話)

formData

模擬瀏覽器表單文章

headers

提出要求時要使用的 HTTP 標頭。

keepAlive

如果應該重複使用連接。 預設設置為 true。

method

提出要求時要使用的 HTTP 方法。

onDownloadProgress

下載進度引發的回呼。

onUploadProgress

上傳進度時引發的回呼。

proxySettings

代理配置。

requestId

要求的唯一識別碼。 用於記錄和追蹤。

spanOptions

啟用追蹤時用來建立範圍的選項。

streamResponseStatusCodes

回應狀態代碼的清單,其對應的 PipelineResponse 主體應視為數據流。

timeout

要求在自動終止之前可能需要的毫秒數。 如果要求終止,則會擲回 AbortError。 默認為 0,這會停用逾時。

url

要提出要求的 URL。

withCredentials

如果認證 (cookies) 應該在 XHR 期間一起傳送。 預設為 False。

屬性詳細資料

abortSignal

用來在稍後中止要求。

abortSignal?: AbortSignalLike

屬性值

body

HTTP 本文內容(如果有的話)

body?: RequestBodyType

屬性值

formData

模擬瀏覽器表單文章

formData?: FormDataMap

屬性值

headers

提出要求時要使用的 HTTP 標頭。

headers?: HttpHeaders

屬性值

keepAlive

如果應該重複使用連接。 預設設置為 true。

keepAlive?: boolean

屬性值

boolean

method

提出要求時要使用的 HTTP 方法。

method?: HttpMethods

屬性值

onDownloadProgress

下載進度引發的回呼。

onDownloadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

onUploadProgress

上傳進度時引發的回呼。

onUploadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

proxySettings

代理配置。

proxySettings?: ProxySettings

屬性值

requestId

要求的唯一識別碼。 用於記錄和追蹤。

requestId?: string

屬性值

string

spanOptions

啟用追蹤時用來建立範圍的選項。

spanOptions?: SpanOptions

屬性值

@azure/core-tracing.SpanOptions

streamResponseStatusCodes

回應狀態代碼的清單,其對應的 PipelineResponse 主體應視為數據流。

streamResponseStatusCodes?: Set<number>

屬性值

Set<number>

timeout

要求在自動終止之前可能需要的毫秒數。 如果要求終止,則會擲回 AbortError。 默認為 0,這會停用逾時。

timeout?: number

屬性值

number

url

要提出要求的 URL。

url: string

屬性值

string

withCredentials

如果認證 (cookies) 應該在 XHR 期間一起傳送。 預設為 False。

withCredentials?: boolean

屬性值

boolean