WebResource interface

套件:

@azure/storage-file-share

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

屬性

abortSignal	中止控制器的訊號。 可用來中止傳送網路要求和等候回應。
agent	僅限 NODEJS 提供自訂 http.Agent/https.Agent的僅限節點選項。 注意：這通常是多個要求共用的一個實例，以便重複使用與服務的基礎連線。 在瀏覽器中執行時，不會執行任何動作。
body	要求的 HTTP 主體內容。
decompressResponse	是否根據 Accept-Encoding 標頭解壓縮回應（僅限節點擷取）
formData	用來建置要求本文的窗體數據。
headers	提出要求時要使用的 HTTP 標頭。
keepAlive	如果應該重複使用連接。
method	提出要求時要使用的 HTTP 方法。
onDownloadProgress	下載進度引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
proxySettings	Proxy 組態。
query	表示為 對象的查詢字串。
requestId	要求的唯一標識碼。 用於記錄和追蹤。
streamResponseBody	是否應將 HttpOperationResponse 的主體視為數據流。
streamResponseStatusCodes	回應狀態代碼的清單，其對應的 HttpOperationResponse 主體應視為數據流。
timeout	要求在自動終止之前可能需要的毫秒數。 如果要求終止，則會擲回 AbortError。
url	要求所存取的 URL。
withCredentials	如果認證 （cookies） 應該在 XHR 期間一起傳送。

方法

clone()	複製此要求物件。
prepare(unknown)	這是 no-op 的相容性用途，如果呼叫，則會擲回。
validateRequestProperties()	驗證已定義方法、url、標頭[“Content-Type”]、標頭[“accept-language”] 等必要屬性。 如果未定義上述其中一個屬性，則會擲回錯誤。 注意：這是 no-op 用於相容性。

屬性詳細資料

abortSignal

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

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

agent

僅限 NODEJS

提供自訂 http.Agent/https.Agent的僅限節點選項。 注意：這通常是多個要求共用的一個實例，以便重複使用與服務的基礎連線。 在瀏覽器中執行時，不會執行任何動作。

agent?: Agent

屬性值

Agent

body

要求的 HTTP 主體內容。

body?: any

屬性值

any

decompressResponse

是否根據 Accept-Encoding 標頭解壓縮回應（僅限節點擷取）

decompressResponse?: boolean

屬性值

boolean

formData

用來建置要求本文的窗體數據。

formData?: any

屬性值

any

headers

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

headers: HttpHeadersLike

屬性值

HttpHeaders

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

proxySettings

Proxy 組態。

proxySettings?: ProxySettings

屬性值

ProxySettings

query

表示為 對象的查詢字串。

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

屬性值

{[key: string]: any}

requestId

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

requestId: string

屬性值

string

streamResponseBody

警告

此 API 現已淘汰。

Use streamResponseStatusCodes property instead.

是否應將 HttpOperationResponse 的主體視為數據流。

streamResponseBody?: boolean

屬性值

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

屬性值

Set<number>

timeout

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

timeout: number

屬性值

number

url

要求所存取的 URL。

url: string

屬性值

string

withCredentials

如果認證 （cookies） 應該在 XHR 期間一起傳送。

withCredentials: boolean

屬性值

boolean

方法詳細資料

clone()

複製此要求物件。

function clone(): WebResourceLike

傳回

WebResource

prepare(unknown)

這是 no-op 的相容性用途，如果呼叫，則會擲回。

function prepare(options: unknown): WebResourceLike

參數

options

unknown

傳回

WebResource

validateRequestProperties()

驗證已定義方法、url、標頭[“Content-Type”]、標頭[“accept-language”] 等必要屬性。 如果未定義上述其中一個屬性，則會擲回錯誤。 注意：這是 no-op 用於相容性。

function validateRequestProperties()