@azure/core-http package

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

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

参数

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

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

参数

返回

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

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

参数

返回

一组可用于创建新的 serviceClient 的选项。

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

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

参数

返回

在 timeInMs 后解决的承诺

创建一个新的序列化 RequestPolicyCreator，它将在 HTTP 管道传递时序列化 HTTP 请求正文。

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

参数

返回

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

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

参数

返回

HttpOperationResponse 对象，该对象可由 ServiceClient返回。

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

function disableResponseDecompressionPolicy(): RequestPolicyFactory

返回

对 URI 进行编码。

function encodeUri(uri: string): string

参数

返回

编码的 URI。

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

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

参数

返回

已解决或拒绝的承诺链

只要指定了最大重试时间间隔，就会重试请求的次数，每次重试等待的时间都长于上次。

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

参数

返回

将 HttpOperationResponse 分析为规范化 HTTP 响应对象（RestResponse）。

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

参数

返回

• 规范化响应对象。

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

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

参数

返回

生成的 UUID

function generateUuid(): string

返回

RFC4122 v4 UUID。

将代理服务器的给定 URL 转换为 ProxySettings，或者在未传递代理服务器时尝试从当前环境中检索 ProxySettings。

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

参数

返回

默认代理设置或未定义。

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

function getDefaultUserAgentValue(): string

返回

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

function isDuration(value: string): boolean

参数

返回

如果有效，则 true 否则 false。

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

function isTokenCredential(credential: unknown): credential

参数

返回

将给定的 uuid 验证为字符串

function isValidUuid(uuid: string): boolean

参数

返回

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

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

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

参数

返回

<xref:KeepAlivePolicy> 实例

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

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

参数

返回

<xref:LogPolicy> 实例

将 OperationOptions 转换为 RequestOptionsBase

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

参数

返回

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

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

参数

返回

将 Promise 转换为回调。

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

参数

返回

获取回调 (cb: Function) => void 的函数

将 Promise 转换为服务回调。

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

参数

返回

获取服务回调的函数 （cb： ServiceCallback）： void

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

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

参数

返回

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

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

参数

返回

<xref:RedirectPolicy> 实例

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

function serializeObject(toSerialize: unknown): any

参数

返回

创建一个策略，通过调用提供的 authenticationProvider的 signRequest 方法来签署传出请求。

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

参数

返回

<xref:SigningPolicy>的实例。

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

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

参数

返回

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

function stripRequest(request: WebResourceLike): WebResourceLike

参数

返回

Http 请求的剥离版本。

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

function stripResponse(response: HttpOperationResponse): any

参数

返回

Http 响应的剥离版本。

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

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

参数

返回

<xref:SystemErrorRetryPolicy> 实例

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

若要了解详细信息，请参阅 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(): RequestPolicyFactory

返回

创建一个策略，用于包装具有跟踪范围的传出请求。

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

参数

返回

<xref:TracingPolicy> 类的实例。

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

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

参数

返回

新的 <xref:UserAgentPolicy>。