Condividi tramite


@azure/core-http package

Classi

AccessTokenRefresher

Aiuta i criteri di autenticazione del token http di base con la richiesta di un nuovo token se non è attualmente in attesa di un nuovo token.

ApiKeyCredentials

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

BaseRequestPolicy

Classe di base da cui derivano tutti i criteri di richiesta.

BasicAuthenticationCredentials

<xref:ServiceClientCredential> Semplice che esegue l'autenticazione con un nome utente e una password.

DefaultHttpClient

Client HTTP che usa node-fetch.

ExpiringAccessTokenCache

Fornisce un'implementazione accessTokenCache che cancella l'accesso memorizzato nella cache dopo la scadenzaOnTimestamp.

HttpHeaders

Raccolta di coppie chiave/valore dell'intestazione HTTP.

RequestPolicyOptions

Proprietà facoltative che possono essere usate durante la creazione di un oggetto RequestPolicy.

RestError

Errore risultante da una richiesta HTTP a un endpoint di servizio.

Serializer

Usato per eseguire il mapping degli oggetti di risposta non elaborati alle forme finali. Consente di preparare e decomprimere date e altri tipi codificati che non sono intrinseci a JSON. Consente inoltre di eseguire il pull di valori da intestazioni, nonché di inserire valori e costanti predefiniti.

ServiceClient

ServiceClient invia richieste di servizio e riceve risposte.

TopicCredentials

Oggetto TopicCredentials usato per Griglia di eventi di Azure.

URLBuilder

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

URLQuery

Classe che gestisce la parte della query di un URLBuilder.

WebResource

Crea un nuovo oggetto WebResource.

Questa classe fornisce un'astrazione su una chiamata REST mediante la libreria/implementazione agnostica e il wrapping delle proprietà necessarie per avviare una richiesta.

Interfacce

AbortSignalLike

Consente l'interruzione della richiesta al momento dell'attivazione dell'evento "abort". Compatibile con il browser predefinito AbortSignal e polifill comuni.

AccessToken

Rappresenta un token di accesso con una scadenza.

AccessTokenCache

Fornisce una cache per un oggetto AccessToken restituito da un tokenCredential.

ApiKeyCredentialOptions

Descrive le opzioni da fornire durante la creazione di un'istanza di ApiKeyCredentials

BaseMapper

Definizione di base di un mapper. Può essere usato per oggetti JavaScript XML e normale.

CompositeMapper

Un mapper composto da altri mappatori.

CompositeMapperType

Consente di creare un mapper che descrive come eseguire il mapping di un set di proprietà di un oggetto basato su altri mapping.

Deve essere presente solo una delle proprietà seguenti: classNamee modelPropertiesadditionalProperties.

DeserializationContentTypes

I tipi di contenuto che indicano che una risposta dell'operazione deve essere deserializzata in modo specifico.

DeserializationOptions

Opzioni per configurare la deserializzazione della risposta API.

DictionaryMapper

Un mapper che descrive oggetti JavaScript semplici usati come coppie chiave/valore.

DictionaryMapperType

Consente di creare un mapper che descrive come analizzare un dizionario di valori mappati.

EnumMapper

Un mapper che descrive un valore enumerazione.

EnumMapperType

Consente di creare un mapper che descrive come analizzare un valore enumerazione.

GetTokenOptions

Definisce le opzioni per TokenCredential.getToken.

HttpClient

Interfaccia che può inviare HttpRequests e ricevere httpResponses promesso.

HttpHeader

Un'intestazione singola all'interno di un insieme HttpHeaders.

HttpHeadersLike

Raccolta di coppie chiave/valore dell'intestazione HTTP.

HttpOperationResponse

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

HttpPipelineLogger

Un 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

Le proprietà in una risposta HTTP che saranno sempre presenti.

InternalPipelineOptions

Definisce le opzioni usate per configurare le opzioni interne della pipeline HTTP per un client SDK.

KeepAliveOptions

Opzioni per la gestione delle connessioni HTTP per le richieste future.

LogPolicyOptions

Opzioni da passare al logPolicy. Per impostazione predefinita, viene registrato solo un elenco di intestazioni, anche se è possibile configurare questa impostazione. I corpi di richiesta e risposta non vengono mai registrati.

MapperConstraints

Descrizione di vari vincoli di valore, ad esempio intervalli interi e regex stringa.

OperationArguments

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

OperationOptions

Tipo di opzioni di base per tutte le operazioni.

OperationParameter

Interfaccia comune estesa di tutti i parametri operation.

OperationQueryParameter

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

OperationRequestOptions

Opzioni che consentono di configurare la gestione delle richieste HTTP effettuate da un'operazione SDK.

OperationResponse

OperazioneResponse che può essere restituita da una richiesta di operazione per un singolo codice di stato.

OperationSpec

Specifica che definisce come eseguire un'operazione di servizio specifica su HTTP, incluso come serializzare correttamente le informazioni sulla richiesta in e deserializzare le informazioni sulla risposta in un payload oggetto restituito da ServiceClient.

OperationURLParameter

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

ParameterValue

Valore del parametro fornito per i parametri di percorso o query in RequestPrepareOptions

PipelineOptions

Definisce le opzioni usate per configurare la pipeline HTTP per un client SDK.

PolymorphicDiscriminator

Usato per disambiguare le unioni dei tipi discriminati. Ad esempio, se la risposta può avere molte forme, ma include anche un campo "kind" (o simile), tale campo può essere usato per determinare come deserializzare la risposta al tipo corretto.

ProxySettings

Opzioni per configurare un proxy per le richieste in uscita (solo Node.js).

RedirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

RequestOptionsBase

Descrive la struttura di base dell'oggetto opzioni che verrà usato in ogni operazione.

RequestPolicy

Struttura sottostante di un criterio di richiesta.

RequestPolicyOptionsLike

Proprietà facoltative che possono essere usate durante la creazione di un oggetto RequestPolicy.

RequestPrepareOptions

Opzioni per preparare una richiesta HTTP in uscita.

RestResponse

Risposta flat a una chiamata REST. Contiene le proprietà httpOperationResponse sottostanti e le proprietà unite di parsedBody, parsedHeaderse così via.

RetryOptions

Opzioni che controllano come riprovare le richieste non riuscite.

SequenceMapper

Un mapper che descrive le matrici.

SequenceMapperType

Consente di creare un mapper che descrive come analizzare una sequenza di valori mappati.

SerializerOptions

Opzioni per gestire il comportamento del parser xml e del generatore.

ServiceCallback
ServiceClientCredentials

Rappresenta un oggetto o una classe con un signRequest metodo che firma le richieste in uscita, ad esempio impostando l'intestazione Authorization .

ServiceClientOptions

Opzioni da fornire durante la creazione del client.

SimpleMapperType

Tipo di semplice mapper.

TokenCredential

Rappresenta una credenziale in grado di fornire un token di autenticazione.

TracingPolicyOptions

Opzioni per personalizzare i criteri di traccia.

UrlParameterValue

Interfaccia che rappresenta un valore del parametro URL.

UserAgentOptions

Opzioni per aggiungere i dettagli dell'agente utente alle richieste in uscita.

WebResourceLike

Descrizione di una richiesta HTTP da effettuare a un server remoto.

Alias tipo

Authenticator

Una funzione che riceve una sfida e risolve una promessa con un token di stringa.

CommonRequestInfo

URL di stringa usati durante la chiamata a fetch().

CommonRequestInit

Oggetto contenente informazioni sulla richiesta HTTP in uscita.

CommonResponse

Oggetto contenente informazioni sulla risposta HTTP in ingresso.

HttpMethods

Elenco dei metodi HTTP supportati.

HttpRequestBody

Possibili tipi di corpo della richiesta HTTP

Mapper

I mapping sono definizioni dei modelli di dati usati nella libreria. Questi modelli di dati fanno parte delle definizioni operazione o client nelle risposte o nei parametri.

MapperType

Tipo del mapper. Include mapping noti.

ParameterPath

Percorso che descrive come accedere a una determinata proprietà in un'origine dati dell'oggetto specificato. Può essere un singolo nome di proprietà, una matrice che indica i nomi delle proprietà annidati o un set di proprietà denominate multiple con percorsi nel caso di valori di oggetti complessi.

ProxyOptions

Alias di ProxySettings per l'uso futuro.

RawHttpHeaders

Insieme HttpHeaders rappresentato come un semplice oggetto JSON.

RequestPolicyFactory

Crea una nuova richiesta RequestPolicy per richiesta che usa l'oggetto nextPolicy specificato.

TelemetryInfo

Informazioni di telemetria. Coppie chiave/valore da includere all'interno della stringa di User-Agent.

TransferProgressEvent

Attivato in risposta al caricamento o al download dello stato di avanzamento.

Enumerazioni

HttpPipelineLogLevel

Livelli diversi di log che possono essere usati con HttpPipelineLogger.

QueryCollectionFormat

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

RetryMode

Descrive il tipo di modalità tentativi. Attualmente supporta solo Esponenziale.

Funzioni

applyMixins(unknown, any[])

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

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Crea una nuova factory per un requestPolicy che applica un token di connessione alle intestazioni delle Authorization richieste.

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Crea una pipeline HTTP in base alle opzioni specificate.

delay(number, DelayOptions)

Wrapper per setTimeout che risolve una promessa dopo i millisecondi timeInMs.

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Creare una nuova serializzazione RequestPolicyCreator che serializza i corpi delle richieste HTTP durante il passaggio della pipeline HTTP.

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

Dato un determinato set di tipi di contenuto da analizzare come JSON o XML, usa la risposta HTTP per produrre l'oggetto risultato definito dall'operazioneSpec della richiesta.

disableResponseDecompressionPolicy()

Restituisce una factory dei criteri di richiesta che può essere usata per creare un'istanza di <xref:DisableResponseDecompressionPolicy>.

encodeUri(string)

Codifica un URI.

executePromisesSequentially(any[], unknown)

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)

Criterio che esegue il tentativo di ripetizione della richiesta fino a quando l'intervallo massimo di tentativi specificato, ogni tentativo attende più tempo rispetto all'ultima volta.

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analizza un oggetto di risposta HTTPOperationResponse in un oggetto di risposta HTTP normalizzato (RestResponse).

generateClientRequestIdPolicy(string)

Crea un criterio che assegna un ID richiesta univoco alle richieste in uscita.

generateUuid()

UUID generato

getDefaultProxySettings(string)

Converte un determinato URL di un server proxy in ProxySettings o tenta di recuperare ProxySettings dall'ambiente corrente se non viene passato.

getDefaultUserAgentValue()

Approccio predefinito per generare agenti utente. Usa le informazioni statiche di questo pacchetto, oltre alle informazioni di sistema disponibili dal runtime.

isDuration(string)

Indica se la stringa specificata è in formato ISO 8601.

isTokenCredential(unknown)

Verifica un oggetto per determinare se implementa TokenCredential.

isValidUuid(string)

Convalida l'uuid specificato come stringa

keepAlivePolicy(KeepAliveOptions)

Crea un criterio che controlla se le connessioni HTTP vengono mantenute nelle richieste future.

logPolicy(LogPolicyOptions)

Crea un criterio che registra informazioni sulla richiesta in uscita e sulle risposte in ingresso.

operationOptionsToRequestOptionsBase<T>(T)

Converte un'operazioneOptions in una RequestOptionsBase

parseXML(string, SerializerOptions)

Converte una stringa XML specificata in JSON

promiseToCallback(Promise<any>)

Converte una promessa in un callback.

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converte una promessa in un callback del servizio.

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

Criterio che consente a uno di applicare le impostazioni proxy a tutte le richieste. Se non sono passate impostazioni statiche, verranno recuperate dalle variabili di ambiente HTTPS_PROXY o HTTP_PROXY.

redirectPolicy(number)

Crea un criterio di reindirizzamento, che invia una ripetizione della richiesta a una nuova destinazione se una risposta arriva con un'intestazione "location" e un codice di stato compreso tra 300 e 307.

serializeObject(unknown)

Funzione di utilità che serializza un oggetto che potrebbe contenere informazioni binarie in un oggetto normale, una matrice o una stringa.

signingPolicy(ServiceClientCredentials)

Crea un criterio che firma le richieste in uscita chiamando al metodo specificatoauthenticationProvidersignRequest.

stringifyXML(unknown, SerializerOptions)

Converte l'oggetto JSON specificato in stringa XML

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)

Criterio che esegue il tentativo quando si verifica un errore di sistema, identificato dai codici "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" o "ENOENT".

throttlingRetryPolicy()

Crea un criterio che invia nuovamente la richiesta se la risposta indica che la richiesta non è riuscita a causa di motivi di limitazione. Ad esempio, se la risposta contiene un'intestazione Retry-After , riprova a inviare la richiesta in base al valore di tale intestazione.

Per altre informazioni, fare riferimento a https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitse https://docs.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

tracingPolicy(TracingPolicyOptions)

Crea un criterio che esegue il wrapping delle richieste in uscita con un intervallo di traccia.

userAgentPolicy(TelemetryInfo)

Restituisce un criterio che aggiunge l'intestazione dell'agente utente alle richieste in uscita in base all'oggetto TelemetryInfo specificato.

Dettagli funzione

applyMixins(unknown, any[])

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

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

Parametri

targetCtorParam

unknown

sourceCtors

any[]

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

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Crea una nuova factory per un requestPolicy che applica un token di connessione alle intestazioni delle Authorization richieste.

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

Parametri

credential
TokenCredential

Implementazione di TokenCredential che può fornire il token di connessione.

scopes

string | string[]

Ambiti per i quali si applica il token di connessione.

Restituisce

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Crea una pipeline HTTP in base alle opzioni specificate.

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

Parametri

pipelineOptions
InternalPipelineOptions

Definisce le opzioni usate per configurare i criteri nella pipeline HTTP per un client SDK.

authPolicyFactory
RequestPolicyFactory

Una factory di criteri di autenticazione facoltativa da usare per la firma delle richieste.

Restituisce

Set di opzioni che possono essere passate per creare un nuovo ServiceClient.

delay(number, DelayOptions)

Wrapper per setTimeout che risolve una promessa dopo i millisecondi timeInMs.

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

Parametri

timeInMs

number

Numero di millisecondi da ritardare.

options
DelayOptions

Opzioni per il ritardo : opzioni attualmente di interruzione

Restituisce

Promise<void>

Promessa risolta dopo timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Creare una nuova serializzazione RequestPolicyCreator che serializza i corpi delle richieste HTTP durante il passaggio della pipeline HTTP.

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

Parametri

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

Restituisce

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

Dato un determinato set di tipi di contenuto da analizzare come JSON o XML, usa la risposta HTTP per produrre l'oggetto risultato definito dall'operazioneSpec della richiesta.

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

Parametri

jsonContentTypes

string[]

Tipi di contenuto di risposta per analizzare il corpo come JSON.

xmlContentTypes

string[]

Tipi di contenuto di risposta per analizzare il corpo come XML.

response
HttpOperationResponse

Risposta HTTP dalla pipeline.

options
SerializerOptions

Opzioni per il serializzatore, principalmente per la configurazione del parser XML, se necessario.

Restituisce

Oggetto HttpOperationResponse analizzato che può essere restituito da ServiceClient.

disableResponseDecompressionPolicy()

Restituisce una factory dei criteri di richiesta che può essere usata per creare un'istanza di <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Restituisce

encodeUri(string)

Codifica un URI.

function encodeUri(uri: string): string

Parametri

uri

string

URI da codificare.

Restituisce

string

URI codificato.

executePromisesSequentially(any[], unknown)

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

Parametri

promiseFactories

any[]

Matrice di factory promise(Funzione che restituisce una promessa)

kickstart

unknown

Input alla prima promessa usata per avviare la catena di promesse. Se non fornito, la catena di promesse inizia con indefinita.

Restituisce

Promise<any>

Una catena di promesse risolte o rifiutate

exponentialRetryPolicy(number, number, number)

Criterio che esegue il tentativo di ripetizione della richiesta fino a quando l'intervallo massimo di tentativi specificato, ogni tentativo attende più tempo rispetto all'ultima volta.

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

Parametri

retryCount

number

Numero massimo di tentativi.

retryInterval

number

Tempo di base tra tentativi.

maxRetryInterval

number

Tempo massimo di attesa tra tentativi.

Restituisce

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analizza un oggetto di risposta HTTPOperationResponse in un oggetto di risposta HTTP normalizzato (RestResponse).

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

Parametri

_response
HttpOperationResponse

Oggetto Wrapper per la risposta http.

responseSpec

undefined | OperationResponse

Mappingr per come analizzare le proprietà della risposta.

Restituisce

  • Oggetto di risposta normalizzato.

generateClientRequestIdPolicy(string)

Crea un criterio che assegna un ID richiesta univoco alle richieste in uscita.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametri

requestIdHeaderName

string

Nome dell'intestazione da usare quando si assegna l'ID univoco alla richiesta.

Restituisce

generateUuid()

UUID generato

function generateUuid(): string

Restituisce

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Converte un determinato URL di un server proxy in ProxySettings o tenta di recuperare ProxySettings dall'ambiente corrente se non viene passato.

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

Parametri

proxyUrl

string

URL del proxy

Restituisce

ProxySettings | undefined

Impostazioni proxy predefinite o non definita.

getDefaultUserAgentValue()

Approccio predefinito per generare agenti utente. Usa le informazioni statiche di questo pacchetto, oltre alle informazioni di sistema disponibili dal runtime.

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.

isTokenCredential(unknown)

Verifica un oggetto per determinare se implementa TokenCredential.

function isTokenCredential(credential: unknown): credential

Parametri

credential

unknown

TokenCredential previsto da testare.

Restituisce

credential

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.

keepAlivePolicy(KeepAliveOptions)

Crea un criterio che controlla se le connessioni HTTP vengono mantenute nelle richieste future.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parametri

keepAliveOptions
KeepAliveOptions

Mantieni le opzioni attive. Per impostazione predefinita, le connessioni HTTP vengono mantenute per le richieste future.

Restituisce

Istanza di <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Crea un criterio che registra informazioni sulla richiesta in uscita e sulle risposte in ingresso.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parametri

loggingOptions
LogPolicyOptions

Opzioni di registrazione.

Restituisce

Istanza di <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Converte un'operazioneOptions in una RequestOptionsBase

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

Parametri

opts

T

Oggetto OperationOptions da convertire in RequestOptionsBase

Restituisce

parseXML(string, SerializerOptions)

Converte una stringa XML specificata in JSON

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

Parametri

str

string

Stringa contenente il contenuto XML da analizzare in JSON

opts
SerializerOptions

Opzioni che regolano l'analisi della stringa xml specificata

Restituisce

Promise<any>

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>): (cb: Function) => void

Parametri

promise

Promise<any>

La promessa da convertire in un callback

Restituisce

(cb: Function) => void

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>): (cb: ServiceCallback<T>) => void

Parametri

promise

Promise<HttpOperationResponse>

Promessa di HttpOperationResponse da convertire in un callback del servizio

Restituisce

(cb: ServiceCallback<T>) => void

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

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

Criterio che consente a uno di applicare le impostazioni proxy a tutte le richieste. Se non sono passate impostazioni statiche, verranno recuperate dalle variabili di ambiente HTTPS_PROXY o HTTP_PROXY.

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

Parametri

proxySettings
ProxySettings

ProxySettings da usare in ogni richiesta.

options

{ customNoProxyList?: string[] }

impostazioni aggiuntive, ad esempio, modelli di NO_PROXY personalizzati

Restituisce

redirectPolicy(number)

Crea un criterio di reindirizzamento, che invia una ripetizione della richiesta a una nuova destinazione se una risposta arriva con un'intestazione "location" e un codice di stato compreso tra 300 e 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametri

maximumRetries

number

Numero massimo di reindirizzamenti da seguire.

Restituisce

Istanza di <xref:RedirectPolicy>

serializeObject(unknown)

Funzione di utilità che serializza un oggetto che potrebbe contenere informazioni binarie in un oggetto normale, una matrice o una stringa.

function serializeObject(toSerialize: unknown): any

Parametri

toSerialize

unknown

Restituisce

any

signingPolicy(ServiceClientCredentials)

Crea un criterio che firma le richieste in uscita chiamando al metodo specificatoauthenticationProvidersignRequest.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametri

authenticationProvider
ServiceClientCredentials

Provider di autenticazione.

Restituisce

Istanza del <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Converte l'oggetto JSON specificato in stringa XML

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

Parametri

obj

unknown

Oggetto JSON da convertire in stringa XML

opts
SerializerOptions

Opzioni che regolano l'analisi dell'oggetto JSON specificato

Restituisce

string

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

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)

Criterio che esegue il tentativo quando si verifica un errore di sistema, identificato dai codici "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" o "ENOENT".

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

Parametri

retryCount

number

Numero massimo di tentativi.

retryInterval

number

Intervallo di tentativi client, in millisecondi.

minRetryInterval

number

Intervallo minimo di tentativi, in millisecondi.

maxRetryInterval

number

Intervallo massimo di tentativi, in millisecondi.

Restituisce

Istanza di <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Crea un criterio che invia nuovamente la richiesta se la risposta indica che la richiesta non è riuscita a causa di motivi di limitazione. Ad esempio, se la risposta contiene un'intestazione Retry-After , riprova a inviare la richiesta in base al valore di tale intestazione.

Per altre informazioni, fare riferimento a https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitse https://docs.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Restituisce

tracingPolicy(TracingPolicyOptions)

Crea un criterio che esegue il wrapping delle richieste in uscita con un intervallo di traccia.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parametri

tracingOptions
TracingPolicyOptions

Opzioni di traccia.

Restituisce

Istanza della classe <xref:TracingPolicy>.

userAgentPolicy(TelemetryInfo)

Restituisce un criterio che aggiunge l'intestazione dell'agente utente alle richieste in uscita in base all'oggetto TelemetryInfo specificato.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametri

userAgentData
TelemetryInfo

Informazioni di telemetria.

Restituisce

Nuovo oggetto <xref:UserAgentPolicy>.