你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/core-http package

AccessTokenRefresher

如果当前未等待新令牌,可帮助 core-http 令牌身份验证策略请求新令牌。

ApiKeyCredentials

使用 API 密钥对服务进行身份验证。

BaseRequestPolicy

从中派生所有请求策略的基类。

BasicAuthenticationCredentials

使用用户名和密码进行身份验证的简单 <xref:ServiceClientCredential> 。

DefaultHttpClient

使用 node-fetch的 HTTP 客户端。

ExpiringAccessTokenCache

提供 AccessTokenCache 实现,该实现在 expiresOnTimestamp 通过后清除缓存的 AccessToken

HttpHeaders

HTTP 标头键/值对的集合。

RequestPolicyOptions

创建 RequestPolicy 时可以使用的可选属性。

RestError

服务终结点的 HTTP 请求导致的错误。

Serializer

用于将原始响应对象映射到最终形状。 帮助打包和解压缩日期和其他不是 JSON 固有的编码类型。 还允许从标头中拉取值,以及插入默认值和常量。

ServiceClient

ServiceClient 发送服务请求并接收响应。

TopicCredentials

用于Azure 事件网格的 TopicCredentials 对象。

URLBuilder

处理创建、修改和分析 URL 的类。

URLQuery

处理 URLBuilder 的查询部分的类。

WebResource

创建新的 WebResource 对象。

此类通过与库/实现无关并包装启动请求所需的属性来提供 REST 调用的抽象。

接口

AbortSignalLike

允许在触发“中止”事件时中止请求。 与浏览器内置 AbortSignal 和通用 polyfill 兼容。

AccessToken

表示具有过期时间的访问令牌。

AccessTokenCache

为从 TokenCredential 返回的 AccessToken 提供缓存。

ApiKeyCredentialOptions

描述创建 ApiKeyCredentials 实例时要提供的选项

BaseMapper

映射器的基本定义。 可用于 XML 和纯 JavaScript 对象。

CompositeMapper

由其他映射器组成的映射器。

CompositeMapperType

帮助生成描述如何基于其他映射器映射对象的一组属性的映射器。

应仅存在以下属性之一: classNamemodelPropertiesadditionalProperties

DeserializationContentTypes

指示应以特定方式反序列化操作响应的内容类型。

DeserializationOptions

用于配置 API 响应反序列化的选项。

DictionaryMapper

描述用作键/值对的纯 JavaScript 对象的映射器。

DictionaryMapperType

帮助生成描述如何分析映射值的字典的映射器。

EnumMapper

描述枚举值的映射器。

EnumMapperType

帮助生成描述如何分析枚举值的映射器。

GetTokenOptions

定义 TokenCredential.getToken 的选项。

HttpClient

可以发送 HttpRequests 并接收承诺的 HttpRespons 的接口。

HttpHeader

HttpHeaders 集合中的单个标头。

HttpHeadersLike

HTTP 标头键/值对的集合。

HttpOperationResponse

http 请求和响应的包装器对象。 当以 JSON 或 XML 格式收到响应正文时,反序列化的对象存储在 parsedBody 属性中。

HttpPipelineLogger

可添加到 HttpPipeline 的记录器。 这使每个 RequestPolicy 能够记录可用于调试目的的消息。

HttpResponse

始终存在的 HTTP 响应的属性。

InternalPipelineOptions

定义用于为 SDK 客户端配置 HTTP 管道的内部选项的选项。

KeepAliveOptions

有关如何为将来的请求维护 HTTP 连接的选项。

LogPolicyOptions

要传递给 logPolicy 的选项。 默认情况下,仅记录一组标头列表,但可以对此进行配置。 从不记录请求和响应正文。

MapperConstraints

各种值约束(如整数范围和字符串正则表达式)的说明。

OperationArguments

应用于操作的单个调用的属性集合。

OperationOptions

所有操作的基选项类型。

OperationParameter

所有 Operation 参数扩展的通用接口。

OperationQueryParameter

操作的参数,该操作将作为查询参数添加到操作的 HTTP 请求。

OperationRequestOptions

允许配置对 SDK 操作发出的 HTTP 请求的处理的选项。

OperationResponse

可从单个状态代码的操作请求返回的 OperationResponse。

OperationSpec

定义如何通过 HTTP 执行特定服务操作的规范,包括如何正确将请求信息序列化到 中,以及如何将响应信息反序列化为 ServiceClient 可返回的对象有效负载。

OperationURLParameter

操作的参数,将替换为操作的请求 URL。

ParameterValue

在 RequestPrepareOptions 中为路径或查询参数提供的参数值

PipelineOptions

定义用于为 SDK 客户端配置 HTTP 管道的选项。

PolymorphicDiscriminator

用于消除可区分类型联合的歧义。 例如,如果响应可以具有许多形状,但也包括 (或类似) 的“kind”字段,则可以使用该字段来确定如何将响应反序列化为正确的类型。

ProxySettings

为传出请求 (Node.js 配置代理的选项仅) 。

RedirectOptions

有关如何处理重定向响应的选项。

RequestOptionsBase

描述将用于每个操作的 options 对象的基本结构。

RequestPolicy

请求策略的基础结构。

RequestPolicyOptionsLike

创建 RequestPolicy 时可以使用的可选属性。

RequestPrepareOptions

用于准备传出 HTTP 请求的选项。

RestResponse

对 REST 调用的平展响应。 包含基础 HttpOperationResponse 以及 、 parsedHeaders等的parsedBody合并属性。

RetryOptions

控制如何重试失败请求的选项。

SequenceMapper

描述数组的映射器。

SequenceMapperType

帮助生成描述如何分析映射值的序列的映射器。

SerializerOptions

用于控制 xml 分析器和生成器行为的选项。

ServiceCallback
ServiceClientCredentials

表示对象或类,该方法 signRequest 将 (传出请求进行签名,例如,通过设置 Authorization 标头) 。

ServiceClientOptions

创建客户端时要提供的选项。

SimpleMapperType

简单映射器的类型。

TokenCredential

表示能够提供身份验证令牌的凭据。

TracingPolicyOptions

用于自定义跟踪策略的选项。

UrlParameterValue

表示 URL 参数值的接口。

UserAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

WebResourceLike

要向远程服务器发出的 HTTP 请求的说明。

类型别名

Authenticator

接收质询并使用字符串令牌解析承诺的函数。

CommonRequestInfo

调用 fetch()时使用的字符串 URL。

CommonRequestInit

包含有关传出 HTTP 请求的信息的 对象。

CommonResponse

包含有关传入 HTTP 响应的信息的对象。

HttpMethods

支持的 HTTP 方法列表。

HttpRequestBody

可能的 HTTP 请求正文类型

Mapper

映射器是库中使用的数据模型的定义。 这些数据模型是响应或参数中的操作或客户端定义的一部分。

MapperType

映射器的类型。 包括已知的映射器。

ParameterPath

描述如何访问给定对象数据源中的特定属性的路径。 可以是单个属性名称、一个表示嵌套属性名称的数组,或者一组具有复杂对象值路径的多个命名属性。

ProxyOptions

ProxySettings 的别名,供将来使用。

RawHttpHeaders

表示为简单 JSON 对象的 HttpHeaders 集合。

RequestPolicyFactory

为每个请求创建一个新的 RequestPolicy,该请求使用提供的 nextPolicy。

TelemetryInfo

遥测信息。 要包含在User-Agent字符串中的键/值对。

TransferProgressEvent

触发以响应上传或下载进度。

枚举

HttpPipelineLogLevel

可与 HttpPipelineLogger 一起使用的不同级别的日志。

QueryCollectionFormat

用于将查询参数值的值数组联接在一起的格式。

RetryMode

介绍重试模式类型。 目前仅支持指数。

函数

applyMixins(unknown, any[])

将 sourceCtors 原型上的属性应用于 targetCtor 的原型

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

为 RequestPolicy 创建一个新工厂,该工厂将持有者令牌应用于请求的 Authorization 标头。

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

基于给定选项创建 HTTP 管道。

delay(number, DelayOptions)

setTimeout 的包装器,用于解析 timeInMs 毫秒后的承诺。

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

创建新的序列化 RequestPolicyCreator,用于在 HTTP 管道中传递时序列化 HTTP 请求正文。

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

给定一组要分析为 JSON 或 XML 的特定内容类型,使用 HTTP 响应生成由请求的 OperationSpec 定义的结果对象。

disableResponseDecompressionPolicy()

返回可用于创建 实例 <xref:DisableResponseDecompressionPolicy>的请求策略工厂。

encodeUri(string)

对 URI 进行编码。

executePromisesSequentially(any[], unknown)

按顺序执行承诺数组。 此方法的灵感来源如下: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html。 关于承诺的真棒博客!

exponentialRetryPolicy(number, number, number)

该策略在指定的最大重试时间间隔内重试请求的次数与配置的次数一样长,每次重试的开始时间比上次要长。

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

HttpOperationResponse 分析为规范化的 HTTP 响应对象, (RestResponse) 。

generateClientRequestIdPolicy(string)

创建一个策略,该策略将唯一的请求 ID 分配给传出请求。

generateUuid()

生成的 UUID

getDefaultProxySettings(string)

将代理服务器的给定 URL 转换为 ProxySettings 或尝试从当前环境中检索 ProxySettings (如果未传递)。

getDefaultUserAgentValue()

生成用户代理的默认方法。 使用此包中的静态信息,以及运行时提供的系统信息。

isDuration(string)

指示给定字符串是否采用 ISO 8601 格式。

isTokenCredential(unknown)

测试对象以确定它是否实现 TokenCredential。

isValidUuid(string)

将给定的 uuid 验证为字符串

keepAlivePolicy(KeepAliveOptions)

创建一个策略,用于控制是否在将来的请求上维护 HTTP 连接。

logPolicy(LogPolicyOptions)

创建一个策略,用于记录有关传出请求和传入响应的信息。

operationOptionsToRequestOptionsBase<T>(T)

将 OperationOptions 转换为 RequestOptionsBase

parseXML(string, SerializerOptions)

将给定的 XML 字符串转换为 JSON

promiseToCallback(Promise<any>)

将 Promise 转换为回调。

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

将 Promise 转换为服务回调。

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

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

redirectPolicy(number)

创建重定向策略,如果响应到达时包含“location”标头,并且状态代码介于 300 和 307 之间,则向新目标发送重复请求。

serializeObject(unknown)

实用工具函数,将可能包含二进制信息的对象序列化为纯对象、数组或字符串。

signingPolicy(ServiceClientCredentials)

创建一个策略,该策略通过调用提供的 authenticationProvider方法 signRequest 对传出请求进行签名。

stringifyXML(unknown, SerializerOptions)

将给定的 JSON 对象转换为 XML 字符串

stripRequest(WebResourceLike)

返回不包含 Authorization 标头的 Http 请求的剥离版本。

stripResponse(HttpOperationResponse)

返回仅包含正文、标头和状态的 Http 响应的剥离版本。

systemErrorRetryPolicy(number, number, number, number)

出现系统错误时重试的策略,由代码“ETIMEDOUT”、“ESOCKETTIMEDOUT”、“ECONNREFUSED”、“ECONNRESET”或“ENOENT”标识。

throttlingRetryPolicy()

创建一个策略,该策略在响应指示请求由于限制原因而失败时重新发送请求。 例如,如果响应包含标头 Retry-After ,它将根据该标头的值重试发送请求。

若要了解详细信息,请参阅 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitshttps://docs.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

tracingPolicy(TracingPolicyOptions)

创建一个策略,该策略使用跟踪范围包装传出请求。

userAgentPolicy(TelemetryInfo)

返回一个策略,该策略根据给定的 TelemetryInfo 将用户代理标头添加到传出请求。

函数详细信息

applyMixins(unknown, any[])

将 sourceCtors 原型上的属性应用于 targetCtor 的原型

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

参数

targetCtorParam

unknown

sourceCtors

any[]

需要从中获取属性的源对象的数组。

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

为 RequestPolicy 创建一个新工厂,该工厂将持有者令牌应用于请求的 Authorization 标头。

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

参数

credential
TokenCredential

可提供持有者令牌的 TokenCredential 实现。

scopes

string | string[]

持有者令牌适用的范围。

返回

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

基于给定选项创建 HTTP 管道。

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

参数

pipelineOptions
InternalPipelineOptions

定义用于在 HTTP 管道中为 SDK 客户端配置策略的选项。

authPolicyFactory
RequestPolicyFactory

用于对请求进行签名的可选身份验证策略工厂。

返回

一组可传递用于创建新 ServiceClient 的选项。

delay(number, DelayOptions)

setTimeout 的包装器,用于解析 timeInMs 毫秒后的承诺。

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

参数

timeInMs

number

要延迟的毫秒数。

options
DelayOptions

延迟选项 - 当前中止选项

返回

Promise<void>

在 timeInMs 之后解决的承诺

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

创建新的序列化 RequestPolicyCreator,用于在 HTTP 管道中传递时序列化 HTTP 请求正文。

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

参数

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

返回

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

给定一组要分析为 JSON 或 XML 的特定内容类型,使用 HTTP 响应生成由请求的 OperationSpec 定义的结果对象。

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>

参数

jsonContentTypes

string[]

响应内容类型,将正文分析为 JSON。

xmlContentTypes

string[]

响应内容类型,将正文分析为 XML。

response
HttpOperationResponse

来自管道的 HTTP 响应。

options
SerializerOptions

序列化程序的选项,主要用于配置 XML 分析程序(如果需要)。

返回

ServiceClient 可返回的已分析 HttpOperationResponse 对象。

disableResponseDecompressionPolicy()

返回可用于创建 实例 <xref:DisableResponseDecompressionPolicy>的请求策略工厂。

function disableResponseDecompressionPolicy(): RequestPolicyFactory

返回

encodeUri(string)

对 URI 进行编码。

function encodeUri(uri: string): string

参数

uri

string

要编码的 URI。

返回

string

编码的 URI。

executePromisesSequentially(any[], unknown)

按顺序执行承诺数组。 此方法的灵感来源如下: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html。 关于承诺的真棒博客!

function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>

参数

promiseFactories

any[]

(返回 promise) 函数的 promise 工厂数组

kickstart

unknown

输入用于启动承诺链的第一个承诺。 如果未提供,则承诺链以未定义开头。

返回

Promise<any>

已解决或拒绝的承诺链

exponentialRetryPolicy(number, number, number)

该策略在指定的最大重试时间间隔内重试请求的次数与配置的次数一样长,每次重试的开始时间比上次要长。

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

参数

retryCount

number

最大重试次数。

retryInterval

number

两次重试之间的基准时间。

maxRetryInterval

number

两次重试之间等待的最长时间。

返回

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

HttpOperationResponse 分析为规范化的 HTTP 响应对象, (RestResponse) 。

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

参数

_response
HttpOperationResponse

http 响应的包装器对象。

responseSpec

undefined | OperationResponse

用于分析响应属性的映射器。

返回

  • 规范化响应对象。

generateClientRequestIdPolicy(string)

创建一个策略,该策略将唯一的请求 ID 分配给传出请求。

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

参数

requestIdHeaderName

string

向请求分配唯一 ID 时要使用的标头的名称。

返回

generateUuid()

生成的 UUID

function generateUuid(): string

返回

string

RFC4122 v4 UUID。

getDefaultProxySettings(string)

将代理服务器的给定 URL 转换为 ProxySettings 或尝试从当前环境中检索 ProxySettings (如果未传递)。

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

参数

proxyUrl

string

代理的 URL

返回

ProxySettings | undefined

默认代理设置,或未定义。

getDefaultUserAgentValue()

生成用户代理的默认方法。 使用此包中的静态信息,以及运行时提供的系统信息。

function getDefaultUserAgentValue(): string

返回

string

isDuration(string)

指示给定字符串是否采用 ISO 8601 格式。

function isDuration(value: string): boolean

参数

value

string

要验证的 ISO 8601 持续时间格式的值。

返回

boolean

true 如果有效,则为 ; false 否则为 。

isTokenCredential(unknown)

测试对象以确定它是否实现 TokenCredential。

function isTokenCredential(credential: unknown): credential

参数

credential

unknown

要测试的假定 TokenCredential。

返回

credential

isValidUuid(string)

将给定的 uuid 验证为字符串

function isValidUuid(uuid: string): boolean

参数

uuid

string

作为需要验证的字符串的 uuid

返回

boolean

如果 uuid 有效,则为 True;否则为 false。

keepAlivePolicy(KeepAliveOptions)

创建一个策略,用于控制是否在将来的请求上维护 HTTP 连接。

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

参数

keepAliveOptions
KeepAliveOptions

“保持活动状态”选项。 默认情况下,为将来的请求维护 HTTP 连接。

返回

的实例 <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

创建一个策略,用于记录有关传出请求和传入响应的信息。

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

参数

loggingOptions
LogPolicyOptions

日志记录选项。

返回

的实例 <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

将 OperationOptions 转换为 RequestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

参数

opts

T

要转换为 RequestOptionsBase 的 OperationOptions 对象

返回

parseXML(string, SerializerOptions)

将给定的 XML 字符串转换为 JSON

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

参数

str

string

包含要分析为 JSON 的 XML 内容的字符串

opts
SerializerOptions

控制给定 xml 字符串分析的选项

返回

Promise<any>

promiseToCallback(Promise<any>)

警告

现已弃用此 API。

generated code should instead depend on responseToBody

将 Promise 转换为回调。

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

参数

promise

Promise<any>

要转换为回调的 Promise

返回

(cb: Function) => void

采用回调的函数 (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

将 Promise 转换为服务回调。

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

参数

promise

Promise<HttpOperationResponse>

要转换为服务回调的 HttpOperationResponse 的承诺

返回

(cb: ServiceCallback<T>) => void

采用服务回调 (cb: ServiceCallback) : void 的函数

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

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

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

参数

proxySettings
ProxySettings

要在每个请求上使用的 ProxySettings。

options

{ customNoProxyList?: string[] }

其他设置,例如自定义NO_PROXY模式

返回

redirectPolicy(number)

创建重定向策略,如果响应到达时包含“location”标头,并且状态代码介于 300 和 307 之间,则向新目标发送重复请求。

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

参数

maximumRetries

number

要跟踪的最大重定向数。

返回

的实例 <xref:RedirectPolicy>

serializeObject(unknown)

实用工具函数,将可能包含二进制信息的对象序列化为纯对象、数组或字符串。

function serializeObject(toSerialize: unknown): any

参数

toSerialize

unknown

返回

any

signingPolicy(ServiceClientCredentials)

创建一个策略,该策略通过调用提供的 authenticationProvider方法 signRequest 对传出请求进行签名。

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

参数

authenticationProvider
ServiceClientCredentials

验证提供程序。

返回

<xref:SigningPolicy>实例。

stringifyXML(unknown, SerializerOptions)

将给定的 JSON 对象转换为 XML 字符串

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

参数

obj

unknown

要转换为 XML 字符串的 JSON 对象

opts
SerializerOptions

控制给定 JSON 对象的分析的选项

返回

string

stripRequest(WebResourceLike)

返回不包含 Authorization 标头的 Http 请求的剥离版本。

function stripRequest(request: WebResourceLike): WebResourceLike

参数

request
WebResourceLike

Http 请求对象

返回

Http 请求的去除版本。

stripResponse(HttpOperationResponse)

返回仅包含正文、标头和状态的 Http 响应的剥离版本。

function stripResponse(response: HttpOperationResponse): any

参数

response
HttpOperationResponse

Http 响应

返回

any

Http 响应的去除版本。

systemErrorRetryPolicy(number, number, number, number)

出现系统错误时重试的策略,由代码“ETIMEDOUT”、“ESOCKETTIMEDOUT”、“ECONNREFUSED”、“ECONNRESET”或“ENOENT”标识。

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

参数

retryCount

number

最大重试次数。

retryInterval

number

客户端重试间隔(以毫秒为单位)。

minRetryInterval

number

最小重试间隔(以毫秒为单位)。

maxRetryInterval

number

最大重试间隔(以毫秒为单位)。

返回

的实例 <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

创建一个策略,该策略在响应指示请求由于限制原因而失败时重新发送请求。 例如,如果响应包含标头 Retry-After ,它将根据该标头的值重试发送请求。

若要了解详细信息,请参阅 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitshttps://docs.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

返回

tracingPolicy(TracingPolicyOptions)

创建一个策略,该策略使用跟踪范围包装传出请求。

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

参数

tracingOptions
TracingPolicyOptions

跟踪选项。

返回

<xref:TracingPolicy> 类的实例。

userAgentPolicy(TelemetryInfo)

返回一个策略,该策略根据给定的 TelemetryInfo 将用户代理标头添加到传出请求。

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

参数

userAgentData
TelemetryInfo

遥测信息。

返回

一个新的 <xref:UserAgentPolicy>。