Condividi tramite

Pipeline interface

  • Riferimento
Pacchetto:
@azure/core-rest-pipeline

Rappresenta una pipeline per l'esecuzione di una richiesta HTTP a un URL. Le pipeline possono avere più criteri per gestire la modifica di ogni richiesta prima e dopo che è stata effettuata al server.

Metodi

addPolicy(PipelinePolicy, AddPipelineOptions)

Aggiungere un nuovo criterio alla pipeline.
clone()

Duplica questa pipeline per consentire la modifica di una esistente senza modificarla.
getOrderedPolicies()

Restituisce il set corrente di criteri nella pipeline nell'ordine in cui verranno applicati alla richiesta. Più avanti nell'elenco è più vicino a quando viene eseguita la richiesta.
removePolicy({ name?: string, phase?: PipelinePhase })

Rimuovere un criterio dalla pipeline.
sendRequest(HttpClient, PipelineRequest)

Usa la pipeline per effettuare una richiesta HTTP.

Dettagli metodo

addPolicy(PipelinePolicy, AddPipelineOptions)

Aggiungere un nuovo criterio alla pipeline.

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

Parametri

policy
PipelinePolicy

Criteri che modificano una richiesta.

options
AddPipelineOptions

Set di opzioni per l'esecuzione dei criteri.

clone()

Duplica questa pipeline per consentire la modifica di una esistente senza modificarla.

function clone(): Pipeline

Restituisce

Pipeline

getOrderedPolicies()

Restituisce il set corrente di criteri nella pipeline nell'ordine in cui verranno applicati alla richiesta. Più avanti nell'elenco è più vicino a quando viene eseguita la richiesta.

function getOrderedPolicies(): PipelinePolicy[]

Restituisce

PipelinePolicy[]

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

Rimuovere un criterio dalla pipeline.

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

Parametri

options

{ name?: string, phase?: PipelinePhase }

Opzioni che consentono di specificare i criteri da rimuovere.

Restituisce

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Usa la pipeline per effettuare una richiesta HTTP.

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

Parametri

httpClient
HttpClient

HttpClient che esegue effettivamente la richiesta.

request
PipelineRequest

Richiesta da effettuare.

Restituisce

Promise<PipelineResponse>