Partager via

Pipeline interface

  • Référence
Paquet:
@azure/core-rest-pipeline

Représente un pipeline pour effectuer une requête HTTP vers une URL. Les pipelines peuvent avoir plusieurs stratégies pour gérer la manipulation de chaque requête avant et après qu’elle soit envoyée au serveur.

Méthodes

addPolicy(PipelinePolicy, AddPipelineOptions)

Ajoutez une nouvelle stratégie au pipeline.
clone()

Dupliquez ce pipeline pour permettre de modifier un pipeline existant sans le muter.
getOrderedPolicies()

Retourne l’ensemble actuel de stratégies dans le pipeline dans l’ordre dans lequel elles seront appliquées à la requête. Plus loin dans la liste est plus proche du moment où la demande est effectuée.
removePolicy({ name?: string, phase?: PipelinePhase })

Supprimez une stratégie du pipeline.
sendRequest(HttpClient, PipelineRequest)

Utilise le pipeline pour effectuer une requête HTTP.

Détails de la méthode

addPolicy(PipelinePolicy, AddPipelineOptions)

Ajoutez une nouvelle stratégie au pipeline.

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

Paramètres

policy
PipelinePolicy

Stratégie qui manipule une requête.

options
AddPipelineOptions

Ensemble d’options pour le moment où la stratégie doit s’exécuter.

clone()

Dupliquez ce pipeline pour permettre de modifier un pipeline existant sans le muter.

function clone(): Pipeline

Retours

Pipeline

getOrderedPolicies()

Retourne l’ensemble actuel de stratégies dans le pipeline dans l’ordre dans lequel elles seront appliquées à la requête. Plus loin dans la liste est plus proche du moment où la demande est effectuée.

function getOrderedPolicies(): PipelinePolicy[]

Retours

PipelinePolicy[]

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

Supprimez une stratégie du pipeline.

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

Paramètres

options

{ name?: string, phase?: PipelinePhase }

Options qui vous permettent de spécifier les stratégies à supprimer.

Retours

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Utilise le pipeline pour effectuer une requête HTTP.

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

Paramètres

httpClient
HttpClient

HttpClient qui effectue réellement la requête.

request
PipelineRequest

Demande à effectuer.

Retours

Promise<PipelineResponse>