@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

返回

此方法将代理 URL 转换为 ProxySettings，以便与 ProxyPolicy 一起使用。 如果未提供任何参数，它将尝试分析环境变量 HTTPS_PROXY 或 HTTP_PROXY中的代理 URL。

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

参数

返回

记录所有请求和响应的策略。

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

参数

返回

ndJsonPolicy 是用于控制每个请求的保持活动设置的策略。

function ndJsonPolicy(): PipelinePolicy

返回

允许将代理设置应用于所有请求的策略。 如果未传递静态设置，将从HTTPS_PROXY或HTTP_PROXY环境变量中检索它们。

function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy

参数

返回

一个策略，用于遵循来自服务器的 Location 标头以支持服务器端重定向。

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

参数

返回

每个 PipelineRequest 在创建时获取唯一 ID。 此策略通过 HTTP 标头传递该唯一 ID，以实现更好的遥测和跟踪。

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 的简单策略。 不会记录在没有父 Span 的情况下发出的请求。

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

参数

返回

设置 User-Agent 标头（或等效）以反映库版本的策略。

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

参数

返回

持有者TokenAuthenticationPolicy的程序标识符。

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

类型

decompressResponsePolicy 的程序标识符。

decompressResponsePolicyName: "decompressResponsePolicy"

类型

指数RetryPolicy的程序标识符。

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"

类型

用户代理策略的程序标识符。

userAgentPolicyName: "userAgentPolicy"

类型