Pipeline interface

Paquete:

@azure/core-rest-pipeline

Representa una canalización para realizar una solicitud HTTP en una dirección URL. Las canalizaciones pueden tener varias directivas para administrar la manipulación de cada solicitud antes y después de que se realice en el servidor.

Métodos

addPolicy(PipelinePolicy, AddPipelineOptions)	Agregue una nueva directiva a la canalización.
clone()	Duplica esta canalización para permitir la modificación de una existente sin mutarla.
getOrderedPolicies()	Devuelve el conjunto actual de directivas de la canalización en el orden en que se aplicarán a la solicitud. Más adelante en la lista está más cerca de cuando se realiza la solicitud.
removePolicy({ name?: string, phase?: PipelinePhase })	Quite una directiva de la canalización.
sendRequest(HttpClient, PipelineRequest)	Usa la canalización para realizar una solicitud HTTP.

Detalles del método

addPolicy(PipelinePolicy, AddPipelineOptions)

Agregue una nueva directiva a la canalización.

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

Parámetros

policy

PipelinePolicy

Directiva que manipula una solicitud.

options

AddPipelineOptions

Conjunto de opciones para cuando se debe ejecutar la directiva.

clone()

Duplica esta canalización para permitir la modificación de una existente sin mutarla.

function clone(): Pipeline

Devoluciones

Pipeline

getOrderedPolicies()

Devuelve el conjunto actual de directivas de la canalización en el orden en que se aplicarán a la solicitud. Más adelante en la lista está más cerca de cuando se realiza la solicitud.

function getOrderedPolicies(): PipelinePolicy[]

Devoluciones

PipelinePolicy[]

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

Quite una directiva de la canalización.

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

Parámetros

options

{ name?: string, phase?: PipelinePhase }

Opciones que le permiten especificar qué directivas se van a quitar.

Devoluciones

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Usa la canalización para realizar una solicitud HTTP.

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

Parámetros

httpClient

HttpClient

HttpClient que realiza realmente la solicitud.

request

PipelineRequest

Solicitud que se va a realizar.

Devoluciones

Promise<PipelineResponse>