Pipeline interface

參考

套件:: @azure/core-rest-pipeline

表示對 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

傳回

Pipeline

getOrderedPolicies()

根據將套用至要求的順序，傳回管線中的目前原則集。稍後在清單中執行要求時會更接近。

function getOrderedPolicies(): PipelinePolicy[]

傳回

PipelinePolicy[]

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

從管線中移除原則。

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

參數

options: { name?: string, phase?: PipelinePhase }

可讓您指定要移除的原則的選項。

傳回

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

使用管線提出 HTTP 要求。

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

參數

httpClient: HttpClient

實際執行要求的 HttpClient。

request: PipelineRequest

要提出的要求。

傳回

Promise<PipelineResponse>

Share via