@azure/core-rest-pipeline package

Osztályok

RestError

A sikertelen folyamatkérések egyéni hibatípusa.

Interfészek

AddPipelineOptions	A szabályzatok folyamathoz való hozzáadásának beállításai. Más szabályzatokkal kapcsolatos függőségek kifejezésére szolgál.
Agent	A NodeJS-sel http.Agentkompatibilis felület. Szeretnénk elkerülni a tényleges felület nyilvános újraexportálását, mivel az a futtatókörnyezeti verziókban eltérő lehet.
AuthorizeRequestOnChallengeOptions	Az authorizeRequestOnChallenge visszahívásnak küldött beállítások
AuthorizeRequestOptions	Az authorizeRequest visszahívásnak küldött beállítások
AuxiliaryAuthenticationHeaderPolicyOptions	A kiegészítőAuthenticationHeaderPolicy konfigurálásának beállításai
BearerTokenAuthenticationPolicyOptions	A bearerTokenAuthenticationPolicy konfigurálásának beállításai
ChallengeCallbacks	A folyamatos hozzáférés-kiértékeléssel kapcsolatos kihívások feldolgozásának felülbírálási lehetőségei.
DefaultRetryPolicyOptions	A sikertelen kérések újrapróbálkozására vonatkozó beállítások.
ExponentialRetryPolicyOptions	A sikertelen kérések újrapróbálkozására vonatkozó beállítások.
HttpClient	A folyamat nevében HTTP-kéréseket küldő ügyfél szükséges felülete.
HttpHeaders	HTTP-fejlécek készletét jelöli egy kérésen/válaszon. A fejlécnevek kis- és nagybetűket nem érzéketlenként kezelik.
InternalPipelineOptions	Meghatározza az SDK-ügyfél HTTP-folyamatának belső beállításainak konfigurálásához használt beállításokat.
KeyObject	A NodeJS-sel tls.KeyObjectkompatibilis felület. Szeretnénk elkerülni a tényleges felület nyilvános újraexportálását, mivel az a futtatókörnyezeti verziókban eltérő lehet.
LogPolicyOptions	A logPolicy konfigurálásának beállításai.
Pipeline	Egy URL-címre irányuló HTTP-kérést küldő folyamatot jelöl. A folyamatok több szabályzatot is használhatnak az egyes kérések a kiszolgálóra történő létrehozása előtt és után történő kezeléséhez.
PipelineOptions	Meghatározza az SDK-ügyfél HTTP-folyamatának konfigurálásához használt beállításokat.
PipelinePolicy	A folyamatszabályzatok a folyamaton áthaladva módosítják a kéréseket. Fogalmilag egy köztes szoftver, amely a kérést a beérkezés előtt módosíthatja, valamint a válaszát is.
PipelineRequest	A folyamat által küldött kérés metaadatai.
PipelineRequestOptions	A kérés inicializálására vonatkozó beállítások. Majdnem egyenértékű a Részleges, de az URL-cím kötelező.
PipelineResponse	A folyamat által kapott válasz metaadatai.
PipelineRetryOptions	A sikertelen kérések újrapróbálkozására vonatkozó beállítások.
ProxySettings	Proxy konfigurálásának beállításai a kimenő kérelmekhez (csak Node.js).
PxfObject	A NodeJS-sel tls.PxfObjectkompatibilis felület. Szeretnénk elkerülni a tényleges felület nyilvános újraexportálását, mivel az a futtatókörnyezeti verziókban eltérő lehet.
RedirectPolicyOptions	Az átirányítási válaszok kezelésének beállításai.
RestErrorOptions	A RestError által támogatott beállítások.
RetryInformation	Az újrapróbálkozás stratégiájának információi az újrapróbálkozési szabályzat aktuális állapotáról.
RetryModifiers	Tulajdonságok, amelyek módosíthatják az újrapróbálkozési szabályzat viselkedését.
RetryPolicyOptions	Az újrapróbálkozásszabályzat beállításai
RetryStrategy	Az újrapróbálkozásra vonatkozó stratégia azt határozza meg, hogy újrapróbálkozzon-e vagy sem, és hogyan próbálkozzon újra.
SystemErrorRetryPolicyOptions	A sikertelen kérések újrapróbálkozására vonatkozó beállítások.
TelemetryOptions	Meghatározza a gyakori telemetriai és nyomkövetési adatok konfigurálásához használt beállításokat
ThrottlingRetryPolicyOptions	A sikertelen kérések újrapróbálkozására vonatkozó beállítások.
TlsSettings	A TLS-hitelesítés tanúsítványát jelöli.
TracingPolicyOptions	A nyomkövetési szabályzat konfigurálásának beállításai.
UserAgentPolicyOptions	A felhasználói ügynök adatainak a kimenő kérelmekhez való hozzáadásának lehetőségei.

Típusaliasok

FormDataMap	Egy egyszerű objektum, amely űrlapadatokat biztosít, mintha egy böngészőűrlapról származik.
FormDataValue	Minden űrlapadat-bejegyzés lehet sztring vagy (a böngészőben) egy Blob.
HttpMethods	Támogatott HTTP-metódusok, amelyet kérések esetén használhat.
PipelinePhase	A szabályzatok végrehajtása fázisokban történik. A végrehajtási sorrend a következő: Fázis szerializálása Nem fázisban lévő szabályzatok Deszerializálási fázis Újrapróbálkozási fázis Aláírási fázis
RawHttpHeaders	Egyszerű JSON-objektumként ábrázolt HttpHeaders-gyűjtemény.
RawHttpHeadersInput	Egy HttpHeaders-gyűjtemény a bemenethez, amely egyszerű JSON-objektumként jelenik meg.
RequestBodyType	A kérelemben támogatott testületek típusai. NodeJS.ReadableStream és () => NodeJS.ReadableStream csak Csomópont. Blob, ReadableStream és () => A ReadableStream csak böngésző.
SendRequest	Egy egyszerű felület a folyamatkérések elkészítéséhez és a válasz fogadásához.
TransferProgressEvent	A feltöltési vagy letöltési folyamatra válaszul aktiválódott.

Függvények

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Szabályzat külső jogkivonatokhoz a fejléchez x-ms-authorization-auxiliary . Ez a fejléc a bérlők közötti alkalmazások létrehozásakor lesz használva, és előfordulhat, hogy a különböző bérlőkben lévő erőforrások hitelesítési kéréseit kell kezelni. A funkció működésének lefutásához láthat arm-dokumentumokat
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Olyan szabályzat, amely jogkivonatot kérhet le a TokenCredential implementációból, majd alkalmazhatja azt a kérés Engedélyezési fejlécére Tulajdonosi jogkivonatként.
createDefaultHttpClient()	Hozza létre a megfelelő HttpClient-et az aktuális környezethez.
createEmptyPipeline()	Teljesen üres folyamatot hoz létre. Egyéni teszteléshez vagy létrehozáshoz hasznos.
createHttpHeaders(RawHttpHeadersInput)	Létrehoz egy objektumot, amely megfelel a felületnek HttpHeaders .
createPipelineFromOptions(InternalPipelineOptions)	Hozzon létre egy új folyamatot a testre szabható szabályzatok alapértelmezett készletével.
createPipelineRequest(PipelineRequestOptions)	Létrehoz egy új folyamatkérést a megadott beállításokkal. Ez a módszer lehetővé teszi az alapértelmezett értékek egyszerű beállítását, és nem szükséges.
decompressResponsePolicy()	Szabályzat a válaszbontás engedélyezéséhez Accept-Encoding fejlécnek megfelelően https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Három stratégia szerint újrapróbálkozásra szolgáló szabályzat: Amikor a kiszolgáló egy Retry-After fejlécet tartalmazó 429-választ küld. Ha a mögöttes átviteli rétegben hibák vannak (például DNS-keresési hibák). Vagy ha a kimenő kérés sikertelen, exponenciálisan növekvő késleltetéssel próbálkozik újra.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Egy olyan szabályzat, amely megpróbál újrapróbálkozásokat végezni a kérésekkel, miközben exponenciálisan növekvő késleltetést vezet be.
formDataPolicy()	Egy szabályzat, amely a formData-ot kódolja a kérésen a törzsbe.
getDefaultProxySettings(string)	Ez a metódus proxy URL-címet ProxySettings alakít át proxypolicy használatával való használatra. Ha nincs megadva argumentum, megpróbál elemezni egy proxy URL-címet a környezeti változókból HTTPS_PROXY vagy HTTP_PROXY.
isRestError(unknown)	Typeguard a RestErrorhoz
logPolicy(LogPolicyOptions)	Egy szabályzat, amely naplózza az összes kérést és választ.
ndJsonPolicy()	Az ndJsonPolicy egy szabályzat, amellyel minden kérés életben tartási beállításait szabályozhatja.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Egy szabályzat, amely lehetővé teszi, hogy proxybeállításokat alkalmazzanak az összes kérelemre. Ha nem adta meg a statikus beállításokat, a rendszer lekéri őket a HTTPS_PROXY vagy HTTP_PROXY környezeti változókból.
redirectPolicy(RedirectPolicyOptions)	Szabályzat a kiszolgáló helyfejléceinek követésére a kiszolgálóoldali átirányítás támogatásához. A böngészőben ez a szabályzat nem használatos.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	A retryPolicy egy általános szabályzat, amely bizonyos feltételek teljesülése esetén engedélyezi az újrapróbálkozási kéréseket
setClientRequestIdPolicy(string)	Minden PipelineRequest egyedi azonosítót kap a létrehozáskor. Ez a szabályzat egy HTTP-fejlécen keresztül továbbítja ezt az egyedi azonosítót a jobb telemetria és nyomkövetés érdekében.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Egy újrapróbálkozási szabályzat, amely kifejezetten a mögöttes átviteli réteg hibáit (például DNS-keresési hibákat) kívánja kezelni a kiszolgálóról származó újrapróbálkozási hibakódok helyett.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Olyan szabályzat, amely újrapróbálkozásokat ad vissza, amikor a kiszolgáló egy 429-re adott választ küld egy Retry-After fejléccel. További információért tekintse meg a következőt: 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 és https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	Lekéri a folyamatszabályzatot, amely hozzáadja az ügyféltanúsítványt a HttpClient-ügynökhöz hitelesítés céljából.
tracingPolicy(TracingPolicyOptions)	Egyszerű szabályzat OpenTelemetry Spans létrehozásához a folyamat minden olyan kéréséhez, amely spanOptions és szülő kapcsolattal rendelkezik. A szülő span nélkül küldött kérések nem lesznek rögzítve.
userAgentPolicy(UserAgentPolicyOptions)	Olyan szabályzat, amely a User-Agent fejlécet (vagy azzal egyenértékű) úgy állítja be, hogy az tükrözze a kódtár verzióját.

Függvény adatai

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Szabályzat külső jogkivonatokhoz a fejléchez x-ms-authorization-auxiliary . Ez a fejléc a bérlők közötti alkalmazások létrehozásakor lesz használva, és előfordulhat, hogy a különböző bérlőkben lévő erőforrások hitelesítési kéréseit kell kezelni. A funkció működésének lefutásához láthat arm-dokumentumokat

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Paraméterek

options

AuxiliaryAuthenticationHeaderPolicyOptions

Válaszok

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Olyan szabályzat, amely jogkivonatot kérhet le a TokenCredential implementációból, majd alkalmazhatja azt a kérés Engedélyezési fejlécére Tulajdonosi jogkivonatként.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Paraméterek

options

BearerTokenAuthenticationPolicyOptions

Válaszok

PipelinePolicy

createDefaultHttpClient()

Hozza létre a megfelelő HttpClient-et az aktuális környezethez.

function createDefaultHttpClient(): HttpClient

Válaszok

HttpClient

createEmptyPipeline()

Teljesen üres folyamatot hoz létre. Egyéni teszteléshez vagy létrehozáshoz hasznos.

function createEmptyPipeline(): Pipeline

Válaszok

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Létrehoz egy objektumot, amely megfelel a felületnek HttpHeaders .

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Paraméterek

rawHeaders

RawHttpHeadersInput

Egyszerű objektum, amely a kezdeti fejléceket jelöli

Válaszok

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Hozzon létre egy új folyamatot a testre szabható szabályzatok alapértelmezett készletével.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Paraméterek

options

InternalPipelineOptions

Egyéni folyamat konfigurálásának beállításai.

Válaszok

Pipeline

createPipelineRequest(PipelineRequestOptions)

Létrehoz egy új folyamatkérést a megadott beállításokkal. Ez a módszer lehetővé teszi az alapértelmezett értékek egyszerű beállítását, és nem szükséges.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Paraméterek

options

PipelineRequestOptions

A kérés létrehozásának lehetőségei.

Válaszok

PipelineRequest

decompressResponsePolicy()

Szabályzat a válaszbontás engedélyezéséhez Accept-Encoding fejlécnek megfelelően https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Válaszok

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Három stratégia szerint újrapróbálkozásra szolgáló szabályzat:

• Amikor a kiszolgáló egy Retry-After fejlécet tartalmazó 429-választ küld.
• Ha a mögöttes átviteli rétegben hibák vannak (például DNS-keresési hibák).
• Vagy ha a kimenő kérés sikertelen, exponenciálisan növekvő késleltetéssel próbálkozik újra.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Paraméterek

options

DefaultRetryPolicyOptions

Válaszok

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Egy olyan szabályzat, amely megpróbál újrapróbálkozásokat végezni a kérésekkel, miközben exponenciálisan növekvő késleltetést vezet be.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Paraméterek

options

ExponentialRetryPolicyOptions

Az újrapróbálkozás logikáját konfiguráló beállítások.

Válaszok

PipelinePolicy

formDataPolicy()

Egy szabályzat, amely a formData-ot kódolja a kérésen a törzsbe.

function formDataPolicy(): PipelinePolicy

Válaszok

PipelinePolicy

getDefaultProxySettings(string)

Ez a metódus proxy URL-címet ProxySettings alakít át proxypolicy használatával való használatra. Ha nincs megadva argumentum, megpróbál elemezni egy proxy URL-címet a környezeti változókból HTTPS_PROXY vagy HTTP_PROXY.

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

Paraméterek

proxyUrl

string

A használni kívánt proxy URL-címe. Tartalmazhat hitelesítési adatokat.

Válaszok

ProxySettings | undefined

isRestError(unknown)

Typeguard a RestErrorhoz

function isRestError(e: unknown): e

Paraméterek

e

unknown

Valami, amit elkapott egy fogási záradék.

Válaszok

e

logPolicy(LogPolicyOptions)

Egy szabályzat, amely naplózza az összes kérést és választ.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Paraméterek

options

LogPolicyOptions

A logPolicy konfigurálásának beállításai.

Válaszok

PipelinePolicy

ndJsonPolicy()

Az ndJsonPolicy egy szabályzat, amellyel minden kérés életben tartási beállításait szabályozhatja.

function ndJsonPolicy(): PipelinePolicy

Válaszok

PipelinePolicy

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

Egy szabályzat, amely lehetővé teszi, hogy proxybeállításokat alkalmazzanak az összes kérelemre. Ha nem adta meg a statikus beállításokat, a rendszer lekéri őket a HTTPS_PROXY vagy HTTP_PROXY környezeti változókból.

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

Paraméterek

proxySettings

ProxySettings

ProxyBeállítások az egyes kérelmekhez.

options

{ customNoProxyList?: string[] }

további beállítások, például egyéni NO_PROXY minták

Válaszok

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Szabályzat a kiszolgáló helyfejléceinek követésére a kiszolgálóoldali átirányítás támogatásához. A böngészőben ez a szabályzat nem használatos.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Paraméterek

options

RedirectPolicyOptions

A szabályzatok viselkedésének szabályozására szolgáló beállítások.

Válaszok

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

A retryPolicy egy általános szabályzat, amely bizonyos feltételek teljesülése esetén engedélyezi az újrapróbálkozási kéréseket

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

Paraméterek

strategies

RetryStrategy[]

options

RetryPolicyOptions

Válaszok

PipelinePolicy

setClientRequestIdPolicy(string)

Minden PipelineRequest egyedi azonosítót kap a létrehozáskor. Ez a szabályzat egy HTTP-fejlécen keresztül továbbítja ezt az egyedi azonosítót a jobb telemetria és nyomkövetés érdekében.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Paraméterek

requestIdHeaderName

string

Annak a fejlécnek a neve, amelynek át szeretné adni a kérésazonosítót.

Válaszok

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Egy újrapróbálkozási szabályzat, amely kifejezetten a mögöttes átviteli réteg hibáit (például DNS-keresési hibákat) kívánja kezelni a kiszolgálóról származó újrapróbálkozási hibakódok helyett.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Paraméterek

options

SystemErrorRetryPolicyOptions

A szabályzatot testre szabó beállítások.

Válaszok

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Olyan szabályzat, amely újrapróbálkozásokat ad vissza, amikor a kiszolgáló egy 429-re adott választ küld egy Retry-After fejléccel.

További információért tekintse meg a következőt: 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 és https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Paraméterek

options

ThrottlingRetryPolicyOptions

Az újrapróbálkozás logikáját konfiguráló beállítások.

Válaszok

PipelinePolicy

tlsPolicy(TlsSettings)

Lekéri a folyamatszabályzatot, amely hozzáadja az ügyféltanúsítványt a HttpClient-ügynökhöz hitelesítés céljából.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Paraméterek

tlsSettings

TlsSettings

Válaszok

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Egyszerű szabályzat OpenTelemetry Spans létrehozásához a folyamat minden olyan kéréséhez, amely spanOptions és szülő kapcsolattal rendelkezik. A szülő span nélkül küldött kérések nem lesznek rögzítve.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Paraméterek

options

TracingPolicyOptions

A nyomkövetési szabályzat által naplózott telemetriai adatok konfigurálásának beállításai.

Válaszok

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Olyan szabályzat, amely a User-Agent fejlécet (vagy azzal egyenértékű) úgy állítja be, hogy az tükrözze a kódtár verzióját.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Paraméterek

options

UserAgentPolicyOptions

A felhasználói ügynök értékének testreszabására vonatkozó beállítások.

Válaszok

PipelinePolicy