@azure/core-rest-pipeline package

Třídy

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

Rozhraní

AddPipelineOptions	Možnosti při přidávání zásad do kanálu Používá se k vyjádření závislostí na jiných zásadách.
Agent	Rozhraní kompatibilní se službou NodeJS http.Agent Chceme se vyhnout veřejnému opětovnému exportu skutečného rozhraní, protože se může lišit v různých verzích modulu runtime.
AuthorizeRequestOnChallengeOptions	Možnosti odeslané do zpětného volání authorizeRequestOnChallenge
AuthorizeRequestOptions	Možnosti odeslané do zpětného volání authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Možnosti konfigurace auxiliaryAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Možnosti konfigurace bearerTokenAuthenticationPolicy
ChallengeCallbacks	Možnosti přepsání zpracování problémů s průběžným vyhodnocováním přístupu
DefaultRetryPolicyOptions	Možnosti, které určují, jak opakovat neúspěšné žádosti.
ExponentialRetryPolicyOptions	Možnosti, které určují, jak opakovat neúspěšné žádosti.
HttpClient	Požadované rozhraní pro klienta, který provádí požadavky HTTP jménem kanálu.
HttpHeaders	Představuje sadu hlaviček HTTP na požadavek/odpověď. Názvy hlaviček se považují za nerozlišující malá a malá písmena.
InternalPipelineOptions	Definuje možnosti, které se používají ke konfiguraci interních možností kanálu HTTP pro klienta sady SDK.
KeyObject	Rozhraní kompatibilní se službou NodeJS tls.KeyObject Chceme se vyhnout veřejnému opětovnému exportu skutečného rozhraní, protože se může lišit v různých verzích modulu runtime.
LogPolicyOptions	Možnosti konfigurace logPolicy
Pipeline	Představuje kanál pro vytvoření požadavku HTTP na adresu URL. Kanály můžou mít několik zásad pro správu manipulace s jednotlivými požadavky před a po jeho provedení na server.
PipelineOptions	Definuje možnosti, které se používají ke konfiguraci kanálu HTTP pro klienta sady SDK.
PipelinePolicy	Zásady kanálu manipulují s požadavkem, který prochází kanálem. Je to koncepčně middleware, který může upravit požadavek před jeho provedením a také odpověď při jeho přijetí.
PipelineRequest	Metadata o požadavku vytvořeném kanálem
PipelineRequestOptions	Nastavení pro inicializaci požadavku. Téměř ekvivalentní částečnému, ale adresa URL je povinná.
PipelineResponse	Metadata o odpovědi přijaté kanálem
PipelineRetryOptions	Možnosti, které určují, jak opakovat neúspěšné žádosti.
ProxySettings	Možnosti konfigurace proxy pro odchozí požadavky (pouze Node.js)
PxfObject	Rozhraní kompatibilní se službou NodeJS tls.PxfObject Chceme se vyhnout veřejnému opětovnému exportu skutečného rozhraní, protože se může lišit v různých verzích modulu runtime.
RedirectPolicyOptions	Možnosti zpracování odpovědí přesměrování
RestErrorOptions	Možnosti podporované chybou RestError.
RetryInformation	Informace poskytnuté strategii opakování o aktuálním průběhu zásad opakování.
RetryModifiers	Vlastnosti, které mohou změnit chování zásad opakování.
RetryPolicyOptions	Možnosti retryPolicy
RetryStrategy	Cílem strategie opakování je definovat, jestli se má opakovat nebo ne, a způsob opakování.
SystemErrorRetryPolicyOptions	Možnosti, které určují, jak opakovat neúspěšné žádosti.
TelemetryOptions	Definuje možnosti, které se používají ke konfiguraci běžných telemetrických a trasovacích informací.
ThrottlingRetryPolicyOptions	Možnosti, které určují, jak opakovat neúspěšné žádosti.
TlsSettings	Představuje certifikát pro ověřování TLS.
TracingPolicyOptions	Možnosti konfigurace zásad trasování
UserAgentPolicyOptions	Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům

Aliasy typu

FormDataMap	Jednoduchý objekt, který poskytuje data formuláře, jako by byl z formuláře prohlížeče.
FormDataValue	Každá položka dat formuláře může být řetězec nebo (v prohlížeči) objekt blob.
HttpMethods	Podporované metody HTTP, které se používají při vytváření požadavků.
PipelinePhase	Zásady se spouštějí ve fázích. Příkaz ke spuštění je: Fáze serializace Zásady, které nejsou ve fázi Fáze deserializace Fáze opakování Fáze podpisu
RawHttpHeaders	Kolekce HttpHeaders reprezentovaná jako jednoduchý objekt JSON.
RawHttpHeadersInput	Kolekce HttpHeaders pro vstup, reprezentovaná jako jednoduchý objekt JSON.
RequestBodyType	Typy subjektů podporovaných v žádosti NodeJS.ReadableStream a () => NodeJS.ReadableStream je pouze Node. Objekty blob, ReadableStream a () => ReadableStream jsou jenom v prohlížeči.
SendRequest	Jednoduché rozhraní pro vytvoření požadavku kanálu a příjem odpovědi.
TransferProgressEvent	Aktivováno v reakci na průběh nahrávání nebo stahování.

Funkce

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Zásada pro externí tokeny pro hlavičku x-ms-authorization-auxiliary . Tato hlavička se použije při vytváření aplikace mezi tenanty, kterou možná budeme potřebovat ke zpracování žádostí o ověření pro prostředky, které jsou v různých tenantech. Přehled toho, jak tato funkce funguje, najdete v dokumentaci k ARM .
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Zásada, která může požadovat token z implementace TokenCredential a pak ho použít na autorizační hlavičku požadavku jako nosný token.
createDefaultHttpClient()	Vytvořte správný HttpClient pro aktuální prostředí.
createEmptyPipeline()	Vytvoří zcela prázdný kanál. Užitečné pro testování nebo vytvoření vlastního.
createHttpHeaders(RawHttpHeadersInput)	Vytvoří objekt, který splňuje HttpHeaders rozhraní.
createPipelineFromOptions(InternalPipelineOptions)	Vytvořte nový kanál s výchozí sadou přizpůsobitelných zásad.
createPipelineRequest(PipelineRequestOptions)	Vytvoří novou žádost kanálu s danými možnostmi. Tato metoda umožňuje snadné nastavení výchozích hodnot, které nejsou povinné.
decompressResponsePolicy()	Zásada umožňující dekompresi odpovědi podle hlavičky Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Zásada, která opakuje tři strategie: Když server odešle odpověď 429 s hlavičkou Retry-After. Pokud dojde k chybám v podkladové přenosové vrstvě (např. selhání vyhledávání DNS). Pokud odchozí požadavek selže, zkusí to znovu s exponenciálně se zvyšujícím zpožděním.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Zásada, která se pokouší opakovat požadavky a současně zavádí exponenciálně se zvyšující zpoždění.
formDataPolicy()	Zásada, která zakóduje FormData v požadavku do textu.
getDefaultProxySettings(string)	Tato metoda převede adresu URL proxy serveru na ProxySettings pro použití s ProxyPolicy. Pokud není zadaný žádný argument, pokusí se parsovat adresu URL proxy serveru z proměnných HTTPS_PROXY prostředí nebo HTTP_PROXY.
isRestError(unknown)	Typeguard pro RestError
logPolicy(LogPolicyOptions)	Zásada, která protokoluje všechny požadavky a odpovědi.
ndJsonPolicy()	ndJsonPolicy je zásada, která slouží k řízení nastavení zachování živého přístupu pro každý požadavek.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Zásada, která umožňuje použít nastavení proxy serveru pro všechny požadavky. Pokud se nepředá statická nastavení, načtou se z HTTPS_PROXY nebo HTTP_PROXY proměnných prostředí.
redirectPolicy(RedirectPolicyOptions)	Zásady, které se mají řídit hlavičkami umístění ze serveru, aby bylo možné podporovat přesměrování na straně serveru. V prohlížeči se tato zásada nepoužívá.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy je obecná zásada umožňující opakování požadavků při splnění určitých podmínek.
setClientRequestIdPolicy(string)	Každý PipelineRequest získá při vytvoření jedinečné ID. Tato zásada předává toto jedinečné ID prostřednictvím hlavičky HTTP, aby bylo možné lépe sledovat telemetrii a trasování.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Zásady opakování, které se konkrétně snaží zpracovat chyby v podkladové přenosové vrstvě (např. selhání vyhledávání DNS) místo opakování kódů chyb ze samotného serveru.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Zásada, která se opakuje, když server odešle odpověď 429 s hlavičkou Retry-After. Další informace najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitsa 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)	Získá zásadu kanálu, která přidá klientský certifikát do agenta HttpClient pro ověřování.
tracingPolicy(TracingPolicyOptions)	Jednoduchá zásada pro vytvoření OpenTelemetry Spans pro každý požadavek provedený kanálem, který má SpanOptions s nadřazeným objektem. Žádosti provedené bez nadřazeného rozsahu se nebudou zaznamenávat.
userAgentPolicy(UserAgentPolicyOptions)	Zásada, která nastaví hlavičku User-Agent (nebo ekvivalent) tak, aby odrážela verzi knihovny.

Podrobnosti funkce

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Zásada pro externí tokeny pro hlavičku x-ms-authorization-auxiliary . Tato hlavička se použije při vytváření aplikace mezi tenanty, kterou možná budeme potřebovat ke zpracování žádostí o ověření pro prostředky, které jsou v různých tenantech. Přehled toho, jak tato funkce funguje, najdete v dokumentaci k ARM .

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parametry

options

AuxiliaryAuthenticationHeaderPolicyOptions

Návraty

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Zásada, která může požadovat token z implementace TokenCredential a pak ho použít na autorizační hlavičku požadavku jako nosný token.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parametry

options

BearerTokenAuthenticationPolicyOptions

Návraty

PipelinePolicy

createDefaultHttpClient()

Vytvořte správný HttpClient pro aktuální prostředí.

function createDefaultHttpClient(): HttpClient

Návraty

HttpClient

createEmptyPipeline()

Vytvoří zcela prázdný kanál. Užitečné pro testování nebo vytvoření vlastního.

function createEmptyPipeline(): Pipeline

Návraty

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Vytvoří objekt, který splňuje HttpHeaders rozhraní.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parametry

rawHeaders

RawHttpHeadersInput

Jednoduchý objekt představující počáteční hlavičky

Návraty

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Vytvořte nový kanál s výchozí sadou přizpůsobitelných zásad.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parametry

options

InternalPipelineOptions

Možnosti konfigurace vlastního kanálu

Návraty

Pipeline

createPipelineRequest(PipelineRequestOptions)

Vytvoří novou žádost kanálu s danými možnostmi. Tato metoda umožňuje snadné nastavení výchozích hodnot, které nejsou povinné.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parametry

options

PipelineRequestOptions

Možnosti pro vytvoření požadavku pomocí.

Návraty

PipelineRequest

decompressResponsePolicy()

Zásada umožňující dekompresi odpovědi podle hlavičky Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Návraty

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Zásada, která opakuje tři strategie:

• Když server odešle odpověď 429 s hlavičkou Retry-After.
• Pokud dojde k chybám v podkladové přenosové vrstvě (např. selhání vyhledávání DNS).
• Pokud odchozí požadavek selže, zkusí to znovu s exponenciálně se zvyšujícím zpožděním.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parametry

options

DefaultRetryPolicyOptions

Návraty

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Zásada, která se pokouší opakovat požadavky a současně zavádí exponenciálně se zvyšující zpoždění.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parametry

options

ExponentialRetryPolicyOptions

Možnosti, které konfiguruje logiku opakování.

Návraty

PipelinePolicy

formDataPolicy()

Zásada, která zakóduje FormData v požadavku do textu.

function formDataPolicy(): PipelinePolicy

Návraty

PipelinePolicy

getDefaultProxySettings(string)

Tato metoda převede adresu URL proxy serveru na ProxySettings pro použití s ProxyPolicy. Pokud není zadaný žádný argument, pokusí se parsovat adresu URL proxy serveru z proměnných HTTPS_PROXY prostředí nebo HTTP_PROXY.

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

Parametry

proxyUrl

string

Adresa URL proxy serveru, který se má použít. Může obsahovat ověřovací informace.

Návraty

ProxySettings | undefined

isRestError(unknown)

Typeguard pro RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Něco zachyceného klauzulí catch.

Návraty

e

logPolicy(LogPolicyOptions)

Zásada, která protokoluje všechny požadavky a odpovědi.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parametry

options

LogPolicyOptions

Možnosti konfigurace logPolicy

Návraty

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy je zásada, která slouží k řízení nastavení zachování živého přístupu pro každý požadavek.

function ndJsonPolicy(): PipelinePolicy

Návraty

PipelinePolicy

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

Zásada, která umožňuje použít nastavení proxy serveru pro všechny požadavky. Pokud se nepředá statická nastavení, načtou se z HTTPS_PROXY nebo HTTP_PROXY proměnných prostředí.

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

Parametry

proxySettings

ProxySettings

ProxySettings, které se mají použít u každého požadavku.

options

{ customNoProxyList?: string[] }

další nastavení, například vlastní vzory NO_PROXY

Návraty

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Zásady, které se mají řídit hlavičkami umístění ze serveru, aby bylo možné podporovat přesměrování na straně serveru. V prohlížeči se tato zásada nepoužívá.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametry

options

RedirectPolicyOptions

Možnosti řízení chování zásad

Návraty

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy je obecná zásada umožňující opakování požadavků při splnění určitých podmínek.

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

Parametry

strategies

RetryStrategy[]

options

RetryPolicyOptions

Návraty

PipelinePolicy

setClientRequestIdPolicy(string)

Každý PipelineRequest získá při vytvoření jedinečné ID. Tato zásada předává toto jedinečné ID prostřednictvím hlavičky HTTP, aby bylo možné lépe sledovat telemetrii a trasování.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parametry

requestIdHeaderName

string

Název hlavičky, do které se má předat ID požadavku.

Návraty

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Zásady opakování, které se konkrétně snaží zpracovat chyby v podkladové přenosové vrstvě (např. selhání vyhledávání DNS) místo opakování kódů chyb ze samotného serveru.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parametry

options

SystemErrorRetryPolicyOptions

Možnosti, které přizpůsobí zásadu.

Návraty

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Zásada, která se opakuje, když server odešle odpověď 429 s hlavičkou Retry-After.

Další informace najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitsa 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

Parametry

options

ThrottlingRetryPolicyOptions

Možnosti, které konfiguruje logiku opakování.

Návraty

PipelinePolicy

tlsPolicy(TlsSettings)

Získá zásadu kanálu, která přidá klientský certifikát do agenta HttpClient pro ověřování.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parametry

tlsSettings

TlsSettings

Návraty

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Jednoduchá zásada pro vytvoření OpenTelemetry Spans pro každý požadavek provedený kanálem, který má SpanOptions s nadřazeným objektem. Žádosti provedené bez nadřazeného rozsahu se nebudou zaznamenávat.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parametry

options

TracingPolicyOptions

Možnosti konfigurace telemetrie protokolované zásadou trasování

Návraty

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Zásada, která nastaví hlavičku User-Agent (nebo ekvivalent) tak, aby odrážela verzi knihovny.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parametry

options

UserAgentPolicyOptions

Možnosti přizpůsobení hodnoty uživatelského agenta

Návraty

PipelinePolicy