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

PipelineRequestOptions interface

包:

@azure/core-rest-pipeline

用于初始化请求的设置。 几乎等效于 Partial，但 URL 是必需的。

属性

abortSignal	用于稍后中止请求。
allowInsecureConnection	如果请求是通过 HTTP 而不是 HTTPS 发送的，则设置为 true
body	HTTP 正文内容 (（如果有任何) ）
disableKeepAlive	如果不应重复使用连接，则为 。
enableBrowserStreams	仅浏览器 允许使用流 API 的仅限浏览器选项。 如果设置此选项并使用流式处理 (请参阅 streamResponseStatusCodes) ，则响应将具有 属性 browserStream ，而不是 blobBody 未定义的属性。 默认值为“false”
formData	模拟浏览器表单帖子
headers	发出请求时要使用的 HTTP 标头。
method	发出请求时要使用的 HTTP 方法。
onDownloadProgress	下载进度时触发的回调。
onUploadProgress	上传进度时触发的回调。
proxySettings	代理配置。
requestId	请求的唯一标识符。 用于日志记录和跟踪。
streamResponseStatusCodes	响应状态代码的列表，其对应的 PipelineResponse 正文应被视为流。
timeout	请求在自动终止之前可以花费的毫秒数。 如果请求终止， AbortError 则会引发 。 默认为 0，这会禁用超时。
tracingOptions	启用跟踪时用于创建范围的选项。
url	要向其发送请求的 URL。
withCredentials	如果凭据 (应在 XHR 期间发送) Cookie。 默认为 false。

属性详细信息

abortSignal

用于稍后中止请求。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

allowInsecureConnection

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

allowInsecureConnection?: boolean

属性值

boolean

body

HTTP 正文内容 (（如果有任何) ）

body?: RequestBodyType

属性值

RequestBodyType

disableKeepAlive

如果不应重复使用连接，则为 。

disableKeepAlive?: boolean

属性值

boolean

enableBrowserStreams

仅浏览器

允许使用流 API 的仅限浏览器选项。 如果设置此选项并使用流式处理 (请参阅 streamResponseStatusCodes) ，则响应将具有 属性 browserStream ，而不是 blobBody 未定义的属性。

默认值为“false”

enableBrowserStreams?: boolean

属性值

boolean

formData

模拟浏览器表单帖子

formData?: FormDataMap

属性值

FormDataMap

headers

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

headers?: HttpHeaders

属性值

HttpHeaders

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

requestId

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

requestId?: string

属性值

string

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

属性值

Set<number>

timeout

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

timeout?: number

属性值

number

tracingOptions

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

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

url

要向其发送请求的 URL。

url: string

属性值

string

withCredentials

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

withCredentials?: boolean

属性值

boolean