Partilhar via

Pipeline interface

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

Representa um pipeline para fazer um pedido HTTP para um URL. Os pipelines podem ter várias políticas para gerir a manipulação de cada pedido antes e depois de ser efetuada no servidor.

Métodos

addPolicy(PipelinePolicy, AddPipelineOptions)

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

Duplica este pipeline para permitir a modificação de um existente sem o mutar.
getOrderedPolicies()

Devolve o conjunto atual de políticas no pipeline pela ordem em que serão aplicadas ao pedido. Mais à frente na lista está mais perto de quando o pedido é realizado.
removePolicy({ name?: string, phase?: PipelinePhase })

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

Utiliza o pipeline para fazer um pedido HTTP.

Detalhes de Método

addPolicy(PipelinePolicy, AddPipelineOptions)

Adicione uma nova política ao pipeline.

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

Parâmetros

policy
PipelinePolicy

Uma política que manipula um pedido.

options
AddPipelineOptions

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

clone()

Duplica este pipeline para permitir a modificação de um existente sem o mutar.

function clone(): Pipeline

Devoluções

Pipeline

getOrderedPolicies()

Devolve o conjunto atual de políticas no pipeline pela ordem em que serão aplicadas ao pedido. Mais à frente na lista está mais perto de quando o pedido é realizado.

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 lhe permitem especificar as políticas a remover.

Devoluções

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Utiliza o pipeline para fazer um pedido HTTP.

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

Parâmetros

httpClient
HttpClient

O HttpClient que efetivamente executa o pedido.

request
PipelineRequest

O pedido a ser feito.

Devoluções

Promise<PipelineResponse>