WebResourceLike interface

套件:

@azure/core-http

要對遠端伺服器提出 HTTP 要求的描述。

屬性

abortSignal	中止控制器的訊號。 可用來中止傳送網路要求和等候回應。
body	要求的 HTTP 主體內容。
decompressResponse	是否要根據Accept-Encoding標頭解壓縮回應， (節點擷取)
formData	表單資料，用來建置要求本文。
headers	提出要求時要使用的 HTTP 標頭。
keepAlive	如果應該重複使用連線。
method	提出要求時要使用的 HTTP 方法。
onDownloadProgress	下載進度時引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
operationResponseGetter	函式，針對指定的 OperationSpec 和 HttpOperationResponse 組合傳回適當的 OperationResponse。 如果未定義，則會使用簡單的狀態碼查閱。
operationSpec	用來剖析回應。
proxySettings	Proxy 組態。
query	以 物件表示的查詢字串。
requestId	要求的唯一識別碼。 用於記錄和追蹤。
shouldDeserialize	是否應該還原序列化 HttpOperationResponse。 如果未定義，則應該還原序列化 HttpOperationResponse。
streamResponseBody	是否應該將 HttpOperationResponse 的主體視為資料流程。
streamResponseStatusCodes	回應狀態碼的清單，其對應的 HttpOperationResponse 主體應視為資料流程。
timeout	要求可能需要的毫秒數，才能自動終止。 如果要求終止， AbortError 則會擲回 。
tracingContext	追蹤：建立範圍時所使用的內容。
url	要求所存取的 URL。
withCredentials	如果認證 (Cookie) 應該在 XHR 期間一起傳送。

方法

clone()	複製此要求物件。
prepare(RequestPrepareOptions)	設定要求的選項。
validateRequestProperties()	驗證已定義必要屬性，例如方法、URL、標頭[「Content-Type」]、headers[「accept-language」] 。 如果未定義上述其中一個屬性，則會擲回錯誤。

屬性詳細資料

abortSignal

中止控制器的訊號。 可用來中止傳送網路要求和等候回應。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

body

要求的 HTTP 主體內容。

body?: any

屬性值

any

decompressResponse

是否要根據Accept-Encoding標頭解壓縮回應， (節點擷取)

decompressResponse?: boolean

屬性值

boolean

formData

表單資料，用來建置要求本文。

formData?: any

屬性值

any

headers

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

headers: HttpHeadersLike

屬性值

HttpHeadersLike

keepAlive

如果應該重複使用連線。

keepAlive?: boolean

屬性值

boolean

method

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

method: HttpMethods

屬性值

HttpMethods

onDownloadProgress

下載進度時引發的回呼。

onDownloadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

onUploadProgress

上傳進度時引發的回呼。

onUploadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

operationResponseGetter

函式，針對指定的 OperationSpec 和 HttpOperationResponse 組合傳回適當的 OperationResponse。 如果未定義，則會使用簡單的狀態碼查閱。

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

屬性值

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

用來剖析回應。

operationSpec?: OperationSpec

屬性值

OperationSpec

proxySettings

Proxy 組態。

proxySettings?: ProxySettings

屬性值

ProxySettings

query

以 物件表示的查詢字串。

query?: {[key: string]: any}

屬性值

{[key: string]: any}

requestId

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

requestId: string

屬性值

string

shouldDeserialize

是否應該還原序列化 HttpOperationResponse。 如果未定義，則應該還原序列化 HttpOperationResponse。

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

屬性值

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

警告

此 API 現已淘汰。

Use streamResponseStatusCodes property instead.

是否應該將 HttpOperationResponse 的主體視為資料流程。

streamResponseBody?: boolean

屬性值

boolean

streamResponseStatusCodes

回應狀態碼的清單，其對應的 HttpOperationResponse 主體應視為資料流程。

streamResponseStatusCodes?: Set<number>

屬性值

Set<number>

timeout

要求可能需要的毫秒數，才能自動終止。 如果要求終止， AbortError 則會擲回 。

timeout: number

屬性值

number

tracingContext

追蹤：建立範圍時所使用的內容。

tracingContext?: Context

屬性值

@azure/core-tracing.Context

url

要求所存取的 URL。

url: string

屬性值

string

withCredentials

如果認證 (Cookie) 應該在 XHR 期間一起傳送。

withCredentials: boolean

屬性值

boolean

方法詳細資料

clone()

複製此要求物件。

function clone(): WebResourceLike

傳回

WebResourceLike

prepare(RequestPrepareOptions)

設定要求的選項。

function prepare(options: RequestPrepareOptions): WebResourceLike

參數

options

RequestPrepareOptions

傳回

WebResourceLike

validateRequestProperties()

驗證已定義必要屬性，例如方法、URL、標頭[「Content-Type」]、headers[「accept-language」] 。 如果未定義上述其中一個屬性，則會擲回錯誤。

function validateRequestProperties()