Partilhar via

Pipeline interface

  • Referência
Pacote:
@azure/core-rest-pipeline

Representa um pipeline para fazer uma solicitação HTTP para uma URL. Os pipelines podem ter várias políticas para gerenciar a manipulação de cada solicitação antes e depois de ela ser feita ao servidor.

Métodos

addPolicy(PipelinePolicy, AddPolicyOptions)

Adicione uma nova política ao pipeline.
clone()

Duplica esse pipeline para permitir a modificação de um existente sem mutá-lo.
getOrderedPolicies()

Retorna o conjunto atual de políticas no pipeline na ordem em que serão aplicadas à solicitação. Mais adiante na lista está mais perto de quando a solicitação é executada.
removePolicy({ name?: string, phase?: PipelinePhase })

Remova uma política do pipeline.
sendRequest(HttpClient, PipelineRequest)

Usa o pipeline para fazer uma solicitação HTTP.

Detalhes de Método

addPolicy(PipelinePolicy, AddPolicyOptions)

Adicione uma nova política ao pipeline.

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

Parâmetros

policy
PipelinePolicy

Uma política que manipula uma solicitação.

options
AddPipelineOptions

Um conjunto de opções para quando a política deve ser executada.

clone()

Duplica esse pipeline para permitir a modificação de um existente sem mutá-lo.

function clone(): Pipeline

Devoluções

Pipeline

getOrderedPolicies()

Retorna o conjunto atual de políticas no pipeline na ordem em que serão aplicadas à solicitação. Mais adiante na lista está mais perto de quando a solicitação é executada.

function getOrderedPolicies(): PipelinePolicy[]

Devoluções

PipelinePolicy[]

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

Remova uma política do pipeline.

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

Parâmetros

options

{ name?: string, phase?: PipelinePhase }

Opções que permitem especificar quais políticas remover.

Devoluções

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Usa o pipeline para fazer uma solicitação HTTP.

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

Parâmetros

httpClient
HttpClient

O HttpClient que realmente executa a solicitação.

request
PipelineRequest

O pedido a ser feito.

Devoluções

Promise<PipelineResponse>