Condividi tramite

@azure/core-rest-pipeline package

  • Riferimento

Classi

RestError

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

Interfacce

AddPipelineOptions

Opzioni quando si aggiunge un criterio alla pipeline. Usato per esprimere le dipendenze su altri criteri.
Agent

Interfaccia compatibile con NodeJS.http.Agent Si vuole evitare di esportare pubblicamente l'interfaccia effettiva, poiché potrebbe variare tra le versioni di runtime.
AuthorizeRequestOnChallengeOptions

Opzioni inviate al callback di authorizeRequestOnChallenge
AuthorizeRequestOptions

Opzioni inviate al callback di authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions

Opzioni per configurare l'assistenteAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions

Opzioni per configurare il bearerTokenAuthenticationPolicy
ChallengeCallbacks

Opzioni per eseguire l'override dell'elaborazione dei problemi di valutazione dell'accesso continuo .
DefaultRetryPolicyOptions

Opzioni che controllano come riprovare le richieste non riuscite.
ExponentialRetryPolicyOptions

Opzioni che controllano come riprovare le richieste non riuscite.
HttpClient

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

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

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

Interfaccia compatibile con NodeJS.tls.KeyObject Si vuole evitare di esportare pubblicamente l'interfaccia effettiva, poiché potrebbe variare tra le versioni di runtime.
LogPolicyOptions

Opzioni per configurare logPolicy.
Pipeline

Rappresenta una pipeline per effettuare una richiesta HTTP a un URL. Le pipeline possono avere più criteri per gestire la modifica di ogni richiesta prima e dopo che viene effettuata nel server.
PipelineOptions

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

Un criterio della pipeline modifica una richiesta durante il viaggio attraverso la pipeline. È concettualmente un middleware che consente di modificare la richiesta prima che venga effettuata e la risposta quando viene ricevuta.
PipelineRequest

Metadati relativi a una richiesta effettuata dalla pipeline.
PipelineRequestOptions

Impostazioni per inizializzare una richiesta. Quasi equivalente a Parziale, ma l'URL è obbligatorio.
PipelineResponse

Metadati relativi a una risposta ricevuta dalla pipeline.
PipelineRetryOptions

Opzioni che controllano come riprovare le richieste non riuscite.
ProxySettings

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

Interfaccia compatibile con nodeJS.tls.PxfObject Si vuole evitare di esportare pubblicamente l'interfaccia effettiva, perché può variare tra le versioni di runtime.
RedirectPolicyOptions

Opzioni per la gestione delle risposte di reindirizzamento.
RestErrorOptions

Opzioni supportate da RestError.
RetryInformation

Informazioni fornite alla strategia di ripetizione dei tentativi sull'avanzamento corrente dei criteri di ripetizione dei tentativi.
RetryModifiers

Proprietà che possono modificare il comportamento dei criteri di ripetizione dei tentativi.
RetryPolicyOptions

Opzioni per retryPolicy
RetryStrategy

Una strategia di ripetizione dei tentativi è destinata a definire se riprovare o meno e come riprovare.
SystemErrorRetryPolicyOptions

Opzioni che controllano come ripetere le richieste non riuscite.
TelemetryOptions

Definisce le opzioni usate per configurare i dati di telemetria e le informazioni di traccia comuni
ThrottlingRetryPolicyOptions

Opzioni che controllano come ripetere le richieste non riuscite.
TlsSettings

Rappresenta un certificato per l'autenticazione TLS.
TracingPolicyOptions

Opzioni per configurare i criteri di traccia.
UserAgentPolicyOptions

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

Alias tipo

FormDataMap

Oggetto semplice che fornisce dati del modulo, come se da un modulo del browser.
FormDataValue

Ogni voce 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 in nessuna fase
  3. Fase di deserializzazione
  4. Fase di ripetizione dei tentativi
  5. Fase di firma
RawHttpHeaders

Insieme HttpHeaders rappresentato come un semplice oggetto JSON.
RawHttpHeadersInput

Insieme HttpHeaders per l'input, rappresentato come un semplice oggetto JSON.
RequestBodyType

Tipi di corpi supportati nella richiesta. NodeJS.ReadableStream e () => NodeJS.ReadableStream è solo Node. BLOB, ReadableStream e () => ReadableStream sono solo browser.
SendRequest

Interfaccia semplice per effettuare una richiesta di pipeline e ricevere una risposta.
TransferProgressEvent

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

Funzioni

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Criteri per i token esterni da x-ms-authorization-auxiliary intestazione. Questa intestazione verrà usata durante la creazione di un'applicazione tra tenant, potrebbe essere necessario gestire le richieste di autenticazione per le risorse presenti in tenant diversi. È possibile visualizzare la documentazione arm per un rundown del funzionamento di questa funzionalità
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Criteri che possono richiedere un token da un'implementazione tokenCredential e quindi applicarlo all'intestazione Authorization di una richiesta come token di connessione.
createDefaultHttpClient()

Creare il valore HttpClient corretto per l'ambiente corrente.
createEmptyPipeline()

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

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
defaultRetryPolicy(DefaultRetryPolicyOptions)

Una politica che ritenta in base a tre strategie:

  • Quando il server invia una risposta 429 con un'intestazione Retry-After.
  • In caso di errori nel livello di trasporto sottostante ,ad esempio errori di ricerca DNS.
  • In caso contrario, se la richiesta in uscita non riesce, verrà eseguito un nuovo tentativo con un ritardo che aumenta in modo esponenziale.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Criteri che tentano di ripetere le richieste, introducendo un ritardo che aumenta in modo 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 HTTPS_PROXY di ambiente o HTTP_PROXY.
isRestError(unknown)

Typeguard per RestError
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, { customNoProxyList?: string[] })

Criteri che consentono 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 da seguire per le intestazioni location dal server per supportare il reindirizzamento lato server. Nel browser questo criterio non viene usato.
retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy è un criterio generico per abilitare le richieste di ripetizione dei tentativi quando vengono soddisfatte determinate condizioni
setClientRequestIdPolicy(string)

Ogni PipelineRequest ottiene un ID univoco al momento della creazione. Questo criterio passa l'ID univoco tramite un'intestazione HTTP per abilitare dati di telemetria e traccia migliori.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Criteri di ripetizione dei tentativi che cercano in modo specifico di gestire gli errori nel livello di trasporto sottostante ,ad esempio errori di ricerca DNS, anziché codici di errore riprovabili dal server stesso.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

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

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
tlsPolicy(TlsSettings)

Ottiene un criterio della pipeline che aggiunge il certificato client all'agente HttpClient per l'autenticazione.
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)

Criteri che impostano l'intestazione User-Agent (o equivalente) per riflettere la versione della libreria.

Dettagli funzione

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Criteri per i token esterni da x-ms-authorization-auxiliary intestazione. Questa intestazione verrà usata durante la creazione di un'applicazione tra tenant, potrebbe essere necessario gestire le richieste di autenticazione per le risorse presenti in tenant diversi. È possibile visualizzare la documentazione arm per un rundown del funzionamento di questa funzionalità

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parametri

options
AuxiliaryAuthenticationHeaderPolicyOptions

Restituisce

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Criteri che possono richiedere un token da un'implementazione tokenCredential e quindi applicarlo all'intestazione Authorization di una richiesta come token di connessione.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parametri

options
BearerTokenAuthenticationPolicyOptions

Restituisce

PipelinePolicy

createDefaultHttpClient()

Creare il valore HttpClient corretto per l'ambiente corrente.

function createDefaultHttpClient(): HttpClient

Restituisce

HttpClient

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

Restituisce

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Crea un oggetto che soddisfa l'interfaccia HttpHeaders .

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parametri

rawHeaders
RawHttpHeadersInput

Oggetto semplice che rappresenta le intestazioni iniziali

Restituisce

HttpHeaders

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

Pipeline

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

PipelineRequest

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

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Una politica che ritenta in base a tre strategie:

  • Quando il server invia una risposta 429 con un'intestazione Retry-After.
  • In caso di errori nel livello di trasporto sottostante ,ad esempio errori di ricerca DNS.
  • In caso contrario, se la richiesta in uscita non riesce, verrà eseguito un nuovo tentativo con un ritardo che aumenta in modo esponenziale.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parametri

options
DefaultRetryPolicyOptions

Restituisce

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

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

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parametri

options
ExponentialRetryPolicyOptions

Opzioni che configurano la logica di ripetizione dei tentativi.

Restituisce

PipelinePolicy

formDataPolicy()

Criterio che codifica FormData nella richiesta nel corpo.

function formDataPolicy(): PipelinePolicy

Restituisce

PipelinePolicy

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 HTTPS_PROXY di ambiente 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

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e

Parametri

e

unknown

Un elemento intercettato da una clausola catch.

Restituisce

e

logPolicy(LogPolicyOptions)

Criteri che registrano tutte le richieste e le risposte.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parametri

options
LogPolicyOptions

Opzioni per configurare logPolicy.

Restituisce

PipelinePolicy

ndJsonPolicy()

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

function ndJsonPolicy(): PipelinePolicy

Restituisce

PipelinePolicy

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

Criteri che consentono 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, options?: { customNoProxyList?: string[] }): PipelinePolicy

Parametri

proxySettings
ProxySettings

ProxySettings da usare in ogni richiesta.

options

{ customNoProxyList?: string[] }

impostazioni aggiuntive, ad esempio modelli di NO_PROXY personalizzati

Restituisce

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Criteri da seguire per le intestazioni location dal server per supportare il reindirizzamento lato server. Nel browser questo criterio non viene usato.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametri

options
RedirectPolicyOptions

Opzioni per controllare il comportamento dei criteri.

Restituisce

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy è un criterio generico per abilitare le richieste di ripetizione dei tentativi quando vengono soddisfatte determinate condizioni

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

Parametri

strategies

RetryStrategy[]

options
RetryPolicyOptions

Restituisce

PipelinePolicy

setClientRequestIdPolicy(string)

Ogni PipelineRequest ottiene un ID univoco al momento della creazione. Questo criterio passa l'ID univoco tramite un'intestazione HTTP per abilitare dati di telemetria e traccia migliori.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parametri

requestIdHeaderName

string

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

Restituisce

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Criteri di ripetizione dei tentativi che cercano in modo specifico 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

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

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

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(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parametri

options
ThrottlingRetryPolicyOptions

Opzioni che configurano la logica di ripetizione dei tentativi.

Restituisce

PipelinePolicy

tlsPolicy(TlsSettings)

Ottiene un criterio della pipeline che aggiunge il certificato client all'agente HttpClient per l'autenticazione.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parametri

tlsSettings
TlsSettings

Restituisce

PipelinePolicy

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

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Criteri che impostano l'intestazione User-Agent (o equivalente) per riflettere la versione della libreria.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parametri

options
UserAgentPolicyOptions

Opzioni per personalizzare il valore dell'agente utente.

Restituisce

PipelinePolicy