你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@azure/ms-rest-js package
Api |
使用 API 密钥对服务进行身份验证。 |
Azure |
此类提供了一个简单的扩展,可从库中使用<xref:TokenCredential> |
Base |
|
Basic |
|
Default |
|
Domain |
使用 API 密钥对服务进行身份验证。 |
Http |
HTTP 标头键/值对的集合。 |
Request |
创建 RequestPolicy 时可以使用的可选属性。 |
Rest |
|
Serializer | |
Service |
|
Token |
使用令牌字符串和创作方案进行身份验证的凭据对象。 |
Topic |
使用 API 密钥对服务进行身份验证。 |
URLBuilder |
处理创建、修改和分析 URL 的类。 |
URLQuery |
处理 URLBuilder 的查询部分的类。 |
Web |
创建新的 WebResource 对象。 此类通过与库/实现无关并包装启动请求所需的属性来提供 REST 调用的抽象。 |
Abort |
允许在触发“中止”事件时中止请求。 与浏览器内置 AbortSignal 和常见 polyfill 兼容。 |
Agent |
HTTP 和 HTTPS 代理 (Node.js 仅) |
Api |
|
Base |
|
Composite |
|
Composite |
|
Deserialization |
指示应以特定方式反序列化操作响应的内容类型。 |
Dictionary |
|
Dictionary |
|
Enum |
|
Enum |
|
Http |
一个接口,可以发送 HttpRequest 并接收承诺的 HttpResponses。 |
Http |
HttpHeaders 集合中的单个标头。 |
Http |
HTTP 标头键/值对的集合。 |
Http |
http 请求和响应的包装器对象。 当以 JSON 或 XML 收到响应正文时,反序列化对象存储在 |
Http |
可添加到 HttpPipeline 的记录器。 这使每个 RequestPolicy 能够记录可用于调试的消息。 |
Http |
始终存在的 HTTP 响应的属性。 |
Mapper |
|
Operation |
应用于操作的单个调用的属性集合。 |
Operation |
所有 Operation 参数扩展的通用接口。 |
Operation |
操作的参数,该操作将作为查询参数添加到操作的 HTTP 请求。 |
Operation |
可从单个状态代码的操作请求返回的 OperationResponse。 |
Operation |
定义操作的规范。 |
Operation |
操作的参数,将替换为操作的请求 URL。 |
Parameter |
在 RequestPrepareOptions 中为路径或查询参数提供的参数值 |
Polymorphic |
|
Proxy |
HTTP 代理设置 (Node.js 仅) |
Redirect |
有关如何处理重定向响应的选项。 |
Request |
描述将用于每个操作的 options 对象的基本结构。 |
Request |
|
Request |
创建 RequestPolicy 时可以使用的可选属性。 |
Request |
|
Rest |
对 REST 调用的平展响应。 包含基础 HttpOperationResponse 以及 parsedBody、parsedHeaders 等的合并属性。 |
Sequence |
|
Sequence |
|
Service |
|
Service |
|
Service |
创建客户端时要提供的选项。 |
Simple |
|
Token |
TokenResponse 在 中 |
Url |
|
Web |
REST 调用的抽象。 |
Authenticator | |
Common |
|
Common |
|
Common |
|
Http |
|
Http |
|
Mapper | |
Mapper |
|
Parameter |
|
Raw |
表示为简单 JSON 对象的 HttpHeaders 集合。 |
Request |
为每个请求创建一个新的 RequestPolicy,该请求使用提供的 nextPolicy。 |
Telemetry |
|
Transfer |
触发以响应上传或下载进度。 |
Http |
可与 HttpPipelineLogger 一起使用的不同日志级别。 |
Query |
用于将查询参数值的值数组联接在一起的格式。 |
function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory
参数
- agentSettings
- AgentSettings
返回
将 sourceCtors 原型上的属性应用于 targetCtor 的原型
function applyMixins(targetCtor: any, sourceCtors: any[])
参数
- targetCtor
-
any
需要对其应用属性的目标对象。
- sourceCtors
-
any[]
需要从中获取属性的源对象的数组。
setTimeout 的包装器,用于解析 t 毫秒后的承诺。
function delay<T>(t: number, value?: T): Promise<T>
参数
- t
-
number
要延迟的毫秒数。
- value
-
T
超时为 t 毫秒后要解析的值。
返回
Promise<T>
已解决的承诺
创建新的序列化 RequestPolicyCreator,用于在 HTTP 管道中传递时序列化 HTTP 请求正文。
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory
参数
- deserializationContentTypes
- DeserializationContentTypes
返回
function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse): Promise<HttpOperationResponse>
参数
- jsonContentTypes
-
string[]
- xmlContentTypes
-
string[]
- response
- HttpOperationResponse
返回
Promise<HttpOperationResponse>
对 URI 进行编码。
function encodeUri(uri: string): string
参数
- uri
-
string
要编码的 URI。
返回
string
编码的 URI。
按顺序执行承诺数组。 此方法的灵感来源如下: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html。 关于承诺的真棒博客!
function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>
参数
- promiseFactories
-
any[]
一个承诺工厂数组 (返回承诺) 的函数
- kickstart
-
any
输入用于启动承诺链的第一个承诺。 如果未提供,则承诺链以未定义开头。
返回
Promise<any>
已解决或拒绝的承诺链
function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory
参数
- retryCount
-
number
- retryInterval
-
number
- minRetryInterval
-
number
- maxRetryInterval
-
number
返回
function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse
参数
- _response
- HttpOperationResponse
- responseSpec
-
undefined | OperationResponse
返回
function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory
参数
- requestIdHeaderName
-
string
返回
生成的 UUID
function generateUuid(): string
返回
string
RFC4122 v4 UUID。
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined
参数
- proxyUrl
-
string
返回
ProxySettings | undefined
function getDefaultUserAgentValue(): string
返回
string
指示给定字符串是否采用 ISO 8601 格式。
function isDuration(value: string): boolean
参数
- value
-
string
要验证的 ISO 8601 持续时间格式的值。
返回
boolean
true
如果有效, false
则为 ;否则为 。
将给定的 uuid 验证为字符串
function isValidUuid(uuid: string): boolean
参数
- uuid
-
string
作为需要验证的字符串的 uuid
返回
boolean
如果 uuid 有效,则为 True;否则为 false。
警告
现已弃用此 API。
generated code should instead depend on responseToBody
将 Promise 转换为回调。
function promiseToCallback(promise: Promise<any>): Function
参数
- promise
-
Promise<any>
要转换为回调的承诺
返回
Function
采用回调 (cb: 函数) : void 的函数
将 Promise 转换为服务回调。
function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function
参数
- promise
-
Promise<HttpOperationResponse>
要转换为服务回调的 HttpOperationResponse 的承诺
返回
Function
采用服务回调的函数 (cb: ServiceCallback) : void
function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory
参数
- proxySettings
- ProxySettings
返回
function redirectPolicy(maximumRetries?: number): RequestPolicyFactory
参数
- maximumRetries
-
number
返回
function serializeObject(toSerialize: any): any
参数
- toSerialize
-
any
返回
any
function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory
参数
- authenticationProvider
- ServiceClientCredentials
返回
返回不包含 Authorization 标头的 Http 请求的剥离版本。
function stripRequest(request: WebResourceLike): WebResourceLike
参数
- request
- WebResourceLike
Http 请求对象
返回
Http 请求的剥离版本。
返回仅包含正文、标头和状态的 Http 响应的剥离版本。
function stripResponse(response: HttpOperationResponse): any
参数
- response
- HttpOperationResponse
Http 响应
返回
any
Http 响应的剥离版本。
function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory
参数
- retryCount
-
number
- retryInterval
-
number
- minRetryInterval
-
number
- maxRetryInterval
-
number
返回
function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory
参数
- maxRetries
-
number
返回
function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory
参数
- userAgentData
- TelemetryInfo