@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í s http.AgentNodeJS . 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é zpětná volání authorizeRequestOnChallenge
AuthorizeRequestOptions	Možnosti odeslané do zpětného volání authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Možnosti konfigurace pomocných zásadAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Možnosti konfigurace bearerTokenAuthenticationPolicy
BodyPart	Část textu požadavku v požadavku s více částmi.
ChallengeCallbacks	Možnosti přepsání zpracování průběžného vyhodnocování přístupu.
CreateFileFromStreamOptions	Další možnosti pro createFile při předávání datového proudu.
CreateFileOptions	Možnosti předané do souboru createFile určující metadata o souboru.
DefaultRetryPolicyOptions	Možnosti, které řídí, jak opakovat neúspěšné požadavky.
ExponentialRetryPolicyOptions	Možnosti, které řídí, jak opakovat neúspěšné požadavky.
HttpClient	Požadované rozhraní pro klienta, který provádí požadavky HTTP jménem kanálu.
HttpHeaders	Představuje sadu hlaviček HTTP v požadavku nebo odpovědi. Názvy hlaviček se považují za nerozlišující malá a velká 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í s tls.KeyObjectNodeJS . 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
MultipartRequestBody	Text požadavku skládající se z více částí
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 při procházení kanálem. Jedná se o koncepční middleware, který může požadavek před provedením upravit, a také odpověď při 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é řídí, jak opakovat neúspěšné požadavky.
ProxySettings	Možnosti konfigurace proxy serveru pro odchozí požadavky (pouzeNode.js).
PxfObject	Rozhraní kompatibilní s tls.PxfObjectNodeJS . 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í na přesměrování
RestErrorOptions	Možnosti podporované chybou RestError.
RetryInformation	Informace poskytnuté strategii opakování týkající se aktuálního průběhu zásady opakování.
RetryModifiers	Vlastnosti, které mohou změnit chování zásady opakování.
RetryPolicyOptions	Možnosti retryPolicy
RetryStrategy	Strategie opakování je určená k definování, jestli se má opakovat nebo ne, a postup opakování.
SystemErrorRetryPolicyOptions	Možnosti, které řídí, jak opakovat neúspěšné požadavky.
TelemetryOptions	Definuje možnosti, které se používají ke konfiguraci běžných telemetrických a trasovacích informací.
ThrottlingRetryPolicyOptions	Možnosti, které řídí, jak opakovat neúspěšné požadavky.
TlsSettings	Představuje certifikát pro ověřování TLS.
TracingPolicyOptions	Možnosti konfigurace zásad trasování
UserAgentPolicyOptions	Možnosti přidání podrobností o uživatelském agentu do odchozích požadavků

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, objekt blob nebo soubor. Pokud chcete předat soubor s názvem, ale nemáte přístup ke třídě File, můžete ho vytvořit pomocí pomocné rutiny createFile.
HttpMethods	Podporované metody HTTP, které se používají při provádění požadavků.
PipelinePhase	Zásady se provádějí ve fázích. Pořadí provádě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 na žádosti. NodeJS.ReadableStream a () => NodeJS.ReadableStream je pouze Uzel. Objekty blob, ReadableStream a () => ReadableStream jsou pouze prohlížečem.
SendRequest	Jednoduché rozhraní pro vytvoření požadavku kanálu a přijetí odpovědi.
TransferProgressEvent	Aktivovalo se v reakci na průběh nahrávání nebo stahování.

Funkce

agentPolicy(Agent)	Získá zásadu kanálu, která nastavuje http.agent
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Zásady pro externí tokeny pro x-ms-authorization-auxiliary hlavičku. Tato hlavička se použije při vytváření aplikace mezi tenanty, které možná budeme muset zpracovat žádosti o ověření pro prostředky, které jsou v různých tenantech. Můžete se podívat na dokumentaci ARM, kde najdete přehled toho, jak tato funkce funguje.
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Zásada, která může vyžádat token z implementace TokenCredential a pak ji 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.
createFile(Uint8Array, string, CreateFileOptions)	Vytvořte objekt, který implementuje rozhraní File. Tento objekt je určen k předání do RequestBodyType.formData a není zaručeno, že bude fungovat podle očekávání v jiných situacích. Tuto funkci použijte k vytvoření objektu File pro použití v RequestBodyType.formData v prostředích, kde globální objekt File není k dispozici.
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)	Vytvořte objekt, který implementuje rozhraní File. Tento objekt je určen k předání do RequestBodyType.formData a není zaručeno, že bude fungovat podle očekávání v jiných situacích. Pomocí této funkce můžete: Vytvořte objekt File pro použití v RequestBodyType.formData v prostředích, kde globální objekt File není k dispozici. Vytvořte objekt podobný souboru z čitelného datového proudu bez čtení datového proudu do paměti.
createHttpHeaders(RawHttpHeadersInput)	Vytvoří objekt, který splňuje rozhraní HttpHeaders.
createPipelineFromOptions(InternalPipelineOptions)	Vytvořte nový kanál s výchozí sadou přizpůsobitelných zásad.
createPipelineRequest(PipelineRequestOptions)	Vytvoří nový požadavek kanálu s danými možnostmi. Tato metoda umožňuje snadné nastavení výchozích hodnot a nevyžaduje se.
decompressResponsePolicy()	Zásada umožňující dekompresi odpovědí podle Accept-Encoding hlavičky https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Zásada, která se opakuje v souladu se třemi strategiemi: Když server odešle odpověď 429 s hlavičkou Retry-After. Pokud v podkladové přenosové vrstvě dojde k chybám (např. selhání vyhledávání DNS). Jinak pokud odchozí požadavek selže, zkusí se to znovu s exponenciálním zpožděním.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Zásada, která se pokusí opakovat požadavky při zavádění exponenciálně rostoucího zpoždění.
formDataPolicy()	Zásada, která kóduje FormData na požadavku do textu.
getDefaultProxySettings(string)	Tato metoda převede adresu URL proxy serveru na ProxySettings pro použití s ProxyPolicy. Pokud žádný argument není zadaný, pokusí se analyzovat adresu URL proxy serveru z proměnných prostředí HTTPS_PROXY nebo HTTP_PROXY.
isRestError(unknown)	Typeguard pro RestError
logPolicy(LogPolicyOptions)	Zásada, která protokoluje všechny požadavky a odpovědi.
multipartPolicy()	Zásady kanálu pro žádosti o více částí
ndJsonPolicy()	ndJsonPolicy je zásada, která slouží k řízení nastavení zachování aktivního nastavení pro každou žádost.
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 pro sledování hlaviček umístění ze serveru za účelem podpory 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í opakované pokusy o žádosti při splnění určitých podmínek.
setClientRequestIdPolicy(string)	Každý PipelineRequest získá při vytváření jedinečné ID. Tato zásada předává toto jedinečné ID prostřednictvím hlavičky HTTP, aby bylo možné zlepšit telemetrii a trasování.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Zásada 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í z samotného serveru.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Zásada, která opakuje, když server odešle odpověď 429 s hlavičkou Retry-After. Další informace najdete v tématu 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 a https://learn.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 vytvořený kanálem, který má SpanOptions s nadřazeným objektem. Požadavky provedené bez nadřazeného rozsahu nebudou zaznamenány.
userAgentPolicy(UserAgentPolicyOptions)	Zásada, která nastaví hlavičku User-Agent (nebo ekvivalentní) tak, aby odrážela verzi knihovny.

Podrobnosti funkce

agentPolicy(Agent)

Získá zásadu kanálu, která nastavuje http.agent

function agentPolicy(agent?: Agent): PipelinePolicy

Parametry

agent

Agent

Návraty

PipelinePolicy

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Zásady pro externí tokeny pro x-ms-authorization-auxiliary hlavičku. Tato hlavička se použije při vytváření aplikace mezi tenanty, které možná budeme muset zpracovat žádosti o ověření pro prostředky, které jsou v různých tenantech. Můžete se podívat na dokumentaci ARM, kde najdete přehled toho, jak tato funkce funguje.

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parametry

options

AuxiliaryAuthenticationHeaderPolicyOptions

Návraty

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Zásada, která může vyžádat token z implementace TokenCredential a pak ji 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

createFile(Uint8Array, string, CreateFileOptions)

Vytvořte objekt, který implementuje rozhraní File. Tento objekt je určen k předání do RequestBodyType.formData a není zaručeno, že bude fungovat podle očekávání v jiných situacích.

Tuto funkci použijte k vytvoření objektu File pro použití v RequestBodyType.formData v prostředích, kde globální objekt File není k dispozici.

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

Parametry

content

Uint8Array

obsah souboru jako Uint8Array v paměti.

name

string

název souboru.

options

CreateFileOptions

volitelná metadata o souboru, například název souboru, velikost souboru, typ MIME.

Návraty

File

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

Vytvořte objekt, který implementuje rozhraní File. Tento objekt je určen k předání do RequestBodyType.formData a není zaručeno, že bude fungovat podle očekávání v jiných situacích.

Pomocí této funkce můžete:

• Vytvořte objekt File pro použití v RequestBodyType.formData v prostředích, kde globální objekt File není k dispozici.
• Vytvořte objekt podobný souboru z čitelného datového proudu bez čtení datového proudu do paměti.

function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File

Parametry

stream

() => ReadableStream<Uint8Array> | ReadableStream

obsah souboru jako zpětné volání vracející datový proud. Při předání objektu File pomocí createFile v mapě dat formuláře požadavku datový proud nebude načten do paměti a místo toho bude streamován při vytvoření požadavku. V případě opakování je potřeba datový proud znovu přečíst, takže pokud je to možné, měla by tato zpětná volání vrátit nový datový proud.

name

string

název souboru.

options

CreateFileFromStreamOptions

volitelná metadata o souboru, například název souboru, velikost souboru, typ MIME.

Návraty

File

createHttpHeaders(RawHttpHeadersInput)

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

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parametry

rawHeaders

RawHttpHeadersInput

Jednoduchý objekt představující počáteční záhlaví

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ří nový požadavek kanálu s danými možnostmi. Tato metoda umožňuje snadné nastavení výchozích hodnot a nevyžaduje se.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parametry

options

PipelineRequestOptions

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

Návraty

PipelineRequest

decompressResponsePolicy()

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

function decompressResponsePolicy(): PipelinePolicy

Návraty

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Zásada, která se opakuje v souladu se třemi strategiemi:

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

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parametry

options

DefaultRetryPolicyOptions

Návraty

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Zásada, která se pokusí opakovat požadavky při zavádění exponenciálně rostoucího zpoždění.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parametry

options

ExponentialRetryPolicyOptions

Možnosti, které konfigurují logiku opakování

Návraty

PipelinePolicy

formDataPolicy()

Zásada, která kóduje FormData na požadavku do textu.

function formDataPolicy(): PipelinePolicy

Návraty

PipelinePolicy

getDefaultProxySettings(string)

Upozornění

Toto rozhraní API je teď zastaralé.

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

Tato metoda převede adresu URL proxy serveru na ProxySettings pro použití s ProxyPolicy. Pokud žádný argument není zadaný, pokusí se analyzovat adresu URL proxy serveru z proměnných prostředí HTTPS_PROXY 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

multipartPolicy()

Zásady kanálu pro žádosti o více částí

function multipartPolicy(): PipelinePolicy

Návraty

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy je zásada, která slouží k řízení nastavení zachování aktivního nastavení pro každou žádost.

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 pro každý požadavek.

options

{ customNoProxyList?: string[] }

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

Návraty

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Zásady pro sledování hlaviček umístění ze serveru za účelem podpory 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í opakované pokusy o žádosti 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 vytváření jedinečné ID. Tato zásada předává toto jedinečné ID prostřednictvím hlavičky HTTP, aby bylo možné zlepšit telemetrii a trasování.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parametry

requestIdHeaderName

string

Název hlavičky pro předání ID požadavku.

Návraty

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Zásada 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í z samotného serveru.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parametry

options

SystemErrorRetryPolicyOptions

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

Návraty

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

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

Další informace najdete v tématu 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 a https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parametry

options

ThrottlingRetryPolicyOptions

Možnosti, které konfigurují 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 vytvořený kanálem, který má SpanOptions s nadřazeným objektem. Požadavky provedené bez nadřazeného rozsahu nebudou zaznamenány.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parametry

options

TracingPolicyOptions

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

Návraty

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Zásada, která nastaví hlavičku User-Agent (nebo ekvivalentní) 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