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

WebResource class

包:: @azure/core-http

创建新的 WebResource 对象。

此类通过与库/实现无关并包装必要的属性来启动请求，从而通过 REST 调用提供抽象。

构造函数

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

属性

abortSignal	中止控制器的信号。可用于中止发送网络请求和等待响应。
body	请求正文。
decompressResponse	是否根据 Accept-Encoding 标头（仅节点提取）解压缩响应
formData	表单数据，用于生成请求正文。
headers	HTTP 标头。
keepAlive	是否让 HTTP 连接在整个请求中保持活动状态。
method	要使用的 HTTP 方法。
onDownloadProgress	下载进度触发的回调。
onUploadProgress	上传进度时触发的回调。
operationResponseGetter	一个函数，返回给定 OperationSpec 和 HttpOperationResponse 组合的正确 OperationResponse。如果未定义，将使用简单的状态代码查找。
operationSpec	HTTP 请求的规范。
proxySettings	如有必要，要使用的代理。
query	添加到 URL 的查询。
requestId	传出请求的唯一标识符。
shouldDeserialize	是否应反序列化 HttpOperationResponse。如果未定义，则应反序列化 HttpOperationResponse。
spanOptions	跟踪：启用跟踪时用于创建范围的选项。
streamResponseBody	是否应将 HttpOperationResponse 的正文视为流。
streamResponseStatusCodes	应将相应的 HttpOperationResponse 正文视为流的状态代码列表。
timeout	中止请求之前等待的时间（以毫秒为单位）。
tracingContext	跟踪：创建 Spans 时使用的上下文。
url	传出请求的 URL。
withCredentials	在浏览器中向跨站点目标发出请求时，是否发送凭据（通过 Cookie、授权标头或 TLS 客户端证书）。

方法

clone()	克隆此 WebResource HTTP 请求对象。
prepare(RequestPrepareOptions)	准备请求。
validateRequestProperties()	验证是否定义了所需的属性，例如方法、url、headers[“Content-Type”]、headers[“accept-language”] 。如果未定义上述属性之一，则会引发错误。

构造函数详细信息

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

参数

url: string

method: HttpMethods

body: unknown

query: {[key: string]: any}

headers: {[key: string]: any} | HttpHeadersLike

streamResponseBody: boolean

withCredentials: boolean

abortSignal: AbortSignalLike

timeout: number

onUploadProgress: (progress: TransferProgressEvent) => void

onDownloadProgress: (progress: TransferProgressEvent) => void

proxySettings: ProxySettings

keepAlive: boolean

decompressResponse: boolean

streamResponseStatusCodes: Set<number>

属性详细信息

abortSignal

中止控制器的信号。可用于中止发送网络请求和等待响应。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

body

请求正文。

body?: any

属性值

any

decompressResponse

是否根据 Accept-Encoding 标头（仅节点提取）解压缩响应

decompressResponse?: boolean

属性值

boolean

formData

表单数据，用于生成请求正文。

formData?: any

属性值

any

headers

HTTP 标头。

headers: HttpHeadersLike

属性值

HttpHeadersLike

keepAlive

是否让 HTTP 连接在整个请求中保持活动状态。

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

HTTP 请求的规范。

operationSpec?: OperationSpec

属性值

OperationSpec

proxySettings

如有必要，要使用的代理。

proxySettings?: ProxySettings

属性值

ProxySettings

query

添加到 URL 的查询。

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

属性值

{[key: string]: any}

requestId

传出请求的唯一标识符。

requestId: string

属性值

string

shouldDeserialize

是否应反序列化 HttpOperationResponse。如果未定义，则应反序列化 HttpOperationResponse。

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

属性值

boolean | (response: HttpOperationResponse) => boolean

spanOptions

跟踪：启用跟踪时用于创建范围的选项。

spanOptions?: SpanOptions

属性值

@azure/core-tracing.SpanOptions

streamResponseBody

警告

现已弃用此 API。

Use streamResponseStatusCodes property instead.

是否应将 HttpOperationResponse 的正文视为流。

streamResponseBody?: boolean

属性值

boolean

streamResponseStatusCodes

应将相应的 HttpOperationResponse 正文视为流的状态代码列表。

streamResponseStatusCodes?: Set<number>

属性值

Set<number>

timeout

中止请求之前等待的时间（以毫秒为单位）。

timeout: number

属性值

number

tracingContext

跟踪：创建 Spans 时使用的上下文。

tracingContext?: Context

属性值

@azure/core-tracing.Context

url

传出请求的 URL。

url: string

属性值

string

withCredentials

在浏览器中向跨站点目标发出请求时，是否发送凭据（通过 Cookie、授权标头或 TLS 客户端证书）。

withCredentials: boolean

属性值

boolean

方法详细信息

clone()

克隆此 WebResource HTTP 请求对象。

function clone(): WebResource

WebResource

此 WebResource HTTP 请求对象的克隆。

prepare(RequestPrepareOptions)

准备请求。

function prepare(options: RequestPrepareOptions): WebResource

参数

options: RequestPrepareOptions

用于准备请求的选项。

WebResource

返回需要提供给请求管道的已准备的 WebResource （HTTP 请求）对象。

validateRequestProperties()

验证是否定义了所需的属性，例如方法、url、headers[“Content-Type”]、headers[“accept-language”] 。如果未定义上述属性之一，则会引发错误。

function validateRequestProperties()