@azure/core-http package

Classes

AccessTokenRefresher	Aide les stratégies d’authentification de jeton core-http à demander un nouveau jeton si nous n’attendons pas actuellement un nouveau jeton.
ApiKeyCredentials	S’authentifie auprès d’un service à l’aide d’une clé API.
BaseRequestPolicy	Classe de base dont dérivent toutes les stratégies de requête.
BasicAuthenticationCredentials	Simple <xref:ServiceClientCredential> qui s’authentifie avec un nom d’utilisateur et un mot de passe.
DefaultHttpClient	Client HTTP qui utilise node-fetch.
ExpiringAccessTokenCache	Fournit une implémentation AccessTokenCache qui efface les accessToken mis en cache une fois l’objet expiresOnTimestamp passé.
HttpHeaders	Collection de paires clé/valeur d’en-tête HTTP.
RequestPolicyOptions	Propriétés facultatives qui peuvent être utilisées lors de la création d’une stratégie RequestPolicy.
RestError	Erreur résultant d’une requête HTTP à un point de terminaison de service.
Serializer	Utilisé pour mapper des objets de réponse brute aux formes finales. Permet d’empaquetage et de déballage des dates et d’autres types encodés qui ne sont pas intrinsèques à JSON. Autorise également l’extraction de valeurs à partir d’en-têtes, ainsi que l’insertion de valeurs et de constantes par défaut.
ServiceClient	ServiceClient envoie des demandes de service et reçoit des réponses.
TopicCredentials	Objet TopicCredentials utilisé pour Azure Event Grid.
URLBuilder	Classe qui gère la création, la modification et l’analyse des URL.
URLQuery	Classe qui gère la partie requête d’un URLBuilder.
WebResource	Crée un objet WebResource. Cette classe fournit une abstraction sur un appel REST en étant indépendante de la bibliothèque/de l’implémentation et en encapsulant les propriétés nécessaires pour lancer une requête.

Interfaces

AbortSignalLike	Autorise l’abandon de la demande lors du déclenchement de l’événement « abandon ». Compatible avec le navigateur intégré AbortSignal et les polyfills courants.
AccessToken	Représente un jeton d’accès avec un délai d’expiration.
AccessTokenCache	Fournit un cache pour un AccessToken qui a été retourné à partir d’un TokenCredential.
ApiKeyCredentialOptions	Décrit les options à fournir lors de la création d’une instance d’ApiKeyCredentials
BaseMapper	Définition de base d’un mappeur. Peut être utilisé pour les objets XML et JavaScript bruts.
CompositeMapper	Mappeur composé d’autres mappeurs.
CompositeMapperType	Permet de créer un mappeur qui décrit comment mapper un ensemble de propriétés d’un objet basé sur d’autres mappeurs. Une seule des propriétés suivantes doit être présente : className, modelProperties et additionalProperties.
DeserializationContentTypes	Types de contenu qui indiquent qu’une réponse d’opération doit être désérialisée d’une manière particulière.
DeserializationOptions	Options pour configurer la désérialisation de la réponse de l’API.
DictionaryMapper	Mappeur décrivant des objets JavaScript simples utilisés comme paires clé/valeur.
DictionaryMapperType	Permet de créer un mappeur qui décrit comment analyser un dictionnaire de valeurs mappées.
EnumMapper	Mappeur décrivant une valeur d’énumération.
EnumMapperType	Permet de créer un mappeur qui décrit comment analyser une valeur d’énumération.
GetTokenOptions	Définit les options pour TokenCredential.getToken.
HttpClient	Interface qui peut envoyer des requêtes HttpRequest et recevoir des httpResponses promises.
HttpHeader	En-tête individuel dans une collection HttpHeaders.
HttpHeadersLike	Collection de paires clé/valeur d’en-tête HTTP.
HttpOperationResponse	Objet Wrapper pour la requête et la réponse HTTP. L’objet désérialisé est stocké dans la parsedBody propriété lorsque le corps de la réponse est reçu en JSON ou XML.
HttpPipelineLogger	Enregistreur d’événements qui peut être ajouté à un objet HttpPipeline. Cela permet à chaque RequestPolicy de journaliser les messages qui peuvent être utilisés à des fins de débogage.
HttpResponse	Propriétés d’une réponse HTTP qui seront toujours présentes.
InternalPipelineOptions	Définit les options utilisées pour configurer les options internes du pipeline HTTP pour un client sdk.
KeepAliveOptions	Options relatives à la façon dont les connexions HTTP doivent être gérées pour les requêtes futures.
LogPolicyOptions	Options à passer à logPolicy. Par défaut, seule une liste définie d’en-têtes est journalisée, bien que celle-ci puisse être configurée. Les corps de requête et de réponse ne sont jamais enregistrés.
MapperConstraints	Description de diverses contraintes de valeur, telles que les plages d’entiers et l’expression régulière de chaîne.
OperationArguments	Collection de propriétés qui s’appliquent à un appel unique d’une opération.
OperationOptions	Type d’options de base pour toutes les opérations.
OperationParameter	Interface commune que tous les paramètres Operation étendent.
OperationQueryParameter	Paramètre d’une opération qui sera ajoutée en tant que paramètre de requête à la requête HTTP de l’opération.
OperationRequestOptions	Options qui permettent de configurer la gestion des requêtes HTTP effectuées par une opération sdk.
OperationResponse	OperationResponse qui peut être retourné à partir d’une demande d’opération pour un code d’état unique.
OperationSpec	Spécification qui définit comment effectuer une opération de service particulière sur HTTP, notamment comment sérialiser correctement les informations de requête dans et désérialiser les informations de réponse dans une charge utile d’objet pouvant être retournée par le ServiceClient.
OperationURLParameter	Paramètre d’une opération qui sera remplacée dans l’URL de requête de l’opération.
ParameterValue	Valeur de paramètre fournie pour les paramètres de chemin d’accès ou de requête dans RequestPrepareOptions
PipelineOptions	Définit les options utilisées pour configurer le pipeline HTTP pour un client sdk.
PolymorphicDiscriminator	Utilisé pour lever l’ambiguïté des unions de type discriminées. Par exemple, si la réponse peut avoir de nombreuses formes, mais qu’elle inclut également un champ « kind » (ou similaire), ce champ peut être utilisé pour déterminer comment désérialiser la réponse au type correct.
ProxySettings	Options permettant de configurer un proxy pour les requêtes sortantes (Node.js uniquement).
RedirectOptions	Options de gestion des réponses de redirection.
RequestOptionsBase	Décrit la structure de base de l’objet options qui sera utilisé dans chaque opération.
RequestPolicy	Structure sous-jacente d’une stratégie de requête.
RequestPolicyOptionsLike	Propriétés facultatives qui peuvent être utilisées lors de la création d’une stratégie RequestPolicy.
RequestPrepareOptions	Options pour préparer une requête HTTP sortante.
RestResponse	Réponse aplatit à un appel REST. Contient le HttpOperationResponse sous-jacent, ainsi que les propriétés fusionnées de parsedBody, parsedHeaders, etc.
RetryOptions	Options qui contrôlent la façon de réessayer les demandes ayant échoué.
SequenceMapper	Mappeur décrivant des tableaux.
SequenceMapperType	Permet de créer un mappeur qui décrit comment analyser une séquence de valeurs mappées.
SerializerOptions	Options pour régir le comportement de l’analyseur et du générateur xml.
ServiceCallback
ServiceClientCredentials	Représente un objet ou une classe avec une signRequest méthode qui signera les demandes sortantes (par exemple, en définissant l’en-tête Authorization ).
ServiceClientOptions	Options à fournir lors de la création du client.
SimpleMapperType	Type d’un mappeur simple.
TokenCredential	Représente des informations d’identification capables de fournir un jeton d’authentification.
TracingPolicyOptions	Options permettant de personnaliser la stratégie de suivi.
UrlParameterValue	Interface représentant une valeur de paramètre d’URL.
UserAgentOptions	Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.
WebResourceLike	Description d’une requête HTTP à envoyer à un serveur distant.

Alias de type

Authenticator	Fonction qui reçoit un défi et résout une promesse avec un jeton de chaîne.
CommonRequestInfo	URL de chaîne utilisées lors de l’appel à fetch().
CommonRequestInit	Objet contenant des informations sur la requête HTTP sortante.
CommonResponse	Objet contenant des informations sur la réponse HTTP entrante.
HttpMethods	Liste des méthodes HTTP prises en charge.
HttpRequestBody	Types de corps de requête HTTP possibles
Mapper	Les mappeurs sont des définitions des modèles de données utilisés dans la bibliothèque. Ces modèles de données font partie des définitions Opération ou Client dans les réponses ou les paramètres.
MapperType	Type du mappeur. Inclut des mappeurs connus.
ParameterPath	Chemin d’accès qui décrit comment accéder à une propriété particulière dans une source de données d’objet donnée. Il peut s’agir d’un nom de propriété unique, d’un tableau qui indique des noms de propriétés imbriquées ou d’un ensemble de plusieurs propriétés nommées avec des chemins d’accès dans le cas de valeurs d’objet complexes.
ProxyOptions	Alias de ProxySettings pour une utilisation ultérieure.
RawHttpHeaders	Collection HttpHeaders représentée sous la forme d’un objet JSON simple.
RequestPolicyFactory	Crée une nouvelle RequestPolicy par demande qui utilise la nextPolicy fournie.
TelemetryInfo	Informations de télémétrie. Paires clé/valeur à inclure dans la chaîne User-Agent.
TransferProgressEvent	Déclenché en réponse à la progression du chargement ou du téléchargement.

Énumérations

HttpPipelineLogLevel	Les différents niveaux de journaux qui peuvent être utilisés avec HttpPipelineLogger.
QueryCollectionFormat	Format qui sera utilisé pour joindre un tableau de valeurs pour une valeur de paramètre de requête.
RetryMode	Décrit le type de mode nouvelle tentative. Prise en charge actuellement uniquement d’Exponential.

Fonctions

applyMixins(unknown, any[])	Applique les propriétés du prototype de sourceCtors au prototype de targetCtor
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])	Crée une fabrique pour un RequestPolicy qui applique un jeton de porteur aux en-têtes des Authorization demandes.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Crée un pipeline HTTP en fonction des options spécifiées.
delay(number, DelayOptions)	Wrapper pour setTimeout qui résout une promesse après timeInMs millisecondes.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Créez un nouveau RequestPolicyCreator de sérialisation qui sérialisera les corps de requête HTTP au fur et à mesure qu’ils passent par le pipeline HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Étant donné un ensemble particulier de types de contenu à analyser au format JSON ou XML, consomme la réponse HTTP pour produire l’objet de résultat défini par l’OperationSpec de la requête.
disableResponseDecompressionPolicy()	Retourne une fabrique de stratégie de requête qui peut être utilisée pour créer une instance de <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	Encode un URI.
executePromisesSequentially(any[], unknown)	Exécute un tableau de promesses séquentiellement. Vous trouverez ici l’inspiration de cette méthode : https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Un blog génial sur les promesses!
exponentialRetryPolicy(number, number, number)	Stratégie qui retente la requête autant de fois que configuré pour aussi longtemps que l’intervalle de temps maximal de nouvelle tentative spécifié, chaque nouvelle tentative attend plus longtemps que la dernière fois.
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	Analyse un objet HttpOperationResponse dans un objet de réponse HTTP normalisé (RestResponse).
generateClientRequestIdPolicy(string)	Crée une stratégie qui affecte un ID de demande unique aux demandes sortantes.
generateUuid()	UUID généré
getDefaultProxySettings(string)	Convertit une URL donnée d’un serveur proxy en ProxySettings ou tente de récupérer ProxySettings à partir de l’environnement actuel si elle n’est pas passée.
getDefaultUserAgentValue()	Approche par défaut pour générer des agents utilisateur. Utilise les informations statiques de ce package, ainsi que les informations système disponibles à partir du runtime.
isDuration(string)	Indique si la chaîne donnée est au format ISO 8601.
isTokenCredential(unknown)	Teste un objet pour déterminer s’il implémente TokenCredential.
isValidUuid(string)	Valide l’uuid donné en tant que chaîne
keepAlivePolicy(KeepAliveOptions)	Crée une stratégie qui contrôle si les connexions HTTP sont conservées sur les demandes futures.
logPolicy(LogPolicyOptions)	Crée une stratégie qui journalise les informations sur la requête sortante et les réponses entrantes.
operationOptionsToRequestOptionsBase<T>(T)	Convertit un OperationOptions en requestOptionsBase
parseXML(string, SerializerOptions)	Convertit une chaîne XML donnée en JSON
promiseToCallback(Promise<any>)	Convertit une promesse en rappel.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Convertit une promesse en rappel de service.
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(number)	Crée une stratégie de redirection, qui envoie une demande répétée à une nouvelle destination si une réponse arrive avec un en-tête « emplacement » et un code d’état compris entre 300 et 307.
serializeObject(unknown)	Fonction utilitaire qui sérialise un objet qui peut contenir des informations binaires dans un objet simple, un tableau ou une chaîne.
signingPolicy(ServiceClientCredentials)	Crée une stratégie qui signe les demandes sortantes en appelant à la authenticationProviderméthode fournie signRequest .
stringifyXML(unknown, SerializerOptions)	Convertit l’objet JSON donné en chaîne XML
stripRequest(WebResourceLike)	Retourne une version dépouillée de la requête HTTP qui ne contient pas l’en-tête d’autorisation.
stripResponse(HttpOperationResponse)	Retourne une version dépouillée de la réponse HTTP qui contient uniquement le corps, les en-têtes et l’état.
systemErrorRetryPolicy(number, number, number, number)	Stratégie qui retente en cas d’erreur système, identifiée par les codes « ETIMEDOUT », « ESOCKETTIMEDOUT », « ECONNREFUSED », « ECONNRESET » ou « ENOENT ».
throttlingRetryPolicy()	Crée une stratégie qui renvoie la demande si la réponse indique que la demande a échoué pour des raisons de limitation. Par exemple, si la réponse contient un Retry-After en-tête, elle réessaye d’envoyer la requête en fonction de la valeur de cet en-tête. 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
tracingPolicy(TracingPolicyOptions)	Crée une stratégie qui encapsule les requêtes sortantes avec une étendue de suivi.
userAgentPolicy(TelemetryInfo)	Retourne une stratégie qui ajoute l’en-tête de l’agent utilisateur aux demandes sortantes en fonction de l’élément TelemetryInfo donné.

Informations relatives à la fonction

applyMixins(unknown, any[])

Applique les propriétés du prototype de sourceCtors au prototype de targetCtor

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

Paramètres

targetCtorParam

unknown

sourceCtors

any[]

Tableau d’objets sources à partir duquel les propriétés doivent être extraites.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Crée une fabrique pour un RequestPolicy qui applique un jeton de porteur aux en-têtes des Authorization demandes.

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

Paramètres

credential

TokenCredential

Implémentation TokenCredential qui peut fournir le jeton du porteur.

scopes

string | string[]

Étendues auxquelles le jeton du porteur s’applique.

Retours

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Crée un pipeline HTTP en fonction des options spécifiées.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

Paramètres

pipelineOptions

InternalPipelineOptions

Définit les options utilisées pour configurer des stratégies dans le pipeline HTTP pour un client sdk.

authPolicyFactory

RequestPolicyFactory

Fabrique de stratégie d’authentification facultative à utiliser pour les demandes de signature.

Retours

ServiceClientOptions

Ensemble d’options qui peuvent être passées pour créer un ServiceClient.

delay(number, DelayOptions)

Wrapper pour setTimeout qui résout une promesse après timeInMs millisecondes.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

Paramètres

timeInMs

number

Nombre de millisecondes à retarder.

options

DelayOptions

Options de délai : options d’abandon actuellement

Retours

Promise<void>

Promesse résolue après timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Créez un nouveau RequestPolicyCreator de sérialisation qui sérialisera les corps de requête HTTP au fur et à mesure qu’ils passent par le pipeline HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Paramètres

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

Retours

RequestPolicyFactory

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Étant donné un ensemble particulier de types de contenu à analyser au format JSON ou XML, consomme la réponse HTTP pour produire l’objet de résultat défini par l’OperationSpec de la requête.

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>

Paramètres

jsonContentTypes

string[]

Types de contenu de réponse pour analyser le corps au format JSON.

xmlContentTypes

string[]

Types de contenu de réponse pour analyser le corps au format XML.

response

HttpOperationResponse

Réponse HTTP du pipeline.

options

SerializerOptions

Options du sérialiseur, principalement pour la configuration de l’analyseur XML si nécessaire.

Retours

Promise<HttpOperationResponse>

Objet HttpOperationResponse analysé qui peut être retourné par serviceClient.

disableResponseDecompressionPolicy()

Retourne une fabrique de stratégie de requête qui peut être utilisée pour créer une instance de <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Retours

RequestPolicyFactory

encodeUri(string)

Encode un URI.

function encodeUri(uri: string): string

Paramètres

uri

string

URI à encoder.

Retours

string

URI encodé.

executePromisesSequentially(any[], unknown)

Exécute un tableau de promesses séquentiellement. Vous trouverez ici l’inspiration de cette méthode : https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Un blog génial sur les promesses!

function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>

Paramètres

promiseFactories

any[]

Tableau de fabriques de promesses(fonction qui retourne une promesse)

kickstart

unknown

Entrée de la première promesse utilisée pour lancer la chaîne de promesse. Si elle n’est pas fournie, la chaîne de promesse commence par non définie.

Retours

Promise<any>

Chaîne de promesses résolues ou rejetées

exponentialRetryPolicy(number, number, number)

Stratégie qui retente la requête autant de fois que configuré pour aussi longtemps que l’intervalle de temps maximal de nouvelle tentative spécifié, chaque nouvelle tentative attend plus longtemps que la dernière fois.

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Paramètres

retryCount

number

Nombre maximal de tentatives.

retryInterval

number

Temps de base entre les nouvelles tentatives.

maxRetryInterval

number

Temps d’attente maximal entre les nouvelles tentatives.

Retours

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analyse un objet HttpOperationResponse dans un objet de réponse HTTP normalisé (RestResponse).

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

Paramètres

_response

HttpOperationResponse

Objet Wrapper pour la réponse HTTP.

responseSpec

undefined | OperationResponse

Mappeurs pour savoir comment analyser les propriétés de réponse.

Retours

RestResponse

• Objet de réponse normalisé.

generateClientRequestIdPolicy(string)

Crée une stratégie qui affecte un ID de demande unique aux demandes sortantes.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Paramètres

requestIdHeaderName

string

Nom de l’en-tête à utiliser lors de l’affectation de l’ID unique à la demande.

Retours

RequestPolicyFactory

generateUuid()

UUID généré

function generateUuid(): string

Retours

string

UUID RFC4122 v4.

getDefaultProxySettings(string)

Convertit une URL donnée d’un serveur proxy en ProxySettings ou tente de récupérer ProxySettings à partir de l’environnement actuel si elle n’est pas passée.

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

Paramètres

proxyUrl

string

URL du proxy

Retours

ProxySettings | undefined

Paramètres de proxy par défaut ou non définis.

getDefaultUserAgentValue()

Approche par défaut pour générer des agents utilisateur. Utilise les informations statiques de ce package, ainsi que les informations système disponibles à partir du runtime.

function getDefaultUserAgentValue(): string

Retours

string

isDuration(string)

Indique si la chaîne donnée est au format ISO 8601.

function isDuration(value: string): boolean

Paramètres

value

string

Valeur à valider pour le format de durée ISO 8601.

Retours

boolean

true s’il est valide, false sinon.

isTokenCredential(unknown)

Teste un objet pour déterminer s’il implémente TokenCredential.

function isTokenCredential(credential: unknown): credential

Paramètres

credential

unknown

TokenCredential supposé à tester.

Retours

credential

isValidUuid(string)

Valide l’uuid donné en tant que chaîne

function isValidUuid(uuid: string): boolean

Paramètres

uuid

string

uuid en tant que chaîne qui doit être validée

Retours

boolean

True si l’uuid est valide ; false dans le cas contraire.

keepAlivePolicy(KeepAliveOptions)

Crée une stratégie qui contrôle si les connexions HTTP sont conservées sur les demandes futures.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Paramètres

keepAliveOptions

KeepAliveOptions

Conserver les options actives. Par défaut, les connexions HTTP sont conservées pour les requêtes futures.

Retours

RequestPolicyFactory

Instance du <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Crée une stratégie qui journalise les informations sur la requête sortante et les réponses entrantes.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Paramètres

loggingOptions

LogPolicyOptions

Options de journalisation.

Retours

RequestPolicyFactory

Instance du <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Convertit un OperationOptions en requestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

Paramètres

opts

T

Objet OperationOptions à convertir en RequestOptionsBase

Retours

RequestOptionsBase

parseXML(string, SerializerOptions)

Convertit une chaîne XML donnée en JSON

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

Paramètres

str

string

Chaîne contenant le contenu XML à analyser au format JSON

opts

SerializerOptions

Options qui régissent l’analyse d’une chaîne xml donnée

Retours

Promise<any>

promiseToCallback(Promise<any>)

Avertissement

Cette API est à présent déconseillée.

generated code should instead depend on responseToBody

Convertit une promesse en rappel.

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

Paramètres

promise

Promise<any>

Promesse à convertir en rappel

Retours

(cb: Function) => void

Fonction qui accepte le rappel (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Convertit une promesse en rappel de service.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

Paramètres

promise

Promise<HttpOperationResponse>

La promesse de HttpOperationResponse à convertir en rappel de service

Retours

(cb: ServiceCallback<T>) => void

Fonction qui accepte le rappel de service (cb : ServiceCallback) : void

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[] }): RequestPolicyFactory

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

RequestPolicyFactory

redirectPolicy(number)

Crée une stratégie de redirection, qui envoie une demande répétée à une nouvelle destination si une réponse arrive avec un en-tête « emplacement » et un code d’état compris entre 300 et 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Paramètres

maximumRetries

number

Nombre maximal de redirections à suivre.

Retours

RequestPolicyFactory

Instance du <xref:RedirectPolicy>

serializeObject(unknown)

Fonction utilitaire qui sérialise un objet qui peut contenir des informations binaires dans un objet simple, un tableau ou une chaîne.

function serializeObject(toSerialize: unknown): any

Paramètres

toSerialize

unknown

Retours

any

signingPolicy(ServiceClientCredentials)

Crée une stratégie qui signe les demandes sortantes en appelant à la authenticationProviderméthode fournie signRequest .

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Paramètres

authenticationProvider

ServiceClientCredentials

Fournisseur d’authentification.

Retours

RequestPolicyFactory

Une instance du <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Convertit l’objet JSON donné en chaîne XML

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

Paramètres

obj

unknown

Objet JSON à convertir en chaîne XML

opts

SerializerOptions

Options qui régissent l’analyse d’un objet JSON donné

Retours

string

stripRequest(WebResourceLike)

Retourne une version dépouillée de la requête HTTP qui ne contient pas l’en-tête d’autorisation.

function stripRequest(request: WebResourceLike): WebResourceLike

Paramètres

request

WebResourceLike

Objet De requête HTTP

Retours

WebResourceLike

Version dépouillée de la requête HTTP.

stripResponse(HttpOperationResponse)

Retourne une version dépouillée de la réponse HTTP qui contient uniquement le corps, les en-têtes et l’état.

function stripResponse(response: HttpOperationResponse): any

Paramètres

response

HttpOperationResponse

Réponse HTTP

Retours

any

Version dépouillée de la réponse HTTP.

systemErrorRetryPolicy(number, number, number, number)

Stratégie qui retente en cas d’erreur système, identifiée par les codes « ETIMEDOUT », « ESOCKETTIMEDOUT », « ECONNREFUSED », « ECONNRESET » ou « ENOENT ».

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Paramètres

retryCount

number

Nombre maximal de tentatives.

retryInterval

number

Intervalle de nouvelle tentative du client, en millisecondes.

minRetryInterval

number

Intervalle de nouvelle tentative minimal, en millisecondes.

maxRetryInterval

number

Intervalle de nouvelle tentative maximal, en millisecondes.

Retours

RequestPolicyFactory

Instance du <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Crée une stratégie qui renvoie la demande si la réponse indique que la demande a échoué pour des raisons de limitation. Par exemple, si la réponse contient un Retry-After en-tête, elle réessaye d’envoyer la requête en fonction de la valeur de cet en-tête.

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(): RequestPolicyFactory

Retours

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Crée une stratégie qui encapsule les requêtes sortantes avec une étendue de suivi.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Paramètres

tracingOptions

TracingPolicyOptions

Options de suivi.

Retours

RequestPolicyFactory

Instance de la classe <xref:TracingPolicy>.

userAgentPolicy(TelemetryInfo)

Retourne une stratégie qui ajoute l’en-tête de l’agent utilisateur aux demandes sortantes en fonction de l’élément TelemetryInfo donné.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Paramètres

userAgentData

TelemetryInfo

Informations de télémétrie.

Retours

RequestPolicyFactory

Nouveau <xref:UserAgentPolicy>.