Udostępnij za pośrednictwem

Pipeline interface

  • Odwołanie
Pakiet:
@azure/core-rest-pipeline

Reprezentuje potok umożliwiający wysyłanie żądania HTTP do adresu URL. Potoki mogą mieć wiele zasad do zarządzania manipulowaniem każdym żądaniem przed i po jego wykonaniu na serwerze.

Metody

addPolicy(PipelinePolicy, AddPipelineOptions)

Dodaj nowe zasady do potoku.
clone()

Duplikuje ten potok, aby umożliwić modyfikowanie istniejącego potoku bez jegomutowania.
getOrderedPolicies()

Zwraca bieżący zestaw zasad w potoku w kolejności, w której zostaną zastosowane do żądania. W dalszej części listy znajduje się bliżej momentu wykonania żądania.
removePolicy({ name?: string, phase?: PipelinePhase })

Usuń zasady z potoku.
sendRequest(HttpClient, PipelineRequest)

Używa potoku do wykonania żądania HTTP.

Szczegóły metody

addPolicy(PipelinePolicy, AddPipelineOptions)

Dodaj nowe zasady do potoku.

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

Parametry

policy
PipelinePolicy

Zasady, które manipulują żądaniem.

options
AddPipelineOptions

Zestaw opcji, dla których zasady powinny być uruchamiane.

clone()

Duplikuje ten potok, aby umożliwić modyfikowanie istniejącego potoku bez jegomutowania.

function clone(): Pipeline

Zwraca

Pipeline

getOrderedPolicies()

Zwraca bieżący zestaw zasad w potoku w kolejności, w której zostaną zastosowane do żądania. W dalszej części listy znajduje się bliżej momentu wykonania żądania.

function getOrderedPolicies(): PipelinePolicy[]

Zwraca

PipelinePolicy[]

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

Usuń zasady z potoku.

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

Parametry

options

{ name?: string, phase?: PipelinePhase }

Opcje umożliwiające określenie zasad do usunięcia.

Zwraca

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Używa potoku do wykonania żądania HTTP.

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

Parametry

httpClient
HttpClient

Obiekt HttpClient, który faktycznie wykonuje żądanie.

request
PipelineRequest

Żądanie, które ma zostać złożone.

Zwraca

Promise<PipelineResponse>