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

PipelineRequest interface

包:

@azure/core-rest-pipeline

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

属性

abortSignal	用于稍后中止请求。
agent	仅 NODEJS 用于提供自定义 http.Agent/https.Agent的仅限节点的选项。 在浏览器中运行时不执行任何作。
allowInsecureConnection	如果请求通过 HTTP 而不是 HTTPS 发送，则设置为 true
body	HTTP 正文内容（如果有）
disableKeepAlive	如果不应重复使用连接。
enableBrowserStreams	仅限浏览器 仅启用浏览器流的浏览器选项。 如果设置此选项并且响应是流，则响应将具有属性 browserStream 而不是未定义 blobBody。 默认值为 false
formData	模拟浏览器表单文章
headers	发出请求时要使用的 HTTP 标头。
method	发出请求时要使用的 HTTP 方法。
multipartBody	多部分请求的正文。
onDownloadProgress	下载进度触发的回调。
onUploadProgress	上传进度时触发的回调。
proxySettings	代理配置。
requestId	请求的唯一标识符。 用于日志记录和跟踪。
streamResponseStatusCodes	响应状态代码的列表，其相应的 PipelineResponse 正文应被视为流。 当 streamResponseStatusCodes 包含值Number.POSITIVE_INFINITY任何状态都将被视为流。
timeout	请求在自动终止之前可能需要的毫秒数。 如果请求终止，则会引发 AbortError。 默认值为 0，这会禁用超时。
tlsSettings	配置 TLS 身份验证的设置
tracingOptions	用于任何创建的 Span 的跟踪选项。
url	要向其发出请求的 URL。
withCredentials	指示在跨域请求的情况下，用户代理是否应从其他域发送 Cookie。 默认值为 false。

属性详细信息

abortSignal

用于稍后中止请求。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

agent

仅 NODEJS

用于提供自定义 http.Agent/https.Agent的仅限节点的选项。 在浏览器中运行时不执行任何作。

agent?: Agent

属性值

Agent

allowInsecureConnection

如果请求通过 HTTP 而不是 HTTPS 发送，则设置为 true

allowInsecureConnection?: boolean

属性值

boolean

body

HTTP 正文内容（如果有）

body?: RequestBodyType

属性值

RequestBodyType

disableKeepAlive

如果不应重复使用连接。

disableKeepAlive?: boolean

属性值

boolean

enableBrowserStreams

仅限浏览器

仅启用浏览器流的浏览器选项。 如果设置此选项并且响应是流，则响应将具有属性 browserStream 而不是未定义 blobBody。

默认值为 false

enableBrowserStreams?: boolean

属性值

boolean

formData

模拟浏览器表单文章

formData?: FormDataMap

属性值

FormDataMap

headers

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

headers: HttpHeaders

属性值

HttpHeaders

method

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

method: HttpMethods

属性值

HttpMethods

multipartBody

多部分请求的正文。

multipartBody?: MultipartRequestBody

属性值

MultipartRequestBody

onDownloadProgress

下载进度触发的回调。

onDownloadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

onUploadProgress

上传进度时触发的回调。

onUploadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

proxySettings

代理配置。

proxySettings?: ProxySettings

属性值

ProxySettings

requestId

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

requestId: string

属性值

string

streamResponseStatusCodes

响应状态代码的列表，其相应的 PipelineResponse 正文应被视为流。 当 streamResponseStatusCodes 包含值Number.POSITIVE_INFINITY任何状态都将被视为流。

streamResponseStatusCodes?: Set<number>

属性值

Set<number>

timeout

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

timeout: number

属性值

number

tlsSettings

配置 TLS 身份验证的设置

tlsSettings?: TlsSettings

属性值

TlsSettings

tracingOptions

用于任何创建的 Span 的跟踪选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

url

要向其发出请求的 URL。

url: string

属性值

string

withCredentials

指示在跨域请求的情况下，用户代理是否应从其他域发送 Cookie。 默认值为 false。

withCredentials: boolean

属性值

boolean