@azure/core-https package

Třídy

DefaultHttpsClient

Implementace HttpsClient, která k odesílání požadavků HTTPS používá modul "https" uzlu.

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.

BearerTokenAuthenticationPolicyOptions

Možnosti konfigurace bearerTokenAuthenticationPolicy

ExponentialRetryPolicyOptions

Možnosti, které řídí, jak opakovat neúspěšné požadavky.

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.

HttpsClient

Požadované rozhraní pro klienta, který provádí požadavky HTTPS jménem kanálu.

InternalPipelineOptions

Definuje možnosti, které se používají ke konfiguraci interních možností kanálu HTTP pro klienta sady SDK.

LogPolicyOptions

Možnosti konfigurace logPolicy

Pipeline

Představuje kanál pro vytvoření požadavku HTTPS 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í k Partial<PipelineRequest>, ale adresa URL je povinná.

PipelineResponse

Metadata o odpovědi přijaté kanálem

ProxySettings

Možnosti konfigurace proxy serveru pro odchozí požadavky (pouzeNode.js).

RedirectPolicyOptions

Možnosti zpracování odpovědí na přesměrování

RestErrorOptions

Možnosti podporované chybou RestError.

SystemErrorRetryPolicyOptions

Možnosti, které řídí, jak opakovat neúspěšné požadavky.

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 nebo (v prohlížeči) objekt blob.

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:

  1. Fáze serializace
  2. Zásady, které nejsou ve fázi
  3. Fáze deserializace
  4. Fáze opakování
RawHttpHeaders

Kolekce HttpHeaders reprezentovaná jako jednoduchý objekt JSON.

RequestBodyType

Typy subjektů podporovaných na žádosti. NodeJS.ReadableStream je pouze Node. Blob je pouze prohlížeč.

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

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.

createEmptyPipeline()

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

createHttpHeaders(RawHttpHeaders)

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

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.

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í aktivního nastavení pro každou žádost.

proxyPolicy(ProxySettings)

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.

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

Zásada, která 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-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits a https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

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.

Proměnné

bearerTokenAuthenticationPolicyName

Programový identifikátor nositele TokenAuthenticationPolicy.

decompressResponsePolicyName

Programový identifikátor decompressResponsePolicy.

expontentialRetryPolicyName

Programový identifikátor exponenciální RetryPolicy.

formDataPolicyName

Programový identifikátor formuláře DataPolicy.

logPolicyName

Programový identifikátor logPolicy.

ndJsonPolicyName

Programový identifikátor ndJsonPolicy.

proxyPolicyName

Programový identifikátor proxyPolicy.

redirectPolicyName

Programový identifikátor přesměrovací Politiky.

setClientRequestIdPolicyName

Programový identifikátor setClientRequestIdPolicy.

systemErrorRetryPolicyName

Programový identifikátor systemErrorRetryPolicy.

throttlingRetryPolicyName

Programový identifikátor throttlingRetryPolicy.

tracingPolicyName

Programový identifikátor trasingPolicy.

userAgentPolicyName

Programový identifikátor userAgentPolicy.

Podrobnosti funkce

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

Návraty

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

Návraty

createHttpHeaders(RawHttpHeaders)

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

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

Parametry

rawHeaders
RawHttpHeaders

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

Návraty

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

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

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

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

formDataPolicy()

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

function formDataPolicy(): PipelinePolicy

Návraty

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.

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

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

ndJsonPolicy()

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

function ndJsonPolicy(): PipelinePolicy

Návraty

proxyPolicy(ProxySettings)

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): PipelinePolicy

Parametry

proxySettings
ProxySettings

ProxySettings, které se mají použít pro každý požadavek.

Návraty

redirectPolicy(RedirectPolicyOptions)

Zásady pro sledování hlaviček umístění ze serveru za účelem podpory přesměrování na straně serveru.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametry

options
RedirectPolicyOptions

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

Návraty

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

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

throttlingRetryPolicy()

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

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

Variable Details

bearerTokenAuthenticationPolicyName

Programový identifikátor nositele TokenAuthenticationPolicy.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

Typ

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

Programový identifikátor decompressResponsePolicy.

decompressResponsePolicyName: "decompressResponsePolicy"

Typ

"decompressResponsePolicy"

expontentialRetryPolicyName

Programový identifikátor exponenciální RetryPolicy.

expontentialRetryPolicyName: "exponentialRetryPolicy"

Typ

"exponentialRetryPolicy"

formDataPolicyName

Programový identifikátor formuláře DataPolicy.

formDataPolicyName: "formDataPolicy"

Typ

"formDataPolicy"

logPolicyName

Programový identifikátor logPolicy.

logPolicyName: "logPolicy"

Typ

"logPolicy"

ndJsonPolicyName

Programový identifikátor ndJsonPolicy.

ndJsonPolicyName: "ndJsonPolicy"

Typ

"ndJsonPolicy"

proxyPolicyName

Programový identifikátor proxyPolicy.

proxyPolicyName: "proxyPolicy"

Typ

"proxyPolicy"

redirectPolicyName

Programový identifikátor přesměrovací Politiky.

redirectPolicyName: "redirectPolicy"

Typ

"redirectPolicy"

setClientRequestIdPolicyName

Programový identifikátor setClientRequestIdPolicy.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

Typ

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

Programový identifikátor systemErrorRetryPolicy.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

Typ

"systemErrorRetryPolicy"

throttlingRetryPolicyName

Programový identifikátor throttlingRetryPolicy.

throttlingRetryPolicyName: "throttlingRetryPolicy"

Typ

"throttlingRetryPolicy"

tracingPolicyName

Programový identifikátor trasingPolicy.

tracingPolicyName: "tracingPolicy"

Typ

"tracingPolicy"

userAgentPolicyName

Programový identifikátor userAgentPolicy.

userAgentPolicyName: "userAgentPolicy"

Typ

"userAgentPolicy"