Sdílet prostřednictvím

Pipeline interface

  • Reference
Balíček:
@azure/core-rest-pipeline

Představuje kanál pro vytvoření požadavku HTTP na adresu URL. Kanály můžou mít několik zásad pro správu manipulace s jednotlivými požadavky před a po jeho provedení na server.

Metody

addPolicy(PipelinePolicy, AddPolicyOptions)

Přidejte do kanálu novou zásadu.
clone()

Duplikuje tento kanál, aby umožňoval úpravy existujícího kanálu bez ztlumení.
getOrderedPolicies()

Vrátí aktuální sadu zásad v kanálu v pořadí, ve kterém se použijí na požadavek. Později v seznamu je blíže k provedení požadavku.
removePolicy({ name?: string, phase?: PipelinePhase })

Odeberte zásadu z kanálu.
sendRequest(HttpClient, PipelineRequest)

Použije kanál k vytvoření požadavku HTTP.

Podrobnosti metody

addPolicy(PipelinePolicy, AddPolicyOptions)

Přidejte do kanálu novou zásadu.

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

Parametry

policy
PipelinePolicy

Zásada, která manipuluje s požadavkem.

options
AddPipelineOptions

Sada možností, kdy se má zásada spustit.

clone()

Duplikuje tento kanál, aby umožňoval úpravy existujícího kanálu bez ztlumení.

function clone(): Pipeline

Návraty

Pipeline

getOrderedPolicies()

Vrátí aktuální sadu zásad v kanálu v pořadí, ve kterém se použijí na požadavek. Později v seznamu je blíže k provedení požadavku.

function getOrderedPolicies(): PipelinePolicy[]

Návraty

PipelinePolicy[]

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

Odeberte zásadu z kanálu.

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

Parametry

options

{ name?: string, phase?: PipelinePhase }

Možnosti, které umožňují určit, které zásady se mají odebrat.

Návraty

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Použije kanál k vytvoření požadavku HTTP.

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

Parametry

httpClient
HttpClient

HttpClient, který skutečně provádí požadavek.

request
PipelineRequest

Žádost, která se má provést.

Návraty

Promise<PipelineResponse>