Pipeline interface
表示用於向 URL 發出 HTTPS 請求的管道。 管線可以有多個原則來管理對伺服器進行之前和之後作每個要求。
方法
| add |
將新的原則新增至管線。 |
| clone() | 複製此管線，以允許修改現有的管線，而不變更它。 |
| get |
傳回管線中目前的原則集，順序會套用至要求。 稍後在清單中執行要求時更接近。 |
| remove |
從管線移除原則。 |
| send |
使用管道發出 HTTPS 請求。 |
方法詳細資料
addPolicy(PipelinePolicy, AddPipelineOptions)
將新的原則新增至管線。
function addPolicy(policy: PipelinePolicy, options?: AddPipelineOptions)參數
- policy
- PipelinePolicy
作要求的原則。
- options
- AddPipelineOptions
原則應該執行時的一組選項。
clone()
getOrderedPolicies()
傳回管線中目前的原則集，順序會套用至要求。 稍後在清單中執行要求時更接近。
function getOrderedPolicies(): PipelinePolicy[]傳回
removePolicy({ name?: string, phase?: PipelinePhase })
從管線移除原則。
function removePolicy(options: { name?: string, phase?: PipelinePhase }): PipelinePolicy[]參數
- options
-
{ name?: string, phase?: PipelinePhase }
可讓您指定要移除之原則的選項。
傳回
sendRequest(HttpsClient, PipelineRequest)
使用管道發出 HTTPS 請求。
function sendRequest(httpsClient: HttpsClient, request: PipelineRequest): Promise<PipelineResponse>參數
- httpsClient
- HttpsClient
實際執行請求的 HttpsClient。
- request
- PipelineRequest
要提出的要求。
傳回
Promise<PipelineResponse>
