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

PipelineRequest interface

有关管道发出的请求的元数据。

属性

abortSignal

用于稍后中止请求。

body

HTTP 正文内容(如果有)

formData

模拟浏览器表单文章

headers

发出请求时要使用的 HTTP 标头。

keepAlive

如果应重复使用连接。

method

发出请求时要使用的 HTTP 方法。

onDownloadProgress

下载进度触发的回调。

onUploadProgress

上传进度时触发的回调。

proxySettings

代理配置。

requestId

请求的唯一标识符。 用于日志记录和跟踪。

spanOptions

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

streamResponseStatusCodes

响应状态代码的列表,其相应的 PipelineResponse 正文应被视为流。

timeout

请求在自动终止之前可能需要的毫秒数。 如果请求终止,则会引发 AbortError。 默认值为 0,这会禁用超时。

url

要向其发出请求的 URL。

withCredentials

如果在 XHR 期间应发送凭据(Cookie)。 默认值为 false。

属性详细信息

abortSignal

用于稍后中止请求。

abortSignal?: AbortSignalLike

属性值

body

HTTP 正文内容(如果有)

body?: RequestBodyType

属性值

formData

模拟浏览器表单文章

formData?: FormDataMap

属性值

headers

发出请求时要使用的 HTTP 标头。

headers: HttpHeaders

属性值

keepAlive

如果应重复使用连接。

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

如果在 XHR 期间应发送凭据(Cookie)。 默认值为 false。

withCredentials: boolean

属性值

boolean