你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

WebResource interface

包:

@azure/storage-file-share

要向远程服务器发出的 HTTP 请求的说明。

属性

abortSignal	中止控制器的信号。 可用于中止发送网络请求和等待响应。
body	请求的 HTTP 正文内容。
decompressResponse	是否根据仅 Accept-Encoding 标头 (节点提取解压缩响应)
formData	表单数据，用于生成请求正文。
headers	发出请求时要使用的 HTTP 标头。
keepAlive	是否应重复使用连接。
method	发出请求时要使用的 HTTP 方法。
onDownloadProgress	下载进度时触发的回调。
onUploadProgress	上传进度时触发的回调。
proxySettings	代理配置。
query	表示为 对象的查询字符串。
requestId	请求的唯一标识符。 用于日志记录和跟踪。
streamResponseBody	是否应将 HttpOperationResponse 的正文视为流。
streamResponseStatusCodes	响应状态代码的列表，其对应的 HttpOperationResponse 正文应被视为流。
timeout	请求在自动终止之前可以花费的毫秒数。 如果请求终止， AbortError 则会引发 。
url	请求访问的 URL。
withCredentials	如果凭据 (应在 XHR 期间发送 cookie) 。

方法

clone()	克隆此请求对象。
prepare(unknown)	出于兼容性目的，这是一个 no-op，如果调用，将引发。
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

属性值

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

代理配置。

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

如果凭据 (应在 XHR 期间发送 cookie) 。

withCredentials: boolean

属性值

boolean

方法详细信息

clone()

克隆此请求对象。

function clone(): WebResourceLike

返回

WebResource

prepare(unknown)

出于兼容性目的，这是一个 no-op，如果调用，将引发。

function prepare(options: unknown): WebResourceLike

参数

options

unknown

返回

WebResource

validateRequestProperties()

验证是否定义了所需的属性，例如方法、url、标头[“Content-Type”]、headers[“accept-language”] 。 如果未定义上述某个属性，则会引发错误。 注意：出于兼容性目的，这是一个无操作。

function validateRequestProperties()