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

Pipeline interface

表示向 URL 发出 HTTP 请求的管道。 管道可以有多个策略来管理对服务器之前和之后每个请求的作。

方法

addPolicy(PipelinePolicy, AddPolicyOptions)

向管道添加新策略。

clone()

复制此管道以允许修改现有管道,而无需对其进行更改。

getOrderedPolicies()

返回管道中的当前策略集,其顺序将应用于请求。 稍后在列表中更接近执行请求的时间。

removePolicy({ name?: string, phase?: PipelinePhase })

从管道中删除策略。

sendRequest(HttpClient, PipelineRequest)

使用管道发出 HTTP 请求。

方法详细信息

addPolicy(PipelinePolicy, AddPolicyOptions)

向管道添加新策略。

function addPolicy(policy: PipelinePolicy, options?: AddPolicyOptions)

参数

policy
PipelinePolicy

作请求的策略。

options
AddPipelineOptions

策略何时应运行的选项集。

clone()

复制此管道以允许修改现有管道,而无需对其进行更改。

function clone(): Pipeline

返回

getOrderedPolicies()

返回管道中的当前策略集,其顺序将应用于请求。 稍后在列表中更接近执行请求的时间。

function getOrderedPolicies(): PipelinePolicy[]

返回

removePolicy({ name?: string, phase?: PipelinePhase })

从管道中删除策略。

function removePolicy(options: { name?: string, phase?: PipelinePhase }): PipelinePolicy[]

参数

options

{ name?: string, phase?: PipelinePhase }

用于指定要删除的策略的选项。

返回

sendRequest(HttpClient, PipelineRequest)

使用管道发出 HTTP 请求。

function sendRequest(httpClient: HttpClient, request: PipelineRequest): Promise<PipelineResponse>

参数

httpClient
HttpClient

实际执行请求的 HttpClient。

request
PipelineRequest

要发出的请求。

返回

Promise<PipelineResponse>