@azure/core-https package
Előkelő társaság
| DefaultHttpsClient |
Egy HttpsClient implementáció, amely a Nod "https" modulját használja a HTTPS-kérések küldéséhez. |
| RestError |
A sikertelen folyamatkérések egyéni hibatípusa. |
Felületek
| 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. |
| BearerTokenAuthenticationPolicyOptions |
A bearerTokenAuthenticationPolicy konfigurálására vonatkozó beállítások |
| ExponentialRetryPolicyOptions |
A sikertelen kérések újrapróbálkozására vonatkozó beállítások. |
| 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. |
| HttpsClient |
A folyamat nevében HTTPS-kéréseket küldő ügyfél szükséges felülete. |
| 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. |
| LogPolicyOptions |
A logPolicy konfigurálására vonatkozó beállítások. |
| Pipeline |
Egy URL-címre vonatkozó HTTPS-kérés folyamatát jelöli. 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. |
| ProxySettings |
A kimenő kérelmek proxyjának konfigurálására szolgáló beállítások (csakNode.js). |
| 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. |
| SystemErrorRetryPolicyOptions |
A sikertelen kérések újrapróbálkozására vonatkozó beállítások. |
| 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ípus-aliasok
| 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) blob. |
| 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. |
| RequestBodyType |
A kérelemben támogatott szervek típusai. A NodeJS.ReadableStream csak csomópont. A blob 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. |
Functions
| 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 |
Teljesen üres folyamatot hoz létre. Egyéni teszteléshez vagy létrehozáshoz hasznos. |
| 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 |
| 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 |
| log |
Egy szabályzat, amely naplózza az összes kérést és választ. |
| 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. |
| 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://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 |
| 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. |
Változók
| bearer |
A bearerTokenAuthenticationPolicy programozott azonosítója. |
| decompress |
A decompressResponsePolicy programozott azonosítója. |
| expontential |
Az exponenciális RetryPolicy programozott azonosítója. |
| form |
A formDataPolicy programozott azonosítója. |
| log |
A logPolicy programozott azonosítója. |
| nd |
Az ndJsonPolicy programozott azonosítója. |
| proxy |
A proxyPolicy programozott azonosítója. |
| redirect |
A redirectPolicy programozott azonosítója. |
| set |
A setClientRequestIdPolicy programozott azonosítója. |
| system |
A systemErrorRetryPolicy programos azonosítója. |
| throttling |
A throttling programmatikus azonosítójaRetryPolicy. |
| tracing |
A tracingPolicy programozott azonosítója. |
| user |
A userAgentPolicy programos azonosítója. |
Funkciók részletei
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
Visszatér
createEmptyPipeline()
Teljesen üres folyamatot hoz létre. Egyéni teszteléshez vagy létrehozáshoz hasznos.
function createEmptyPipeline(): Pipeline
Visszatér
createHttpHeaders(RawHttpHeaders)
Létrehoz egy objektumot, amely megfelel a HttpHeaders felületnek.
function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders
Paraméterek
- rawHeaders
- RawHttpHeaders
Egyszerű objektum, amely a kezdeti fejléceket jelöli
Visszatér
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.
Visszatér
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.
Visszatér
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
Visszatér
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.
Visszatér
formDataPolicy()
Egy szabályzat, amely a formData-t kódolja a kérésen a törzsbe.
function formDataPolicy(): PipelinePolicy
Visszatér
getDefaultProxySettings(string)
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.
Visszatér
ProxySettings | undefined
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.
Visszatér
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
Visszatér
proxyPolicy(ProxySettings)
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): PipelinePolicy
Paraméterek
- proxySettings
- ProxySettings
Az egyes kérelmekhez használandó ProxySettings.
Visszatér
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.
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.
Visszatér
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.
Visszatér
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.
Visszatér
throttlingRetryPolicy()
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://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(): PipelinePolicy
Visszatér
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.
Visszatér
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.
Visszatér
Variable Details
bearerTokenAuthenticationPolicyName
A bearerTokenAuthenticationPolicy programozott azonosítója.
bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"
Típus
"bearerTokenAuthenticationPolicy"
decompressResponsePolicyName
A decompressResponsePolicy programozott azonosítója.
decompressResponsePolicyName: "decompressResponsePolicy"
Típus
"decompressResponsePolicy"
expontentialRetryPolicyName
Az exponenciális RetryPolicy programozott azonosítója.
expontentialRetryPolicyName: "exponentialRetryPolicy"
Típus
"exponentialRetryPolicy"
formDataPolicyName
A formDataPolicy programozott azonosítója.
formDataPolicyName: "formDataPolicy"
Típus
"formDataPolicy"
logPolicyName
A logPolicy programozott azonosítója.
logPolicyName: "logPolicy"
Típus
"logPolicy"
ndJsonPolicyName
Az ndJsonPolicy programozott azonosítója.
ndJsonPolicyName: "ndJsonPolicy"
Típus
"ndJsonPolicy"
proxyPolicyName
A proxyPolicy programozott azonosítója.
proxyPolicyName: "proxyPolicy"
Típus
"proxyPolicy"
redirectPolicyName
A redirectPolicy programozott azonosítója.
redirectPolicyName: "redirectPolicy"
Típus
"redirectPolicy"
setClientRequestIdPolicyName
A setClientRequestIdPolicy programozott azonosítója.
setClientRequestIdPolicyName: "setClientRequestIdPolicy"
Típus
"setClientRequestIdPolicy"
systemErrorRetryPolicyName
A systemErrorRetryPolicy programos azonosítója.
systemErrorRetryPolicyName: "systemErrorRetryPolicy"
Típus
"systemErrorRetryPolicy"
throttlingRetryPolicyName
A throttling programmatikus azonosítójaRetryPolicy.
throttlingRetryPolicyName: "throttlingRetryPolicy"
Típus
"throttlingRetryPolicy"
tracingPolicyName
A tracingPolicy programozott azonosítója.
tracingPolicyName: "tracingPolicy"
Típus
"tracingPolicy"
userAgentPolicyName
A userAgentPolicy programos azonosítója.
userAgentPolicyName: "userAgentPolicy"
Típus
"userAgentPolicy"