@azure/core-https package

Classi

DefaultHttpsClient

Un'implementazione HttpsClient che utilizza il modulo "https" di Node per inviare richieste HTTPS.

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

Interfacce

AddPipelineOptions

Opzioni quando si aggiungono criteri alla pipeline. Usato per esprimere le dipendenze da altri criteri.

BearerTokenAuthenticationPolicyOptions

Opzioni per configurare bearerTokenAuthenticationPolicy

ExponentialRetryPolicyOptions

Opzioni che controllano come ripetere le richieste non riuscite.

HttpHeaders

Rappresenta un set di intestazioni HTTP in una richiesta/risposta. I nomi di intestazione vengono considerati senza distinzione tra maiuscole e minuscole.

HttpsClient

Interfaccia necessaria per un client che effettua richieste HTTPS per conto di una pipeline.

InternalPipelineOptions

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

LogPolicyOptions

Opzioni per configurare logPolicy.

Pipeline

Rappresenta una pipeline per l'invio di una richiesta HTTPS a un URL. Le pipeline possono avere più criteri per gestire la modifica di ogni richiesta prima e dopo che è stata effettuata al server.

PipelineOptions

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

PipelinePolicy

I criteri della pipeline modificano una richiesta mentre passa attraverso la pipeline. È concettualmente un middleware autorizzato a modificare la richiesta prima che venga effettuata e alla risposta quando viene ricevuta.

PipelineRequest

Metadati relativi a una richiesta effettuata dalla pipeline.

PipelineRequestOptions

Impostazioni per inizializzare una richiesta. Quasi equivalente a Partial<PipelineRequest>, ma l'url è obbligatorio.

PipelineResponse

Metadati relativi a una risposta ricevuta dalla pipeline.

ProxySettings

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

RedirectPolicyOptions

Opzioni per la gestione delle risposte di reindirizzamento.

RestErrorOptions

Opzioni supportate da RestError.

SystemErrorRetryPolicyOptions

Opzioni che controllano come ripetere le richieste non riuscite.

TracingPolicyOptions

Opzioni per configurare i criteri di traccia.

UserAgentPolicyOptions

Opzioni per l'aggiunta dei dettagli dell'agente utente alle richieste in uscita.

Alias tipo

FormDataMap

Oggetto semplice che fornisce i dati del modulo, come se si trattasse di un modulo del browser.

FormDataValue

Ogni immissione di dati del modulo può essere una stringa o (nel browser) un BLOB.

HttpMethods

Metodi HTTP supportati da usare per l'esecuzione di richieste.

PipelinePhase

I criteri vengono eseguiti in fasi. L'ordine di esecuzione è:

  1. Fase di serializzazione
  2. Criteri non in una fase
  3. Fase deserializzazione
  4. Fase di ripetizione dei tentativi
RawHttpHeaders

Insieme HttpHeaders rappresentato come un semplice oggetto JSON.

RequestBodyType

Tipi di corpi supportati nella richiesta. NodeJS.ReadableStream è solo Node. Blob è solo browser.

SendRequest

Interfaccia semplice per l'esecuzione di una richiesta di pipeline e la ricezione di una risposta.

TransferProgressEvent

Generato in risposta allo stato di caricamento o download.

Funzioni

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Un criterio che può richiedere un token da un'implementazione tokenCredential e quindi applicarlo all'intestazione di autorizzazione di una richiesta come token di connessione.

createEmptyPipeline()

Crea una pipeline completamente vuota. Utile per il test o la creazione di un oggetto personalizzato.

createHttpHeaders(RawHttpHeaders)

Crea un oggetto che soddisfa l'interfaccia HttpHeaders.

createPipelineFromOptions(InternalPipelineOptions)

Creare una nuova pipeline con un set predefinito di criteri personalizzabili.

createPipelineRequest(PipelineRequestOptions)

Crea una nuova richiesta di pipeline con le opzioni specificate. Questo metodo consente di impostare facilmente i valori predefiniti e non è obbligatorio.

decompressResponsePolicy()

Criteri per abilitare la decompressione delle risposte in base all'intestazione Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Criteri che tentano di ripetere le richieste, introducendo un ritardo in aumento esponenziale.

formDataPolicy()

Criterio che codifica FormData nella richiesta nel corpo.

getDefaultProxySettings(string)

Questo metodo converte un URL proxy in ProxySettings da usare con ProxyPolicy. Se non viene specificato alcun argomento, tenta di analizzare un URL proxy dalle variabili di ambiente HTTPS_PROXY o HTTP_PROXY.

logPolicy(LogPolicyOptions)

Criteri che registrano tutte le richieste e le risposte.

ndJsonPolicy()

ndJsonPolicy è un criterio usato per controllare le impostazioni keep-alive per ogni richiesta.

proxyPolicy(ProxySettings)

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

redirectPolicy(RedirectPolicyOptions)

Criteri per seguire le intestazioni percorso dal server per supportare il reindirizzamento sul lato server.

setClientRequestIdPolicy(string)

Ogni PipelineRequest ottiene un ID univoco al momento della creazione. Questo criterio passa l'ID univoco tramite un'intestazione HTTP per consentire una migliore telemetria e traccia.

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Un criterio di ripetizione dei tentativi che cerca in particolare di gestire gli errori nel livello di trasporto sottostante ,ad esempio errori di ricerca DNS, anziché codici di errore riprovabili dal server stesso.

throttlingRetryPolicy()

Criterio che ritenta quando il server invia una risposta 429 con un'intestazione Retry-After.

Per altre informazioni, vedere 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 e https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

tracingPolicy(TracingPolicyOptions)

Un criterio semplice per creare intervalli OpenTelemetry per ogni richiesta effettuata dalla pipeline con SpanOptions con un elemento padre. Le richieste effettuate senza un intervallo padre non verranno registrate.

userAgentPolicy(UserAgentPolicyOptions)

Criterio che imposta l'intestazione User-Agent (o equivalente) in modo che rifletta la versione della libreria.

Variabili

bearerTokenAuthenticationPolicyName

L'identificatore programmatico della bearerTokenAuthenticationPolicy.

decompressResponsePolicyName

L'identificatore programmatico della decompressResponsePolicy.

expontentialRetryPolicyName

L'identificatore programmatico dell'esponenzialRetryPolicy.

formDataPolicyName

L'identificatore programmatico della formDataPolicy.

logPolicyName

L'identificatore programmatico del logPolicy.

ndJsonPolicyName

L'identificatore programmatico della ndJsonPolicy.

proxyPolicyName

L'identificatore programmatico del proxy Policy.

redirectPolicyName

L'identificatore programmatico del redirectPolicy.

setClientRequestIdPolicyName

L'identificatore programmatico della setClientRequestIdPolicy.

systemErrorRetryPolicyName

L'identificatore programmatico della policyErrorRetryPolicy.

throttlingRetryPolicyName

L'identificatore programmatico della throttlingRetryPolicy.

tracingPolicyName

L'identificatore programmatico del tracingPolicy.

userAgentPolicyName

L'identificatore programmatico dell'userAgentPolicy.

Dettagli funzione

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Un criterio che può richiedere un token da un'implementazione tokenCredential e quindi applicarlo all'intestazione di autorizzazione di una richiesta come token di connessione.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parametri

Restituisce

createEmptyPipeline()

Crea una pipeline completamente vuota. Utile per il test o la creazione di un oggetto personalizzato.

function createEmptyPipeline(): Pipeline

Restituisce

createHttpHeaders(RawHttpHeaders)

Crea un oggetto che soddisfa l'interfaccia HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

Parametri

rawHeaders
RawHttpHeaders

Oggetto semplice che rappresenta le intestazioni iniziali

Restituisce

createPipelineFromOptions(InternalPipelineOptions)

Creare una nuova pipeline con un set predefinito di criteri personalizzabili.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parametri

options
InternalPipelineOptions

Opzioni per configurare una pipeline personalizzata.

Restituisce

createPipelineRequest(PipelineRequestOptions)

Crea una nuova richiesta di pipeline con le opzioni specificate. Questo metodo consente di impostare facilmente i valori predefiniti e non è obbligatorio.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parametri

options
PipelineRequestOptions

Opzioni con cui creare la richiesta.

Restituisce

decompressResponsePolicy()

Criteri per abilitare la decompressione delle risposte in base all'intestazione Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Restituisce

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Criteri che tentano di ripetere le richieste, introducendo un ritardo in aumento esponenziale.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parametri

options
ExponentialRetryPolicyOptions

Opzioni che configurano la logica di ripetizione dei tentativi.

Restituisce

formDataPolicy()

Criterio che codifica FormData nella richiesta nel corpo.

function formDataPolicy(): PipelinePolicy

Restituisce

getDefaultProxySettings(string)

Questo metodo converte un URL proxy in ProxySettings da usare con ProxyPolicy. Se non viene specificato alcun argomento, tenta di analizzare un URL proxy dalle variabili di ambiente HTTPS_PROXY o HTTP_PROXY.

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

Parametri

proxyUrl

string

URL del proxy da usare. Può contenere informazioni di autenticazione.

Restituisce

ProxySettings | undefined

logPolicy(LogPolicyOptions)

Criteri che registrano tutte le richieste e le risposte.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parametri

options
LogPolicyOptions

Opzioni per configurare logPolicy.

Restituisce

ndJsonPolicy()

ndJsonPolicy è un criterio usato per controllare le impostazioni keep-alive per ogni richiesta.

function ndJsonPolicy(): PipelinePolicy

Restituisce

proxyPolicy(ProxySettings)

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

function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy

Parametri

proxySettings
ProxySettings

ProxySettings da usare in ogni richiesta.

Restituisce

redirectPolicy(RedirectPolicyOptions)

Criteri per seguire le intestazioni percorso dal server per supportare il reindirizzamento sul lato server.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametri

options
RedirectPolicyOptions

Opzioni per controllare il comportamento dei criteri.

Restituisce

setClientRequestIdPolicy(string)

Ogni PipelineRequest ottiene un ID univoco al momento della creazione. Questo criterio passa l'ID univoco tramite un'intestazione HTTP per consentire una migliore telemetria e traccia.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parametri

requestIdHeaderName

string

Nome dell'intestazione a cui passare l'ID della richiesta.

Restituisce

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Un criterio di ripetizione dei tentativi che cerca in particolare di gestire gli errori nel livello di trasporto sottostante ,ad esempio errori di ricerca DNS, anziché codici di errore riprovabili dal server stesso.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parametri

options
SystemErrorRetryPolicyOptions

Opzioni che personalizzano i criteri.

Restituisce

throttlingRetryPolicy()

Criterio che ritenta quando il server invia una risposta 429 con un'intestazione Retry-After.

Per altre informazioni, vedere 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 e https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): PipelinePolicy

Restituisce

tracingPolicy(TracingPolicyOptions)

Un criterio semplice per creare intervalli OpenTelemetry per ogni richiesta effettuata dalla pipeline con SpanOptions con un elemento padre. Le richieste effettuate senza un intervallo padre non verranno registrate.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parametri

options
TracingPolicyOptions

Opzioni per configurare i dati di telemetria registrati dai criteri di traccia.

Restituisce

userAgentPolicy(UserAgentPolicyOptions)

Criterio che imposta l'intestazione User-Agent (o equivalente) in modo che rifletta la versione della libreria.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parametri

options
UserAgentPolicyOptions

Opzioni per personalizzare il valore dell'agente utente.

Restituisce

Variable Details

bearerTokenAuthenticationPolicyName

L'identificatore programmatico della bearerTokenAuthenticationPolicy.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

Tipo

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

L'identificatore programmatico della decompressResponsePolicy.

decompressResponsePolicyName: "decompressResponsePolicy"

Tipo

"decompressResponsePolicy"

expontentialRetryPolicyName

L'identificatore programmatico dell'esponenzialRetryPolicy.

expontentialRetryPolicyName: "exponentialRetryPolicy"

Tipo

"exponentialRetryPolicy"

formDataPolicyName

L'identificatore programmatico della formDataPolicy.

formDataPolicyName: "formDataPolicy"

Tipo

"formDataPolicy"

logPolicyName

L'identificatore programmatico del logPolicy.

logPolicyName: "logPolicy"

Tipo

"logPolicy"

ndJsonPolicyName

L'identificatore programmatico della ndJsonPolicy.

ndJsonPolicyName: "ndJsonPolicy"

Tipo

"ndJsonPolicy"

proxyPolicyName

L'identificatore programmatico del proxy Policy.

proxyPolicyName: "proxyPolicy"

Tipo

"proxyPolicy"

redirectPolicyName

L'identificatore programmatico del redirectPolicy.

redirectPolicyName: "redirectPolicy"

Tipo

"redirectPolicy"

setClientRequestIdPolicyName

L'identificatore programmatico della setClientRequestIdPolicy.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

Tipo

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

L'identificatore programmatico della policyErrorRetryPolicy.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

Tipo

"systemErrorRetryPolicy"

throttlingRetryPolicyName

L'identificatore programmatico della throttlingRetryPolicy.

throttlingRetryPolicyName: "throttlingRetryPolicy"

Tipo

"throttlingRetryPolicy"

tracingPolicyName

L'identificatore programmatico del tracingPolicy.

tracingPolicyName: "tracingPolicy"

Tipo

"tracingPolicy"

userAgentPolicyName

L'identificatore programmatico dell'userAgentPolicy.

userAgentPolicyName: "userAgentPolicy"

Tipo

"userAgentPolicy"