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

Pipeline interface

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

方法

addPolicy(PipelinePolicy, AddPipelineOptions)

将新策略添加到管道。

clone()

复制此管道,以允许修改现有管道而不改变它。

getOrderedPolicies()

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

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

从管道中删除策略。

sendRequest(HttpClient, PipelineRequest)

使用管道发出 HTTP 请求。

方法详细信息

addPolicy(PipelinePolicy, AddPipelineOptions)

将新策略添加到管道。

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

参数

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>