你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
@azure/core-rest-pipeline package
类
| RestError |
失败管道请求的自定义错误类型。 |
接口
| AddPipelineOptions |
将策略添加到管道时的选项。 用于表示对其他策略的依赖关系。 |
| Agent |
与 NodeJS 的 |
| AuthorizeRequestOnChallengeOptions |
发送到 authorizeRequestOnChallenge 回调的选项 |
| AuthorizeRequestOptions |
发送到 authorizeRequest 回调的选项 |
| AuxiliaryAuthenticationHeaderPolicyOptions |
用于配置 auxiliaryAuthenticationHeaderPolicy 的选项 |
| BearerTokenAuthenticationPolicyOptions |
配置 bearerTokenAuthenticationPolicy 的选项 |
| ChallengeCallbacks |
用于替代 连续访问评估 质询处理的选项。 |
| DefaultRetryPolicyOptions |
用于控制如何重试失败请求的选项。 |
| ExponentialRetryPolicyOptions |
用于控制如何重试失败请求的选项。 |
| HttpClient |
代表管道发出 HTTP 请求的客户端所需的接口。 |
| HttpHeaders |
表示请求/响应上的一组 HTTP 标头。 标头名称被视为不区分大小写。 |
| InternalPipelineOptions |
定义用于为 SDK 客户端配置 HTTP 管道的内部选项的选项。 |
| KeyObject |
与 NodeJS 的 |
| LogPolicyOptions |
用于配置 logPolicy 的选项。 |
| Pipeline |
表示用于向 URL 发出 HTTP 请求的管道。 管道可以有多个策略来管理在向服务器发出每个请求之前和之后的操作。 |
| PipelineOptions |
定义用于为 SDK 客户端配置 HTTP 管道的选项。 |
| PipelinePolicy |
管道策略在请求通过管道时对其进行操作。 从概念上讲，它是一个中间件，允许在发出请求之前修改请求，以及在收到请求时修改响应。 |
| PipelineRequest |
有关管道发出的请求的元数据。 |
| PipelineRequestOptions |
用于初始化请求的设置。 几乎等效于 Partial，但 URL 是必需的。 |
| PipelineResponse |
有关管道收到的响应的元数据。 |
| PipelineRetryOptions |
用于控制如何重试失败请求的选项。 |
| ProxySettings |
为传出请求 (Node.js 配置代理的选项仅) 。 |
| PxfObject |
与 NodeJS 的 |
| RedirectPolicyOptions |
有关如何处理重定向响应的选项。 |
| RestErrorOptions |
RestError 支持的选项。 |
| RetryInformation |
提供给重试策略的有关重试策略当前进度的信息。 |
| RetryModifiers |
可以修改重试策略行为的属性。 |
| RetryPolicyOptions |
retryPolicy 的选项 |
| RetryStrategy |
重试策略旨在定义是否重试以及如何重试。 |
| SystemErrorRetryPolicyOptions |
用于控制如何重试失败请求的选项。 |
| TelemetryOptions |
定义用于配置常见遥测和跟踪信息的选项 |
| ThrottlingRetryPolicyOptions |
用于控制如何重试失败请求的选项。 |
| TlsSettings |
表示 TLS 身份验证的证书。 |
| TracingPolicyOptions |
用于配置跟踪策略的选项。 |
| UserAgentPolicyOptions |
用于将用户代理详细信息添加到传出请求的选项。 |
类型别名
| FormDataMap |
提供表单数据的简单对象，就像来自浏览器窗体一样。 |
| FormDataValue |
每个表单数据条目可以是浏览器中) Blob 的字符串或 (。 |
| HttpMethods |
支持在发出请求时使用的 HTTP 方法。 |
| PipelinePhase |
策略分阶段执行。 执行顺序为：
|
| RawHttpHeaders |
表示为简单 JSON 对象的 HttpHeaders 集合。 |
| RawHttpHeadersInput |
用于输入的 HttpHeaders 集合，表示为简单的 JSON 对象。 |
| RequestBodyType |
请求支持的正文类型。 NodeJS.ReadableStream 和 () => NodeJS.ReadableStream 仅限 Node。 Blob、ReadableStream 和 () => ReadableStream 仅限浏览器。 |
| SendRequest |
用于发出管道请求和接收响应的简单接口。 |
| TransferProgressEvent |
触发以响应上传或下载进度。 |
函数
函数详细信息
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
外部令牌到 x-ms-authorization-auxiliary 标头的策略。
创建跨租户应用程序时，我们可能需要处理不同租户中的资源的身份验证请求时，将使用此标头。
可以查看有关此功能工作原理的 ARM 文档
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy参数
返回
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
可以从 TokenCredential 实现请求令牌，然后将其作为持有者令牌应用于请求的 Authorization 标头的策略。
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy参数
返回
createDefaultHttpClient()
createEmptyPipeline()
createHttpHeaders(RawHttpHeadersInput)
创建满足 接口的 HttpHeaders 对象。
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders参数
- rawHeaders
- RawHttpHeadersInput
表示初始标头的简单对象
返回
createPipelineFromOptions(InternalPipelineOptions)
使用一组默认的可自定义策略创建新管道。
function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline参数
- options
- InternalPipelineOptions
用于配置自定义管道的选项。
返回
createPipelineRequest(PipelineRequestOptions)
使用给定选项创建新的管道请求。 此方法允许轻松设置默认值，而不是必需的。
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest参数
- options
- PipelineRequestOptions
用于创建请求的选项。
返回
decompressResponsePolicy()
根据 Accept-Encoding 标头启用响应解压缩的策略 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
function decompressResponsePolicy(): PipelinePolicy返回
defaultRetryPolicy(DefaultRetryPolicyOptions)
根据三种策略重试的策略：
- 当服务器发送具有 Retry-After 标头的 429 响应时。
- 当基础传输层 (出现错误时，例如 DNS 查找失败) 。
- 否则，如果传出请求失败，它将重试，延迟呈指数级增长。
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy参数
- options
- DefaultRetryPolicyOptions
返回
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
一种策略，该策略尝试重试请求，同时引入呈指数级增长的延迟。
function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy参数
- options
- ExponentialRetryPolicyOptions
配置重试逻辑的选项。
返回
formDataPolicy()
getDefaultProxySettings(string)
此方法将代理 URL 转换为 ， ProxySettings 以便与 ProxyPolicy 一起使用。
如果未给出任何参数，则尝试从环境变量 HTTPS_PROXY 或 HTTP_PROXY分析代理 URL。
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined参数
- proxyUrl
-
string
要使用的代理的 URL。 可能包含身份验证信息。
返回
ProxySettings | undefined
isRestError(unknown)
用于 RestError 的 Typeguard
function isRestError(e: unknown): e参数
- e
-
unknown
catch 子句捕获的内容。
返回
e
logPolicy(LogPolicyOptions)
记录所有请求和响应的策略。
function logPolicy(options?: LogPolicyOptions): PipelinePolicy参数
- options
- LogPolicyOptions
用于配置 logPolicy 的选项。
返回
ndJsonPolicy()
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })
允许将代理设置应用于所有请求的策略。 如果未传递静态设置，将从HTTPS_PROXY或HTTP_PROXY环境变量中检索这些设置。
function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy参数
- proxySettings
- ProxySettings
要在每个请求上使用的 ProxySettings。
- options
-
{ customNoProxyList?: string[] }
其他设置，例如自定义NO_PROXY模式
返回
redirectPolicy(RedirectPolicyOptions)
遵循服务器中 Location 标头以支持服务器端重定向的策略。 在浏览器中，不使用此策略。
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy参数
- options
- RedirectPolicyOptions
用于控制策略行为的选项。
返回
retryPolicy(RetryStrategy[], RetryPolicyOptions)
retryPolicy 是一种通用策略，用于在满足特定条件时启用重试请求
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy参数
- strategies
- options
- RetryPolicyOptions
返回
setClientRequestIdPolicy(string)
每个 PipelineRequest 在创建时获取唯一 ID。 此策略通过 HTTP 标头传递该唯一 ID，以实现更好的遥测和跟踪。
function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy参数
- requestIdHeaderName
-
string
要向其传递请求 ID 的标头的名称。
返回
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
专门寻求处理基础传输层中的错误的重试策略， (例如 DNS 查找失败) ，而不是服务器本身的可重试错误代码。
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy参数
- options
- SystemErrorRetryPolicyOptions
用于自定义策略的选项。
返回
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)
当服务器发送带有 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(options?: ThrottlingRetryPolicyOptions): PipelinePolicy参数
- options
- ThrottlingRetryPolicyOptions
配置重试逻辑的选项。
返回
tlsPolicy(TlsSettings)
获取将客户端证书添加到 HttpClient 代理以进行身份验证的管道策略。
function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy参数
- tlsSettings
- TlsSettings
返回
tracingPolicy(TracingPolicyOptions)
一个简单的策略，用于为包含具有父级 SpanOptions 的管道发出的每个请求创建 OpenTelemetry 范围。 不会记录在没有父 Span 的情况下发出的请求。
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy参数
- options
- TracingPolicyOptions
用于配置跟踪策略记录的遥测的选项。
返回
userAgentPolicy(UserAgentPolicyOptions)
设置 User-Agent 标头 (或等效) 以反映库版本的策略。
function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy参数
- options
- UserAgentPolicyOptions
用于自定义用户代理值的选项。