@azure/core-https package

原則，可從 TokenCredential 實作要求令牌，然後將它套用至要求作為持有人令牌的授權標頭。

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

參數

傳回

建立完全空白的管線。 適用於測試或建立自定義自定義測試。

function createEmptyPipeline(): Pipeline

傳回

建立滿足 HttpHeaders 介面的物件。

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

參數

傳回

使用一組預設的可自定義原則建立新的管線。

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

參數

傳回

使用指定的選項建立新的管線要求。 這個方法是允許輕鬆設定預設值，而不需要。

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

參數

傳回

根據 Accept-Encoding 標頭啟用回應解壓縮的原則 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

傳回

在引入指數增加延遲時，嘗試重試要求的原則。

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

參數

傳回

在要求上將 FormData 編碼為本文的原則。

function formDataPolicy(): PipelinePolicy

傳回

此方法會將 Proxy URL 轉換成 ProxySettings，以搭配 ProxyPolicy 使用。 如果未指定自變數，它會嘗試從環境變數剖析 proxy URL HTTPS_PROXY 或 HTTP_PROXY。

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

參數

傳回

記錄所有要求和響應的原則。

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

參數

傳回

ndJsonPolicy 是用來控制每個要求保持運作設定的原則。

function ndJsonPolicy(): PipelinePolicy

傳回

允許將 Proxy 設定套用至所有要求的原則。 如果未傳遞靜態設定，則會從HTTPS_PROXY或HTTP_PROXY環境變數擷取它們。

function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy

參數

傳回

要遵循伺服器位置標頭的原則，以支援伺服器端重新導向。

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

參數

傳回

每個 PipelineRequest 在建立時都會取得唯一標識碼。 此原則會透過 HTTP 標頭傳遞該唯一標識碼，以啟用更好的遙測和追蹤。

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

參數

傳回

特別試圖處理基礎傳輸層錯誤（例如 DNS 查閱失敗）而非伺服器本身可重試的錯誤碼的重試原則。

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

參數

傳回

當伺服器傳送具有 Retry-After 標頭的 429 回應時，重試的原則。

若要深入瞭解，請參閱 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 和 https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): PipelinePolicy

傳回

針對具有 SpanOptions 與父系之管線所提出之每個要求的 OpenTelemetry Spans 建立 OpenTelemetry Spans 的簡單原則。 不會記錄沒有父 Span 的要求。

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

參數

傳回

設定 User-Agent 標頭（或對等專案）以反映連結庫版本的原則。

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

參數

傳回

持有者TokenAuthenticationPolicy的程式識別碼。

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

類型

decompressResponsePolicy 的程式識別碼。

decompressResponsePolicyName: "decompressResponsePolicy"

類型

指數重試策略的程式識別碼。

expontentialRetryPolicyName: "exponentialRetryPolicy"

類型

formDataPolicy 的程式識別碼。

formDataPolicyName: "formDataPolicy"

類型

logPolicy 的程式識別碼。

logPolicyName: "logPolicy"

類型

ndJsonPolicy 的程式識別碼。

ndJsonPolicyName: "ndJsonPolicy"

類型

proxyPolicy 的程式識別碼。

proxyPolicyName: "proxyPolicy"

類型

redirectPolicy 的程式識別碼。

redirectPolicyName: "redirectPolicy"

類型

setClientRequestIdPolicy 的程式識別碼。

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

類型

systemErrorRetryPolicy 的程式識別碼。

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

類型

throttlingRetryPolicy 的程式識別碼。

throttlingRetryPolicyName: "throttlingRetryPolicy"

類型

traceingPolicy 的程式識別碼。

tracingPolicyName: "tracingPolicy"

類型

userAgentPolicy 的程式識別碼。

userAgentPolicyName: "userAgentPolicy"

類型