Partager via

@azure/core-rest-pipeline package

  • Référence

Classes

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

Interfaces

AddPipelineOptions

Options lors de l’ajout d’une stratégie au pipeline. Utilisé pour exprimer des dépendances vis-à-vis d’autres stratégies.
Agent

Interface compatible avec nodeJS http.Agent. Nous voulons éviter de réexporter publiquement l’interface réelle, car elle peut varier selon les versions du runtime.
AuthorizeRequestOnChallengeOptions

Options envoyées au rappel authorizeRequestOnChallenge
AuthorizeRequestOptions

Options envoyées au rappel authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions

Options de configuration de l’élément auxiliaryAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions

Options pour configurer bearerTokenAuthenticationPolicy
ChallengeCallbacks

Options permettant de remplacer le traitement des défis d’évaluation continue de l’accès .
DefaultRetryPolicyOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.
ExponentialRetryPolicyOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.
HttpClient

Interface requise pour un client qui effectue des requêtes HTTP pour le compte d’un pipeline.
HttpHeaders

Représente un ensemble d’en-têtes HTTP sur une demande/réponse. Les noms d’en-tête sont traités comme ne respectant pas la casse.
InternalPipelineOptions

Définit les options utilisées pour configurer les options internes du pipeline HTTP pour un client sdk.
KeyObject

Interface compatible avec nodeJS tls.KeyObject. Nous voulons éviter de réexporter publiquement l’interface réelle, car elle peut varier selon les versions du runtime.
LogPolicyOptions

Options de configuration de logPolicy.
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.
PipelineOptions

Définit les options utilisées pour configurer le pipeline HTTP pour un client sdk.
PipelinePolicy

Une stratégie de pipeline manipule une requête au fur et à mesure qu’elle transite par le pipeline. Il s’agit d’un intergiciel (middleware) qui est autorisé à modifier la demande avant qu’elle ne soit effectuée, ainsi que la réponse lors de sa réception.
PipelineRequest

Métadonnées relatives à une requête effectuée par le pipeline.
PipelineRequestOptions

Paramètres permettant d’initialiser une demande. Presque équivalent à Partial, mais url est obligatoire.
PipelineResponse

Métadonnées relatives à une réponse reçue par le pipeline.
PipelineRetryOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.
ProxySettings

Options permettant de configurer un proxy pour les requêtes sortantes (Node.js uniquement).
PxfObject

Interface compatible avec nodeJS tls.PxfObject. Nous voulons éviter de réexporter publiquement l’interface réelle, car elle peut varier selon les versions du runtime.
RedirectPolicyOptions

Options de gestion des réponses de redirection.
RestErrorOptions

Options prises en charge par RestError.
RetryInformation

Informations fournies à la stratégie de nouvelle tentative sur la progression actuelle de la stratégie de nouvelle tentative.
RetryModifiers

Propriétés qui peuvent modifier le comportement de la stratégie de nouvelle tentative.
RetryPolicyOptions

Options de la stratégie de nouvelle tentative
RetryStrategy

Une stratégie de nouvelle tentative est destinée à définir s’il faut réessayer ou non et comment effectuer une nouvelle tentative.
SystemErrorRetryPolicyOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.
TelemetryOptions

Définit les options utilisées pour configurer les données de télémétrie et les informations de suivi courantes
ThrottlingRetryPolicyOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.
TlsSettings

Représente un certificat pour l’authentification TLS.
TracingPolicyOptions

Options permettant de configurer la stratégie de suivi.
UserAgentPolicyOptions

Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.

Alias de type

FormDataMap

Objet simple qui fournit des données de formulaire, comme à partir d’un formulaire de navigateur.
FormDataValue

Chaque entrée de données de formulaire peut être une chaîne ou (dans le navigateur) un objet blob.
HttpMethods

Méthodes HTTP prises en charge à utiliser lors de l’envoi de requêtes.
PipelinePhase

Les stratégies sont exécutées par phases. L’ordre d’exécution est le suivant :

  1. Phase de sérialisation
  2. Stratégies hors phase
  3. Phase de désérialisation
  4. Phase de nouvelle tentative
  5. Phase de signature
RawHttpHeaders

Collection HttpHeaders représentée sous la forme d’un objet JSON simple.
RawHttpHeadersInput

Collection HttpHeaders pour l’entrée, représentée sous la forme d’un objet JSON simple.
RequestBodyType

Types de corps pris en charge sur la demande. NodeJS.ReadableStream et () => NodeJS.ReadableStream est Node uniquement. Blob, ReadableStream et () => ReadableStream sont des navigateurs uniquement.
SendRequest

Interface simple pour effectuer une demande de pipeline et recevoir une réponse.
TransferProgressEvent

Déclenché en réponse à la progression du chargement ou du téléchargement.

Fonctions

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Stratégie pour les jetons externes à l’en-tête x-ms-authorization-auxiliary . Cet en-tête sera utilisé lors de la création d’une application interlocataire, nous devrons peut-être gérer les demandes d’authentification pour les ressources qui se trouvent dans des locataires différents. Vous pouvez consulter la documentation ARM pour un aperçu du fonctionnement de cette fonctionnalité
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Stratégie qui peut demander un jeton à partir d’une implémentation TokenCredential, puis l’appliquer à l’en-tête d’autorisation d’une demande en tant que jeton du porteur.
createDefaultHttpClient()

Créez le httpClient approprié pour l’environnement actuel.
createEmptyPipeline()

Crée un pipeline totalement vide. Utile pour tester ou créer un personnalisé.
createHttpHeaders(RawHttpHeadersInput)

Crée un objet qui satisfait l’interface HttpHeaders .
createPipelineFromOptions(InternalPipelineOptions)

Créez un pipeline avec un ensemble par défaut de stratégies personnalisables.
createPipelineRequest(PipelineRequestOptions)

Crée une demande de pipeline avec les options spécifiées. Cette méthode permet de définir facilement les valeurs par défaut et n’est pas obligatoire.
decompressResponsePolicy()

Stratégie permettant d’activer la décompression de réponse en fonction de Accept-Encoding'en-tête https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)

Stratégie qui retente selon trois stratégies :

  • Lorsque le serveur envoie une réponse 429 avec un en-tête Retry-After.
  • En cas d’erreurs dans la couche de transport sous-jacente (par exemple, échecs de recherche DNS).
  • Sinon, si la requête sortante échoue, elle réessaye avec un délai qui augmente de façon exponentielle.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Stratégie qui tente de réessayer des demandes tout en introduisant un délai qui augmente de façon exponentielle.
formDataPolicy()

Stratégie qui encode FormData sur la demande dans le corps.
getDefaultProxySettings(string)

Cette méthode convertit une URL de proxy en ProxySettings pour une utilisation avec ProxyPolicy. Si aucun argument n’est fourni, il tente d’analyser une URL de proxy à partir des variables HTTPS_PROXY d’environnement ou HTTP_PROXY.
isRestError(unknown)

Typeguard pour RestError
logPolicy(LogPolicyOptions)

Stratégie qui journalise toutes les demandes et réponses.
ndJsonPolicy()

ndJsonPolicy est une stratégie utilisée pour contrôler les paramètres de maintien de l’activité pour chaque requête.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

Stratégie qui permet d’appliquer des paramètres de proxy à toutes les demandes. Si les paramètres statiques ne sont pas transmis, ils sont récupérés à partir des variables d’environnement HTTPS_PROXY ou HTTP_PROXY.
redirectPolicy(RedirectPolicyOptions)

Stratégie permettant de suivre les en-têtes d’emplacement du serveur afin de prendre en charge la redirection côté serveur. Dans le navigateur, cette stratégie n’est pas utilisée.
retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy est une stratégie générique permettant d’activer les demandes de nouvelle tentative lorsque certaines conditions sont remplies
setClientRequestIdPolicy(string)

Chaque PipelineRequest obtient un ID unique lors de sa création. Cette stratégie transmet cet ID unique via un en-tête HTTP pour améliorer la télémétrie et le suivi.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Stratégie de nouvelle tentative qui cherche spécifiquement à gérer les erreurs dans la couche de transport sous-jacente (par exemple, les échecs de recherche DNS) plutôt que les codes d’erreur pouvant être retendus du serveur lui-même.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Stratégie qui retente lorsque le serveur envoie une réponse 429 avec un en-tête Retry-After.

Pour plus d’informations, reportez-vous à https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits et https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)

Obtient une stratégie de pipeline qui ajoute le certificat client à l’agent HttpClient pour l’authentification.
tracingPolicy(TracingPolicyOptions)

Stratégie simple permettant de créer des étendues OpenTelemetry pour chaque requête effectuée par le pipeline qui a SpanOptions avec un parent. Les demandes effectuées sans étendue parente ne seront pas enregistrées.
userAgentPolicy(UserAgentPolicyOptions)

Stratégie qui définit l’en-tête User-Agent (ou équivalent) pour refléter la version de la bibliothèque.

Informations relatives à la fonction

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Stratégie pour les jetons externes à l’en-tête x-ms-authorization-auxiliary . Cet en-tête sera utilisé lors de la création d’une application interlocataire, nous devrons peut-être gérer les demandes d’authentification pour les ressources qui se trouvent dans des locataires différents. Vous pouvez consulter la documentation ARM pour un aperçu du fonctionnement de cette fonctionnalité

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Paramètres

options
AuxiliaryAuthenticationHeaderPolicyOptions

Retours

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Stratégie qui peut demander un jeton à partir d’une implémentation TokenCredential, puis l’appliquer à l’en-tête d’autorisation d’une demande en tant que jeton du porteur.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Paramètres

options
BearerTokenAuthenticationPolicyOptions

Retours

PipelinePolicy

createDefaultHttpClient()

Créez le httpClient approprié pour l’environnement actuel.

function createDefaultHttpClient(): HttpClient

Retours

HttpClient

createEmptyPipeline()

Crée un pipeline totalement vide. Utile pour tester ou créer un personnalisé.

function createEmptyPipeline(): Pipeline

Retours

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Crée un objet qui satisfait l’interface HttpHeaders .

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Paramètres

rawHeaders
RawHttpHeadersInput

Objet simple représentant les en-têtes initiaux

Retours

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Créez un pipeline avec un ensemble par défaut de stratégies personnalisables.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Paramètres

options
InternalPipelineOptions

Options de configuration d’un pipeline personnalisé.

Retours

Pipeline

createPipelineRequest(PipelineRequestOptions)

Crée une demande de pipeline avec les options spécifiées. Cette méthode permet de définir facilement les valeurs par défaut et n’est pas obligatoire.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Paramètres

options
PipelineRequestOptions

Options avec lesquelles créer la demande.

Retours

PipelineRequest

decompressResponsePolicy()

Stratégie permettant d’activer la décompression de réponse en fonction de Accept-Encoding'en-tête https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Retours

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Stratégie qui retente selon trois stratégies :

  • Lorsque le serveur envoie une réponse 429 avec un en-tête Retry-After.
  • En cas d’erreurs dans la couche de transport sous-jacente (par exemple, échecs de recherche DNS).
  • Sinon, si la requête sortante échoue, elle réessaye avec un délai qui augmente de façon exponentielle.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Paramètres

options
DefaultRetryPolicyOptions

Retours

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Stratégie qui tente de réessayer des demandes tout en introduisant un délai qui augmente de façon exponentielle.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Paramètres

options
ExponentialRetryPolicyOptions

Options qui configurent la logique de nouvelle tentative.

Retours

PipelinePolicy

formDataPolicy()

Stratégie qui encode FormData sur la demande dans le corps.

function formDataPolicy(): PipelinePolicy

Retours

PipelinePolicy

getDefaultProxySettings(string)

Cette méthode convertit une URL de proxy en ProxySettings pour une utilisation avec ProxyPolicy. Si aucun argument n’est fourni, il tente d’analyser une URL de proxy à partir des variables HTTPS_PROXY d’environnement ou HTTP_PROXY.

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

Paramètres

proxyUrl

string

URL du proxy à utiliser. Peut contenir des informations d’authentification.

Retours

ProxySettings | undefined

isRestError(unknown)

Typeguard pour RestError

function isRestError(e: unknown): e

Paramètres

e

unknown

Quelque chose intercepté par une clause catch.

Retours

e

logPolicy(LogPolicyOptions)

Stratégie qui journalise toutes les demandes et réponses.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Paramètres

options
LogPolicyOptions

Options de configuration de logPolicy.

Retours

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy est une stratégie utilisée pour contrôler les paramètres de maintien de l’activité pour chaque requête.

function ndJsonPolicy(): PipelinePolicy

Retours

PipelinePolicy

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

Stratégie qui permet d’appliquer des paramètres de proxy à toutes les demandes. Si les paramètres statiques ne sont pas transmis, ils sont récupérés à partir des variables d’environnement HTTPS_PROXY ou HTTP_PROXY.

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy

Paramètres

proxySettings
ProxySettings

ProxySettings à utiliser sur chaque requête.

options

{ customNoProxyList?: string[] }

paramètres supplémentaires, par exemple, modèles de NO_PROXY personnalisés

Retours

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Stratégie permettant de suivre les en-têtes d’emplacement du serveur afin de prendre en charge la redirection côté serveur. Dans le navigateur, cette stratégie n’est pas utilisée.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Paramètres

options
RedirectPolicyOptions

Options pour contrôler le comportement de la stratégie.

Retours

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy est une stratégie générique permettant d’activer les demandes de nouvelle tentative lorsque certaines conditions sont remplies

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

Paramètres

strategies

RetryStrategy[]

options
RetryPolicyOptions

Retours

PipelinePolicy

setClientRequestIdPolicy(string)

Chaque PipelineRequest obtient un ID unique lors de sa création. Cette stratégie transmet cet ID unique via un en-tête HTTP pour améliorer la télémétrie et le suivi.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Paramètres

requestIdHeaderName

string

Nom de l’en-tête vers lequel passer l’ID de demande.

Retours

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Stratégie de nouvelle tentative qui cherche spécifiquement à gérer les erreurs dans la couche de transport sous-jacente (par exemple, les échecs de recherche DNS) plutôt que les codes d’erreur pouvant être retendus du serveur lui-même.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Paramètres

options
SystemErrorRetryPolicyOptions

Options qui personnalisent la stratégie.

Retours

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Stratégie qui retente lorsque le serveur envoie une réponse 429 avec un en-tête Retry-After.

Pour plus d’informations, reportez-vous à https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits et https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Paramètres

options
ThrottlingRetryPolicyOptions

Options qui configurent la logique de nouvelle tentative.

Retours

PipelinePolicy

tlsPolicy(TlsSettings)

Obtient une stratégie de pipeline qui ajoute le certificat client à l’agent HttpClient pour l’authentification.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Paramètres

tlsSettings
TlsSettings

Retours

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Stratégie simple permettant de créer des étendues OpenTelemetry pour chaque requête effectuée par le pipeline qui a SpanOptions avec un parent. Les demandes effectuées sans étendue parente ne seront pas enregistrées.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Paramètres

options
TracingPolicyOptions

Options permettant de configurer les données de télémétrie journalisées par la stratégie de suivi.

Retours

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Stratégie qui définit l’en-tête User-Agent (ou équivalent) pour refléter la version de la bibliothèque.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Paramètres

options
UserAgentPolicyOptions

Options permettant de personnaliser la valeur de l’agent utilisateur.

Retours

PipelinePolicy