@azure/core-https package
Classes
| DefaultHttpsClient |
Une implémentation HttpsClient qui utilise le module « https » de Node pour envoyer des requêtes HTTPS. |
| 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 sur d’autres stratégies. |
| BearerTokenAuthenticationPolicyOptions |
Options pour configurer bearerTokenAuthenticationPolicy |
| ExponentialRetryPolicyOptions |
Options qui contrôlent la façon de réessayer les demandes ayant échoué. |
| HttpHeaders |
Représente un ensemble d’en-têtes HTTP sur une requête/réponse. Les noms d’en-tête sont traités comme respectant la casse. |
| HttpsClient |
Interface requise pour un client qui effectue des requêtes HTTPS pour le compte d’un pipeline. |
| InternalPipelineOptions |
Définit les options utilisées pour configurer les options internes du pipeline HTTP pour un client sdk. |
| LogPolicyOptions |
Options de configuration de logPolicy. |
| Pipeline |
Représente un pipeline permettant d’effectuer une requête HTTPS vers une URL. Les pipelines peuvent avoir plusieurs stratégies pour gérer la manipulation de chaque requête avant et après sa création sur le 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 qui est autorisé à modifier la requête avant qu’elle ne soit effectuée, ainsi que la réponse lorsqu’elle est reçue. |
| PipelineRequest |
Métadonnées relatives à une requête effectuée par le pipeline. |
| PipelineRequestOptions |
Paramètres d’initialisation d’une requête. Presque équivalent à Partial<PipelineRequest>, mais l’url est obligatoire. |
| PipelineResponse |
Métadonnées relatives à une réponse reçue par le pipeline. |
| ProxySettings |
Options de configuration d’un proxy pour les requêtes sortantes (Node.js uniquement). |
| RedirectPolicyOptions |
Options de gestion des réponses de redirection. |
| RestErrorOptions |
Options prises en charge par RestError. |
| SystemErrorRetryPolicyOptions |
Options qui contrôlent la façon de réessayer les demandes ayant échoué. |
| TracingPolicyOptions |
Options de configuration de la stratégie de suivi. |
| UserAgentPolicyOptions |
Options d’ajout de détails de l’agent utilisateur aux demandes sortantes. |
Alias de type
| FormDataMap |
Objet simple qui fournit des données de formulaire, comme s’il s’agit d’un formulaire de navigateur. |
| FormDataValue |
Chaque entrée de données de formulaire peut être une chaîne de caractères ou (dans le navigateur) un Blob. |
| HttpMethods |
Méthodes HTTP prises en charge à utiliser lors de l’établissement de requêtes. |
| PipelinePhase |
Les stratégies sont exécutées en phases. L’ordre d’exécution est le suivant :
|
| RawHttpHeaders |
Collection HttpHeaders représentée en tant qu’objet JSON simple. |
| RequestBodyType |
Types de corps pris en charge sur la demande. NodeJS.ReadableStream est uniquement un nœud. Blob est disponible uniquement pour un navigateur. |
| 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. |
Functions
| bearer |
Stratégie qui peut demander un jeton à partir d’une implémentation TokenCredential, puis l’appliquer à l’en-tête d’autorisation d’une requête en tant que jeton du porteur. |
| create |
Crée un pipeline totalement vide. Utile pour tester ou créer un modèle personnalisé. |
| create |
Crée un objet qui satisfait à l’interface |
| create |
Créez un pipeline avec un ensemble par défaut de stratégies personnalisables. |
| create |
Crée une demande de pipeline avec les options données. Cette méthode permet de définir facilement les valeurs par défaut et non obligatoires. |
| decompress |
Stratégie permettant d’activer la décompression de la réponse en fonction de Accept-Encoding en-tête https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding |
| exponential |
Stratégie qui tente de réessayer les demandes tout en introduisant un délai croissant exponentiel. |
| form |
Stratégie qui encode FormData sur la requête dans le corps. |
| get |
Cette méthode convertit une URL de proxy en |
| log |
Stratégie qui enregistre toutes les demandes et réponses. |
| nd |
ndJsonPolicy est une stratégie utilisée pour contrôler les paramètres actifs pour chaque requête. |
| proxy |
Stratégie qui permet d’appliquer des paramètres proxy à toutes les demandes. Si les paramètres statiques ne sont pas passés, ils sont récupérés à partir des variables d’environnement HTTPS_PROXY ou HTTP_PROXY. |
| redirect |
Stratégie pour suivre les en-têtes d’emplacement du serveur afin de prendre en charge la redirection côté serveur. |
| set |
Chaque pipelineRequest obtient un ID unique lors de la création. Cette stratégie transmet cet ID unique via un en-tête HTTP pour permettre une meilleure télémétrie et le suivi. |
| system |
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 retentables du serveur lui-même. |
| throttling |
Stratégie qui retente lorsque le serveur envoie une réponse 429 avec un en-tête Retry-After. Pour en savoir plus, consultez 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 |
| tracing |
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. |
| user |
Stratégie qui définit l’en-tête User-Agent (ou équivalent) pour refléter la version de la bibliothèque. |
Variables
| bearer |
L’identifiant programmatique de la porte-tokenAuthenticationPolicy. |
| decompress |
L’identifiant programmatique de la politique decompressResponsePolicy. |
| expontential |
L’identifiant programmatique de la RetryPolicy exponentielle. |
| form |
L’identifiant programmatique de la formulDataPolicy. |
| log |
L’identifiant programmatique de la logPolicy. |
| nd |
L’identifiant programmatique de la ndJsonPolicy. |
| proxy |
L’identifiant programmatique du proxy Policy. |
| redirect |
L’identifiant programmatique de la redirectPolicy. |
| set |
L’identifiant programmatique de la politique setClientRequestIdPolicy. |
| system |
L’identifiant programmatique de la policyErrorRetryPolicy. |
| throttling |
L’identifiant programmatique de throttlingRetryPolicy. |
| tracing |
L’identifiant programmatique de la traçingPolicy. |
| user |
L’identifiant programmatique de l’userAgentPolicy. |
Informations relatives à la fonction
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 requête en tant que jeton du porteur.
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy
Paramètres
Retours
createEmptyPipeline()
Crée un pipeline totalement vide. Utile pour tester ou créer un modèle personnalisé.
function createEmptyPipeline(): Pipeline
Retours
createHttpHeaders(RawHttpHeaders)
Crée un objet qui satisfait à l’interface HttpHeaders.
function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders
Paramètres
- rawHeaders
- RawHttpHeaders
Objet simple représentant les en-têtes initiaux
Retours
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
createPipelineRequest(PipelineRequestOptions)
Crée une demande de pipeline avec les options données. Cette méthode permet de définir facilement les valeurs par défaut et non obligatoires.
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest
Paramètres
- options
- PipelineRequestOptions
Options pour créer la requête avec.
Retours
decompressResponsePolicy()
Stratégie permettant d’activer la décompression de la 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
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
Stratégie qui tente de réessayer les demandes tout en introduisant un délai croissant exponentiel.
function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy
Paramètres
- options
- ExponentialRetryPolicyOptions
Options qui configurent la logique de nouvelle tentative.
Retours
formDataPolicy()
Stratégie qui encode FormData sur la requête dans le corps.
function formDataPolicy(): PipelinePolicy
Retours
getDefaultProxySettings(string)
Cette méthode convertit une URL de proxy en ProxySettings à utiliser avec ProxyPolicy.
Si aucun argument n’est donné, il tente d’analyser une URL de proxy à partir des variables d’environnement HTTPS_PROXY 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
logPolicy(LogPolicyOptions)
Stratégie qui enregistre toutes les demandes et réponses.
function logPolicy(options?: LogPolicyOptions): PipelinePolicy
Paramètres
- options
- LogPolicyOptions
Options de configuration de logPolicy.
Retours
ndJsonPolicy()
ndJsonPolicy est une stratégie utilisée pour contrôler les paramètres actifs pour chaque requête.
function ndJsonPolicy(): PipelinePolicy
Retours
proxyPolicy(ProxySettings)
Stratégie qui permet d’appliquer des paramètres proxy à toutes les demandes. Si les paramètres statiques ne sont pas passés, ils sont récupérés à partir des variables d’environnement HTTPS_PROXY ou HTTP_PROXY.
function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy
Paramètres
- proxySettings
- ProxySettings
ProxySettings à utiliser sur chaque requête.
Retours
redirectPolicy(RedirectPolicyOptions)
Stratégie pour suivre les en-têtes d’emplacement du serveur afin de prendre en charge la redirection côté serveur.
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy
Paramètres
- options
- RedirectPolicyOptions
Options pour contrôler le comportement de la stratégie.
Retours
setClientRequestIdPolicy(string)
Chaque pipelineRequest obtient un ID unique lors de la création. Cette stratégie transmet cet ID unique via un en-tête HTTP pour permettre une meilleure télémétrie et le suivi.
function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy
Paramètres
- requestIdHeaderName
-
string
Nom de l’en-tête à transmettre l’ID de requête.
Retours
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 retentables du serveur lui-même.
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy
Paramètres
- options
- SystemErrorRetryPolicyOptions
Options qui personnalisent la stratégie.
Retours
throttlingRetryPolicy()
Stratégie qui retente lorsque le serveur envoie une réponse 429 avec un en-tête Retry-After.
Pour en savoir plus, consultez 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(): PipelinePolicy
Retours
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
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 pour personnaliser la valeur de l’agent utilisateur.
Retours
Variable Details
bearerTokenAuthenticationPolicyName
L’identifiant programmatique de la porte-tokenAuthenticationPolicy.
bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"
Type
"bearerTokenAuthenticationPolicy"
decompressResponsePolicyName
L’identifiant programmatique de la politique decompressResponsePolicy.
decompressResponsePolicyName: "decompressResponsePolicy"
Type
"decompressResponsePolicy"
expontentialRetryPolicyName
L’identifiant programmatique de la RetryPolicy exponentielle.
expontentialRetryPolicyName: "exponentialRetryPolicy"
Type
"exponentialRetryPolicy"
formDataPolicyName
L’identifiant programmatique de la formulDataPolicy.
formDataPolicyName: "formDataPolicy"
Type
"formDataPolicy"
logPolicyName
L’identifiant programmatique de la logPolicy.
logPolicyName: "logPolicy"
Type
"logPolicy"
ndJsonPolicyName
L’identifiant programmatique de la ndJsonPolicy.
ndJsonPolicyName: "ndJsonPolicy"
Type
"ndJsonPolicy"
proxyPolicyName
L’identifiant programmatique du proxy Policy.
proxyPolicyName: "proxyPolicy"
Type
"proxyPolicy"
redirectPolicyName
L’identifiant programmatique de la redirectPolicy.
redirectPolicyName: "redirectPolicy"
Type
"redirectPolicy"
setClientRequestIdPolicyName
L’identifiant programmatique de la politique setClientRequestIdPolicy.
setClientRequestIdPolicyName: "setClientRequestIdPolicy"
Type
"setClientRequestIdPolicy"
systemErrorRetryPolicyName
L’identifiant programmatique de la policyErrorRetryPolicy.
systemErrorRetryPolicyName: "systemErrorRetryPolicy"
Type
"systemErrorRetryPolicy"
throttlingRetryPolicyName
L’identifiant programmatique de throttlingRetryPolicy.
throttlingRetryPolicyName: "throttlingRetryPolicy"
Type
"throttlingRetryPolicy"
tracingPolicyName
L’identifiant programmatique de la traçingPolicy.
tracingPolicyName: "tracingPolicy"
Type
"tracingPolicy"
userAgentPolicyName
L’identifiant programmatique de l’userAgentPolicy.
userAgentPolicyName: "userAgentPolicy"
Type
"userAgentPolicy"