Condividi tramite

@azure/ms-rest-js package

  • Riferimento

Classi

ApiKeyCredentials

Esegue l'autenticazione a un servizio usando una chiave API.
AzureIdentityCredentialAdapter

Questa classe fornisce una semplice estensione da usare <xref:TokenCredential> dalla @azure/identity libreria da usare con gli SDK di Azure legacy che accettano la famiglia di credenziali ServiceClientCredentials per l'autenticazione.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

Esegue l'autenticazione a un servizio usando una chiave API.
HttpHeaders

Raccolta di coppie chiave/valore di intestazione HTTP.
RequestPolicyOptions

Proprietà facoltative che possono essere utilizzate durante la creazione di un oggetto RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials

Oggetto credentials che usa una stringa di token e uno schema di creazione per l'autenticazione.
TopicCredentials

Esegue l'autenticazione a un servizio usando una chiave API.
URLBuilder

Classe che gestisce la creazione, la modifica e l'analisi degli URL.
URLQuery

Classe che gestisce la parte di query di un URLBuilder.
WebResource

Crea un nuovo oggetto WebResource.

Questa classe fornisce un'astrazione su una chiamata REST essendo indipendente dalla libreria/implementazione e eseguendo il wrapping delle proprietà necessarie per avviare una richiesta.

Interfacce

AbortSignalLike

Consente di interrompere la richiesta al momento dell'attivazione dell'evento di interruzione. Compatibile con il browser AbortSignal e i polifill comuni predefiniti.
AgentSettings

Agenti HTTP e HTTPS (solo Node.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes

I tipi di contenuto che indicano che una risposta dell'operazione deve essere deserializzata in modo particolare.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient

Interfaccia che può inviare HttpRequests e ricevere httpResponses promesso.
HttpHeader

Singola intestazione all'interno di un insieme HttpHeaders.
HttpHeadersLike

Raccolta di coppie chiave/valore di intestazione HTTP.
HttpOperationResponse

Oggetto wrapper per richiesta e risposta HTTP. L'oggetto deserializzato viene archiviato nella proprietà quando il corpo della parsedBody risposta viene ricevuto in JSON o XML.
HttpPipelineLogger

Logger che può essere aggiunto a un oggetto HttpPipeline. Ciò consente a ogni RequestPolicy di registrare i messaggi che possono essere usati a scopo di debug.
HttpResponse

Proprietà in una risposta HTTP che sarà sempre presente.
MapperConstraints
OperationArguments

Raccolta di proprietà che si applicano a una singola chiamata di un'operazione.
OperationParameter

Interfaccia comune estesa da tutti i parametri Operation.
OperationQueryParameter

Parametro per un'operazione che verrà aggiunto come parametro di query alla richiesta HTTP dell'operazione.
OperationResponse

Oggetto OperationResponse che può essere restituito da una richiesta di operazione per un singolo codice di stato.
OperationSpec

Specifica che definisce un'operazione.
OperationURLParameter

Parametro per un'operazione che verrà sostituito nell'URL della richiesta dell'operazione.
ParameterValue

Valore del parametro specificato per i parametri di percorso o di query in RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings

Impostazioni proxy HTTP (solo Node.js)
RedirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.
RequestOptionsBase

Descrive la struttura di base dell'oggetto options che verrà utilizzato in ogni operazione.
RequestPolicy
RequestPolicyOptionsLike

Proprietà facoltative che possono essere utilizzate durante la creazione di un oggetto RequestPolicy.
RequestPrepareOptions
RestResponse

Risposta flat a una chiamata REST. Contiene le proprietà httpOperationResponse sottostanti, nonché le proprietà unite del parsedBody, parsedHeaders e così via.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

Opzioni da fornire durante la creazione del client.
SimpleMapperType
TokenResponse

TokenResponse è definito in @azure/ms-rest-nodeauth e viene copiato qui per non aggiungere una dipendenza non necessaria.
UrlParameterValue
WebResourceLike

Astrazione su una chiamata REST.

Alias tipo

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders

Insieme HttpHeaders rappresentato come un semplice oggetto JSON.
RequestPolicyFactory

Crea un nuovo oggetto RequestPolicy per richiesta che usa il valore nextPolicy specificato.
TelemetryInfo
TransferProgressEvent

Generato in risposta all'avanzamento del caricamento o del download.

Enumerazioni

HttpPipelineLogLevel

I diversi livelli di log che possono essere usati con HttpPipelineLogger.
QueryCollectionFormat

Formato che verrà utilizzato per unire una matrice di valori per un valore del parametro di query.

Funzioni

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

Applica le proprietà sul prototipo di sourceCtors al prototipo di targetCtor
delay<T>(number, T)

Wrapper per setTimeout che risolve una promessa dopo t millisecondi.
deserializationPolicy(DeserializationContentTypes)

Creare una nuova serializzazione RequestPolicyCreator che serializza i corpi delle richieste HTTP passando attraverso la pipeline HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

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

Esegue una matrice di promesse in sequenza. L'ispirazione di questo metodo è qui: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Un blog fantastico sulle promesse!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

UUID generato
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

Indica se la stringa specificata è in formato ISO 8601.
isValidUuid(string)

Convalida l'uuid specificato come stringa
logPolicy(any)
promiseToCallback(Promise<any>)

Converte una promessa in un callback.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converte una promessa in un callback del servizio.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

Restituisce una versione rimossa della richiesta Http che non contiene l'intestazione Di autorizzazione.
stripResponse(HttpOperationResponse)

Restituisce una versione rimossa della risposta Http che contiene solo il corpo, le intestazioni e lo stato.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Dettagli funzione

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parametri

agentSettings
AgentSettings

Restituisce

RequestPolicyFactory

applyMixins(any, any[])

Applica le proprietà sul prototipo di sourceCtors al prototipo di targetCtor

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

Parametri

targetCtor

any

Oggetto di destinazione in cui devono essere applicate le proprietà.

sourceCtors

any[]

Matrice di oggetti di origine da cui devono essere acquisite le proprietà.

delay<T>(number, T)

Wrapper per setTimeout che risolve una promessa dopo t millisecondi.

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

Parametri

t

number

Numero di millisecondi da ritardare.

value

T

Valore da risolvere con dopo un timeout di t millisecondi.

Restituisce

Promise<T>

Promessa risolta

deserializationPolicy(DeserializationContentTypes)

Creare una nuova serializzazione RequestPolicyCreator che serializza i corpi delle richieste HTTP passando attraverso la pipeline HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parametri

deserializationContentTypes
DeserializationContentTypes

Restituisce

RequestPolicyFactory

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

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

Parametri

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

Restituisce

Promise<HttpOperationResponse>

encodeUri(string)

Codifica un URI.

function encodeUri(uri: string): string

Parametri

uri

string

URI da codificare.

Restituisce

string

URI codificato.

executePromisesSequentially(any[], any)

Esegue una matrice di promesse in sequenza. L'ispirazione di questo metodo è qui: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Un blog fantastico sulle promesse!

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

Parametri

promiseFactories

any[]

Matrice di factory promise (funzione che restituisce una promessa)

kickstart

any

Input per la prima promessa usata per avviare la catena di promesse. Se non specificato, la catena di promesse inizia con non definito.

Restituisce

Promise<any>

Una catena di promesse risolte o rifiutate

exponentialRetryPolicy(number, number, number, number) 

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

Parametri

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Restituisce

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Parametri

_response
HttpOperationResponse
responseSpec

undefined | OperationResponse

Restituisce

RestResponse

generateClientRequestIdPolicy(string) 

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametri

requestIdHeaderName

string

Restituisce

RequestPolicyFactory

generateUuid()

UUID generato

function generateUuid(): string

Restituisce

string

RFC4122 v4 UUID.

getDefaultProxySettings(string) 

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

Parametri

proxyUrl

string

Restituisce

ProxySettings | undefined

getDefaultUserAgentValue() 

function getDefaultUserAgentValue(): string

Restituisce

string

isDuration(string)

Indica se la stringa specificata è in formato ISO 8601.

function isDuration(value: string): boolean

Parametri

value

string

Valore da convalidare per il formato di durata ISO 8601.

Restituisce

boolean

true se valido, false in caso contrario.

isValidUuid(string)

Convalida l'uuid specificato come stringa

function isValidUuid(uuid: string): boolean

Parametri

uuid

string

uuid come stringa che deve essere convalidata

Restituisce

boolean

True se l'uuid è valido; false in caso contrario.

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Parametri

logger

any

Restituisce

RequestPolicyFactory

promiseToCallback(Promise<any>)

Avviso

Questa API è ora deprecata.

generated code should instead depend on responseToBody

Converte una promessa in un callback.

function promiseToCallback(promise: Promise<any>): Function

Parametri

promise

Promise<any>

Promessa da convertire in callback

Restituisce

Function

Funzione che accetta il callback (cb: Function): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converte una promessa in un callback del servizio.

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

Parametri

promise

Promise<HttpOperationResponse>

Promessa di HttpOperationResponse da convertire in un callback del servizio

Restituisce

Function

Funzione che accetta il callback del servizio (cb: ServiceCallback): void

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parametri

proxySettings
ProxySettings

Restituisce

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametri

maximumRetries

number

Restituisce

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Parametri

toSerialize

any

Restituisce

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametri

authenticationProvider
ServiceClientCredentials

Restituisce

RequestPolicyFactory

stripRequest(WebResourceLike)

Restituisce una versione rimossa della richiesta Http che non contiene l'intestazione Di autorizzazione.

function stripRequest(request: WebResourceLike): WebResourceLike

Parametri

request
WebResourceLike

Oggetto Richiesta Http

Restituisce

WebResourceLike

Versione rimossa della richiesta Http.

stripResponse(HttpOperationResponse)

Restituisce una versione rimossa della risposta Http che contiene solo il corpo, le intestazioni e lo stato.

function stripResponse(response: HttpOperationResponse): any

Parametri

response
HttpOperationResponse

Risposta Http

Restituisce

any

Versione rimossa di Http Response.

systemErrorRetryPolicy(number, number, number, number) 

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

Parametri

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Restituisce

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parametri

maxRetries

number

Restituisce

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametri

userAgentData
TelemetryInfo

Restituisce

RequestPolicyFactory