Partager via

@azure/ms-rest-js package

  • Référence

Classes

ApiKeyCredentials

S’authentifie auprès d’un service à l’aide d’une clé API.
AzureIdentityCredentialAdapter

Cette classe fournit une extension simple à utiliser <xref:TokenCredential> à partir de la @azure/identity bibliothèque pour l’utiliser avec les sdk Azure hérités qui acceptent la famille d’informations d’identification ServiceClientCredentials pour l’authentification .
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

S’authentifie auprès d’un service à l’aide d’une clé API.
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
Serializer
ServiceClient
TokenCredentials

Objet d’informations d’identification qui utilise une chaîne de jeton et un schéma de création pour l’authentification.
TopicCredentials

S’authentifie auprès d’un service à l’aide d’une clé API.
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.
AgentSettings

Agents HTTP et HTTPS (Node.js uniquement)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
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.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
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.
MapperConstraints
OperationArguments

Collection de propriétés qui s’appliquent à un appel unique d’une opération.
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.
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 une opération.
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
PolymorphicDiscriminator
ProxySettings

Paramètres de proxy HTTP (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
RequestPolicyOptionsLike

Propriétés facultatives qui peuvent être utilisées lors de la création d’une stratégie RequestPolicy.
RequestPrepareOptions
RestResponse

Réponse aplatit à un appel REST. Contient le httpOperationResponse sous-jacent, ainsi que les propriétés fusionnées de parsedBody, parsedHeaders, etc.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

Options à fournir lors de la création du client.
SimpleMapperType
TokenResponse

TokenResponse est défini dans @azure/ms-rest-nodeauth et est copié ici pour ne pas ajouter de dépendance inutile.
UrlParameterValue
WebResourceLike

Abstraction sur un appel REST.

Alias de type

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
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
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.

Fonctions

agentPolicy(AgentSettings)
applyMixins(any, any[])

Applique les propriétés du prototype de sourceCtors au prototype de targetCtor
delay<T>(number, T)

Wrapper pour setTimeout qui résout une promesse après t millisecondes.
deserializationPolicy(DeserializationContentTypes)

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)
encodeUri(string)

Encode un URI.
executePromisesSequentially(any[], any)

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, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

UUID généré
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

Indique si la chaîne donnée est au format ISO 8601.
isValidUuid(string)

Valide l’uuid donné en tant que chaîne
logPolicy(any)
promiseToCallback(Promise<any>)

Convertit une promesse en rappel.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Convertit une promesse en rappel de service.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

Retourne une version supprimée de la requête HTTP qui ne contient pas l’en-tête d’autorisation.
stripResponse(HttpOperationResponse)

Retourne une version supprimée de la réponse Http qui contient uniquement le corps, les en-têtes et l’état.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Informations relatives à la fonction

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Paramètres

agentSettings
AgentSettings

Retours

RequestPolicyFactory

applyMixins(any, any[])

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

function applyMixins(targetCtor: any, sourceCtors: any[])

Paramètres

targetCtor

any

Objet cible sur lequel les propriétés doivent être appliquées.

sourceCtors

any[]

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

delay<T>(number, T)

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

function delay<T>(t: number, value?: T): Promise<T>

Paramètres

t

number

Nombre de millisecondes à retarder.

value

T

Valeur à résoudre après un délai d’expiration de t millisecondes.

Retours

Promise<T>

Promesse résolue

deserializationPolicy(DeserializationContentTypes)

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

Paramètres

deserializationContentTypes
DeserializationContentTypes

Retours

RequestPolicyFactory

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

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

Paramètres

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

Retours

Promise<HttpOperationResponse>

encodeUri(string)

Encode un URI.

function encodeUri(uri: string): string

Paramètres

uri

string

URI à encoder.

Retours

string

URI encodé.

executePromisesSequentially(any[], any)

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?: any): Promise<any>

Paramètres

promiseFactories

any[]

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

kickstart

any

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, number) 

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

Paramètres

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Retours

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Paramètres

_response
HttpOperationResponse
responseSpec

undefined | OperationResponse

Retours

RestResponse

generateClientRequestIdPolicy(string) 

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Paramètres

requestIdHeaderName

string

Retours

RequestPolicyFactory

generateUuid()

UUID généré

function generateUuid(): string

Retours

string

UUID RFC4122 v4.

getDefaultProxySettings(string) 

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

Paramètres

proxyUrl

string

Retours

ProxySettings | undefined

getDefaultUserAgentValue() 

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.

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.

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Paramètres

logger

any

Retours

RequestPolicyFactory

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>): Function

Paramètres

promise

Promise<any>

Promesse à convertir en rappel

Retours

Function

Fonction qui prend le rappel (cb : Fonction) : void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Convertit une promesse en rappel de service.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function

Paramètres

promise

Promise<HttpOperationResponse>

La promesse de HttpOperationResponse à convertir en rappel de service

Retours

Function

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

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Paramètres

proxySettings
ProxySettings

Retours

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Paramètres

maximumRetries

number

Retours

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Paramètres

toSerialize

any

Retours

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Paramètres

authenticationProvider
ServiceClientCredentials

Retours

RequestPolicyFactory

stripRequest(WebResourceLike)

Retourne une version supprimé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 Requête Http

Retours

WebResourceLike

Version supprimée de http request.

stripResponse(HttpOperationResponse)

Retourne une version supprimé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 supprimée de la réponse Http.

systemErrorRetryPolicy(number, number, number, number) 

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

Paramètres

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Retours

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Paramètres

maxRetries

number

Retours

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Paramètres

userAgentData
TelemetryInfo

Retours

RequestPolicyFactory