@azure/core-rest-pipeline package
Interfészek
| AddPipelineOptions |
Szabályzatnak a folyamathoz való hozzáadásakor megadott beállítások. Más szabályzatokkal kapcsolatos függőségek kifejezésére szolgál. |
| Agent |
A NodeJS |
| 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ára vonatkozó beállítások |
| BearerTokenAuthenticationPolicyOptions |
A bearerTokenAuthenticationPolicy konfigurálására vonatkozó beállítások |
| BodyPart |
A kérelem törzsének egy része egy többrészes kérelemben. |
| ChallengeCallbacks |
A folyamatos hozzáférés-kiértékelési kihívások feldolgozásának felülbírálási lehetőségei. |
| CreateFileFromStreamOptions |
További lehetőségek a createFile-hoz egy stream átadásakor. |
| CreateFileOptions |
A createFile-nak átadott beállítások megadják a fájl metaadatait. |
| 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 |
Az SDK-ügyfél HTTP-folyamatának belső beállításainak konfigurálásához használt beállításokat határozza meg. |
| KeyObject |
A NodeJS |
| LogPolicyOptions |
A logPolicy konfigurálására vonatkozó beállítások. |
| MultipartRequestBody |
Több részből álló kérelemtörzs. |
| Pipeline |
EGY URL-címre irányuló HTTP-kérést kérő folyamatot jelöl. A folyamatok több szabályzatot is használhatnak a kérések kiszolgálóra történő létrehozása előtt és után történő módosításának kezelésére. |
| 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. Ez elméletileg egy köztes szoftver, amely a kérést a beérkezés előtt módosíthatja, valamint a választ, amikor az megérkezik. |
| PipelineRequest |
Metaadatok a folyamat által küldött kérésről. |
| PipelineRequestOptions |
A kérés inicializálásának beállításai. Majdnem egyenértékű a Partial<PipelineRequest-kel>, de az url 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 |
A kimenő kérelmek proxyjának konfigurálására szolgáló beállítások (csakNode.js). |
| PxfObject |
A NodeJS |
| RedirectPolicyOptions |
Az átirányítási válaszok kezelésének beállításai. |
| RestError |
A sikertelen folyamatkérések egyéni hibatípusa. |
| RestErrorConstructor |
A sikertelen folyamatkérések egyéni hibatípusa. |
| 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 |
Az újrapróbálkozási szabályzat viselkedését módosító tulajdonságok. |
| RetryPolicyOptions |
Az retryPolicy beállításai |
| RetryStrategy |
Az újrapróbálkozás stratégiája 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 |
TLS-hitelesítés tanúsítványát jelöli. |
| TracingPolicyOptions |
A nyomkövetési szabályzat konfigurálására szolgáló beállítások. |
| 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, blob vagy fájl. Ha egy nevet tartalmazó fájlt szeretne átadni, de nem fér hozzá a Fájl osztályhoz, a createFile segéd segítségével létrehozhat egyet. |
| HttpMethods |
Támogatott HTTP-metódusok a kérések során. |
| PipelinePhase |
A szabályzatok végrehajtása fázisokban történik. A végrehajtási sorrend a következő:
|
| 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 szervek típusai. NodeJS.ReadableStream és () => NodeJS.ReadableStream csak csomópont. A Blob, a ReadableStream<Uint8Array> és a () => ReadableStream<Uint8Array> csak böngésző. |
| SendRequest |
Egy egyszerű felület a folyamatkérelem 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
| agent |
Lekéri a http.agentet beállító folyamatszabályzatot |
| auxiliary |
Szabályzat külső jogkivonatokhoz a fejléc |
| bearer |
Olyan szabályzat, amely jogkivonatot kérhet le a TokenCredential implementációtól, majd alkalmazhatja azt a kérés engedélyezési fejlécére tulajdonosi jogkivonatként. |
| create |
Hozza létre a megfelelő HttpClient-et az aktuális környezethez. |
| create |
Teljesen üres folyamatot hoz létre. Egyéni teszteléshez vagy létrehozáshoz hasznos. |
| create |
Hozzon létre egy objektumot, amely implementálja a Fájl felületet. Ezt az objektumot a RequestBodyType.formData fájlba kell továbbítani, és más helyzetekben nem garantáltan a várt módon működik. Ezzel a függvénysel létrehoz egy Fájlobjektumot a RequestBodyType.formData alkalmazásban olyan környezetekben, ahol a globális fájlobjektum nem érhető el. |
| create |
Hozzon létre egy objektumot, amely implementálja a Fájl felületet. Ezt az objektumot a RequestBodyType.formData fájlba kell továbbítani, és más helyzetekben nem garantáltan a várt módon működik. Használja ezt a függvényt a következőre:
|
| create |
Létrehoz egy objektumot, amely megfelel a |
| create |
Hozzon létre egy új folyamatot, amely alapértelmezett testreszabható szabályzatokkal rendelkezik. |
| create |
Létrehoz egy új folyamatkérelemet 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. |
| decompress |
A válaszdepresszió engedélyezésére szolgáló szabályzat Accept-Encoding fejléc https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding |
| default |
Három stratégia szerint újrapróbálkozó szabályzat:
|
| exponential |
Olyan szabályzat, amely megpróbál újrapróbálkozó kéréseket létrehozni, miközben exponenciálisan növekvő késleltetést vezet be. |
| form |
Egy szabályzat, amely a formData-t kódolja a kérésen a törzsbe. |
| get |
Ez a metódus a proxy URL-címét |
| is |
Typeguard a RestErrorhoz |
| log |
Egy szabályzat, amely naplózza az összes kérést és választ. |
| multipart |
Többrészes kérelmek folyamatszabályzata |
| nd |
Az ndJsonPolicy egy olyan szabályzat, amellyel szabályozható az életben tartási beállítások minden kéréshez. |
| proxy |
Olyan szabályzat, amely lehetővé teszi, hogy proxybeállításokat alkalmazzon az összes kérelemre. Ha nem ad át statikus beállításokat, a rendszer lekéri őket a HTTPS_PROXY vagy HTTP_PROXY környezeti változókból. |
| redirect |
A kiszolgálóoldali átirányítás támogatása érdekében a kiszolgáló helyfejléceinek követésére szolgáló házirend. A böngészőben ez a szabályzat nem használatos. |
| retry |
A retryPolicy egy általános szabályzat, amely lehetővé teszi a kérések újrapróbálkozását bizonyos feltételek teljesülése esetén |
| set |
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 telemetriai és nyomkövetési funkciók érdekében. |
| system |
Olyan újrapróbálkozási szabályzat, amely kifejezetten a mögöttes átviteli réteg hibáinak (például DNS-keresési hibák) kezelésére törekszik, nem pedig a kiszolgálóról származó újrapróbálkozási hibakódok kezelésére. |
| throttling |
Olyan szabályzat, amely újrapróbálkozza, amikor a kiszolgáló 429-választ küld egy Retry-After fejléccel. További információ: https://learn.microsoft.com/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/azure/azure-subscription-service-limits és https://learn.microsoft.com/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors |
| tls |
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. |
| tracing |
Egyszerű szabályzat openTelemetria-spanok létrehozásához a szülővel rendelkező SpanOptionst tartalmazó folyamat minden egyes kéréséhez. A szülő span nélkül küldött kérések nem lesznek rögzítve. |
| user |
Olyan szabályzat, amely a User-Agent fejlécet (vagy azzal egyenértékű) a kódtár verziójának megfelelően állítja be. |
Függvény adatai
agentPolicy(Agent)
Lekéri a http.agentet beállító folyamatszabályzatot
function agentPolicy(agent?: Agent): PipelinePolicy
Paraméterek
- agent
- Agent
Válaszok
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
Szabályzat külső jogkivonatokhoz a fejléc x-ms-authorization-auxiliary.
Ez a fejléc egy bérlőközi alkalmazás létrehozásakor lesz használva, és szükség lehet a különböző bérlőkben lévő erőforrások hitelesítési kéréseinek kezelésére.
Láthatta, ARM-dokumentumok a funkció működésének lefutásához
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy
Paraméterek
Válaszok
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
Olyan szabályzat, amely jogkivonatot kérhet le a TokenCredential implementációtól, majd alkalmazhatja azt a kérés engedélyezési fejlécére tulajdonosi jogkivonatként.
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy
Paraméterek
Válaszok
createDefaultHttpClient()
Hozza létre a megfelelő HttpClient-et az aktuális környezethez.
function createDefaultHttpClient(): HttpClient
Válaszok
createEmptyPipeline()
Teljesen üres folyamatot hoz létre. Egyéni teszteléshez vagy létrehozáshoz hasznos.
function createEmptyPipeline(): Pipeline
Válaszok
createFile(Uint8Array, string, CreateFileOptions)
Hozzon létre egy objektumot, amely implementálja a Fájl felületet. Ezt az objektumot a RequestBodyType.formData fájlba kell továbbítani, és más helyzetekben nem garantáltan a várt módon működik.
Ezzel a függvénysel létrehoz egy Fájlobjektumot a RequestBodyType.formData alkalmazásban olyan környezetekben, ahol a globális fájlobjektum nem érhető el.
function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File
Paraméterek
- content
-
Uint8Array
A fájl tartalma Uint8Arrayként a memóriában.
- name
-
string
a fájl neve.
- options
- CreateFileOptions
nem kötelező metaadatok a fájlról, például fájlnév, fájlméret, MIME-típus.
Válaszok
File
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)
Hozzon létre egy objektumot, amely implementálja a Fájl felületet. Ezt az objektumot a RequestBodyType.formData fájlba kell továbbítani, és más helyzetekben nem garantáltan a várt módon működik.
Használja ezt a függvényt a következőre:
- Hozzon létre egy Fájlobjektumot a RequestBodyType.formData alkalmazásban olyan környezetekben, ahol a globális fájlobjektum nem érhető el.
- Fájlszerű objektum létrehozása olvasható streamből a stream memóriába olvasása nélkül.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File
Paraméterek
- stream
-
() => ReadableStream<Uint8Array> | ReadableStream
a fájl tartalma visszahívásként, amely egy streamet ad vissza. Ha a createFile használatával létrehozott fájlobjektumot egy kérelem űrlapadat-leképezésében továbbítják, a rendszer nem olvassa be a streamet a memóriába, hanem a kérés létrehozásakor lesz streamelve. Újrapróbálkozás esetén a streamet újra be kell olvasni, ezért a visszahívásnak lehetőség szerint új streamet kell visszaadnia.
- name
-
string
a fájl neve.
- options
- CreateFileFromStreamOptions
nem kötelező metaadatok a fájlról, például fájlnév, fájlméret, MIME-típus.
Válaszok
File
createHttpHeaders(RawHttpHeadersInput)
Létrehoz egy objektumot, amely megfelel a HttpHeaders felületnek.
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders
Paraméterek
- rawHeaders
- RawHttpHeadersInput
Egyszerű objektum, amely a kezdeti fejléceket jelöli
Válaszok
createPipelineFromOptions(InternalPipelineOptions)
Hozzon létre egy új folyamatot, amely alapértelmezett testreszabható szabályzatokkal rendelkezik.
function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline
Paraméterek
- options
- InternalPipelineOptions
Egyéni folyamat konfigurálására való beállítások.
Válaszok
createPipelineRequest(PipelineRequestOptions)
Létrehoz egy új folyamatkérelemet 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
decompressResponsePolicy()
A válaszdepresszió engedélyezésére szolgáló szabályzat Accept-Encoding fejléc https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
function decompressResponsePolicy(): PipelinePolicy
Válaszok
defaultRetryPolicy(DefaultRetryPolicyOptions)
Három stratégia szerint újrapróbálkozó 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 jelentkeznek (például DNS-keresési hibák).
- Ha a kimenő kérés sikertelen, az exponenciálisan növekvő késéssel próbálkozik újra.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy
Paraméterek
- options
- DefaultRetryPolicyOptions
Válaszok
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
Olyan szabályzat, amely megpróbál újrapróbálkozó kéréseket létrehozni, 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
formDataPolicy()
Egy szabályzat, amely a formData-t kódolja a kérésen a törzsbe.
function formDataPolicy(): PipelinePolicy
Válaszok
getDefaultProxySettings(string)
Figyelmeztetés
Ez az API már elavult.
- Internally this method is no longer necessary when setting proxy information.
Ez a metódus a proxy URL-címét ProxySettings alakítja át a ProxyPolicy használatával való használatra.
Ha nem ad meg argumentumot, megkísérli elemezni a proxy URL-címét 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 egy fogási záradék fog.
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ára való beállítások.
Válaszok
multipartPolicy()
Többrészes kérelmek folyamatszabályzata
function multipartPolicy(): PipelinePolicy
Válaszok
ndJsonPolicy()
Az ndJsonPolicy egy olyan szabályzat, amellyel szabályozható az életben tartási beállítások minden kéréshez.
function ndJsonPolicy(): PipelinePolicy
Válaszok
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })
Olyan szabályzat, amely lehetővé teszi, hogy proxybeállításokat alkalmazzon az összes kérelemre. Ha nem ad át 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
Az egyes kérelmekhez használandó ProxySettings.
- options
-
{ customNoProxyList?: string[] }
további beállítások, például egyéni NO_PROXY minták
Válaszok
redirectPolicy(RedirectPolicyOptions)
A kiszolgálóoldali átirányítás támogatása érdekében a kiszolgáló helyfejléceinek követésére szolgáló házirend. 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
retryPolicy(RetryStrategy[], RetryPolicyOptions)
A retryPolicy egy általános szabályzat, amely lehetővé teszi a kérések újrapróbálkozását bizonyos feltételek teljesülése esetén
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy
Paraméterek
- strategies
- options
- RetryPolicyOptions
Válaszok
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 telemetriai és nyomkövetési funkciók érdekében.
function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy
Paraméterek
- requestIdHeaderName
-
string
Annak a fejlécnek a neve, amelybe át szeretné adni a kérésazonosítót.
Válaszok
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
Olyan újrapróbálkozási szabályzat, amely kifejezetten a mögöttes átviteli réteg hibáinak (például DNS-keresési hibák) kezelésére törekszik, nem pedig a kiszolgálóról származó újrapróbálkozási hibakódok kezelésére.
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy
Paraméterek
- options
- SystemErrorRetryPolicyOptions
A szabályzatot testre szabó beállítások.
Válaszok
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)
Olyan szabályzat, amely újrapróbálkozza, amikor a kiszolgáló 429-választ küld egy Retry-After fejléccel.
További információ: https://learn.microsoft.com/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/azure/azure-subscription-service-limits és https://learn.microsoft.com/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
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
tracingPolicy(TracingPolicyOptions)
Egyszerű szabályzat openTelemetria-spanok létrehozásához a szülővel rendelkező SpanOptionst tartalmazó folyamat minden egyes kéréséhez. 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ára szolgáló beállítások.
Válaszok
userAgentPolicy(UserAgentPolicyOptions)
Olyan szabályzat, amely a User-Agent fejlécet (vagy azzal egyenértékű) a kódtár verziójának megfelelően állítja be.
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.