Condividi tramite


@azure/core-rest-pipeline package

Classi

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.

Agent

Interfaccia compatibile con l'http.AgentnodeJS. Si vuole evitare di esportare pubblicamente l'interfaccia effettiva, perché può variare in base alle versioni di runtime.

AuthorizeRequestOnChallengeOptions

Opzioni inviate al callback authorizeRequestOnChallenge

AuthorizeRequestOptions

Opzioni inviate al callback authorizeRequest

AuxiliaryAuthenticationHeaderPolicyOptions

Opzioni per configurare ausiliariaAuthenticationHeaderPolicy

BearerTokenAuthenticationPolicyOptions

Opzioni per configurare bearerTokenAuthenticationPolicy

BodyPart

Parte del corpo della richiesta in una richiesta multipart.

ChallengeCallbacks

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

CreateFileFromStreamOptions

Opzioni aggiuntive per createFile quando viene passato un flusso.

CreateFileOptions

Opzioni passate in createFile specificando i metadati relativi al file.

DefaultRetryPolicyOptions

Opzioni che controllano come ripetere le richieste non riuscite.

ExponentialRetryPolicyOptions

Opzioni che controllano come ripetere 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 l'tls.KeyObjectnodeJS. Si vuole evitare di esportare pubblicamente l'interfaccia effettiva, perché può variare in base alle versioni di runtime.

LogPolicyOptions

Opzioni per configurare logPolicy.

MultipartRequestBody

Corpo della richiesta costituito da più parti.

Pipeline

Rappresenta una pipeline per l'esecuzione di una richiesta HTTP 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, ma l'URL è obbligatorio.

PipelineResponse

Metadati relativi a una risposta ricevuta dalla pipeline.

PipelineRetryOptions

Opzioni che controllano come ripetere le richieste non riuscite.

ProxySettings

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

PxfObject

Interfaccia compatibile con l'tls.PxfObjectnodeJS. Si vuole evitare di esportare pubblicamente l'interfaccia effettiva, perché può variare in base alle 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 il 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 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 voce di dati del modulo può essere una stringa, un BLOB o un file. Se si vuole passare un file con un nome ma non si ha accesso alla classe File, è possibile usare l'helper createFile per crearne uno.

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
  5. Fase di firma
RawHttpHeaders

Insieme HttpHeaders rappresentato come un semplice oggetto JSON.

RawHttpHeadersInput

Raccolta HttpHeaders per l'input, rappresentata 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 l'esecuzione di una richiesta di pipeline e la ricezione di una risposta.

TransferProgressEvent

Generato in risposta allo stato di caricamento o download.

Funzioni

agentPolicy(Agent)

Ottiene un criterio della pipeline che imposta http.agent

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 documentazione arm per un rundown del funzionamento di questa funzionalità

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.

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.

createFile(Uint8Array, string, CreateFileOptions)

Creare un oggetto che implementa l'interfaccia File. Questo oggetto deve essere passato a RequestBodyType.formData e non è garantito che funzioni come previsto in altre situazioni.

Utilizzare questa funzione per creare un oggetto File da utilizzare in RequestBodyType.formData in ambienti in cui l'oggetto File globale non è disponibile.

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

Creare un oggetto che implementa l'interfaccia File. Questo oggetto deve essere passato a RequestBodyType.formData e non è garantito che funzioni come previsto in altre situazioni.

Usare questa funzione per:

  • Creare un oggetto File da utilizzare in RequestBodyType.formData in ambienti in cui l'oggetto File globale non è disponibile.
  • Creare un oggetto simile a File da un flusso leggibile senza leggere il flusso in memoria.
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)

Un criterio 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 ha esito negativo, verrà eseguito un nuovo tentativo con un ritardo in aumento esponenziale.
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.

isRestError(unknown)

Typeguard per RestError

logPolicy(LogPolicyOptions)

Criteri che registrano tutte le richieste e le risposte.

multipartPolicy()

Criteri di pipeline per le richieste multipart

ndJsonPolicy()

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

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

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. 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 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(ThrottlingRetryPolicyOptions)

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

Per altre informazioni, vedere https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits e https://learn.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)

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

Dettagli funzione

agentPolicy(Agent)

Ottiene un criterio della pipeline che imposta http.agent

function agentPolicy(agent?: Agent): PipelinePolicy

Parametri

agent
Agent

Restituisce

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 documentazione arm per un rundown del funzionamento di questa funzionalità

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parametri

Restituisce

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

createDefaultHttpClient()

Creare il valore HttpClient corretto per l'ambiente corrente.

function createDefaultHttpClient(): HttpClient

Restituisce

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

Restituisce

createFile(Uint8Array, string, CreateFileOptions)

Creare un oggetto che implementa l'interfaccia File. Questo oggetto deve essere passato a RequestBodyType.formData e non è garantito che funzioni come previsto in altre situazioni.

Utilizzare questa funzione per creare un oggetto File da utilizzare in RequestBodyType.formData in ambienti in cui l'oggetto File globale non è disponibile.

function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File

Parametri

content

Uint8Array

contenuto del file come Uint8Array in memoria.

name

string

nome del file.

options
CreateFileOptions

metadati facoltativi relativi al file, ad esempio nome file, dimensioni del file, tipo MIME.

Restituisce

File

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

Creare un oggetto che implementa l'interfaccia File. Questo oggetto deve essere passato a RequestBodyType.formData e non è garantito che funzioni come previsto in altre situazioni.

Usare questa funzione per:

  • Creare un oggetto File da utilizzare in RequestBodyType.formData in ambienti in cui l'oggetto File globale non è disponibile.
  • Creare un oggetto simile a File da un flusso leggibile senza leggere il flusso in memoria.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File

Parametri

stream

() => ReadableStream<Uint8Array> | ReadableStream

il contenuto del file come callback che restituisce un flusso. Quando un oggetto File creato tramite createFile viene passato nella mappa dei dati del modulo di una richiesta, il flusso non verrà letto in memoria e verrà invece trasmesso quando viene effettuata la richiesta. In caso di nuovo tentativo, il flusso deve essere letto di nuovo, quindi questo callback DOVREBBE restituire un nuovo flusso, se possibile.

name

string

nome del file.

options
CreateFileFromStreamOptions

metadati facoltativi relativi al file, ad esempio nome file, dimensioni del file, tipo MIME.

Restituisce

File

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

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

defaultRetryPolicy(DefaultRetryPolicyOptions)

Un criterio 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 ha esito negativo, verrà eseguito un nuovo tentativo con un ritardo in aumento esponenziale.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parametri

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)

Avviso

Questa API è ora deprecata.

  • Internally this method is no longer necessary when setting proxy information.

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

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e

Parametri

e

unknown

Un elemento rilevato 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

multipartPolicy()

Criteri di pipeline per le richieste multipart

function multipartPolicy(): PipelinePolicy

Restituisce

ndJsonPolicy()

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

function ndJsonPolicy(): PipelinePolicy

Restituisce

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

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

redirectPolicy(RedirectPolicyOptions)

Criteri per seguire le intestazioni percorso dal server per supportare il reindirizzamento sul 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

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[]

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(ThrottlingRetryPolicyOptions)

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

Per altre informazioni, vedere https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits e https://learn.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

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

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