@azure/core-client package
类
| ServiceClient |
初始化 ServiceClient 的新实例。 |
接口
| AdditionalPolicyConfig |
用于配置在构造时添加到管道的其他策略。 |
| BaseMapper |
映射器的基本定义。 可用于 XML 和纯 JavaScript 对象。 |
| CommonClientOptions |
高级客户端应公开的常见选项集。 |
| CompositeMapper |
由其他映射器组成的映射器。 |
| CompositeMapperType |
帮助生成一个映射器,该映射器描述如何基于其他映射器映射对象的一组属性。 应仅存在以下属性之一: |
| DeserializationContentTypes |
指示应以特定方式反序列化作响应的内容类型。 |
| DeserializationPolicyOptions |
用于配置 API 响应反序列化的选项。 |
| DictionaryMapper |
描述用作键/值对的纯 JavaScript 对象的映射器。 |
| DictionaryMapperType |
帮助生成描述如何分析映射值的字典的映射器。 |
| EnumMapper |
描述枚举值的映射器。 |
| EnumMapperType |
帮助生成描述如何分析枚举值的映射器。 |
| FullOperationResponse |
http 请求和响应的包装器对象。 当响应正文以 JSON 或 XML 接收响应正文时,反序列化对象存储在 |
| InternalClientPipelineOptions |
用于创建要用于 ServiceClient 的管道的选项。 主要用于在使用 XML 时自定义身份验证策略(如果使用令牌身份验证)或反序列化选项。 |
| MapperConstraints |
描述各种值约束,例如整数范围和字符串正则表达式。 |
| OperationArguments |
应用于单个作调用的属性集合。 |
| OperationOptions |
所有作的基本选项类型。 |
| OperationParameter |
所有 Operation 参数扩展的通用接口。 |
| OperationQueryParameter |
将作为查询参数添加到作的 HTTP 请求的作的参数。 |
| OperationRequestInfo |
用于正确分析响应的元数据。 |
| OperationRequestOptions |
为此作创建和发送 HTTP 请求时使用的选项。 |
| OperationResponseMap |
可从单个状态代码的作请求返回的 OperationResponse。 |
| OperationSpec |
定义作的规范。 |
| OperationURLParameter |
作的参数,该参数将替换为作的请求 URL。 |
| PolymorphicDiscriminator |
用于消除区分类型联合的歧义。 例如,如果响应可以包含许多形状,但还包括“kind”字段(或类似),该字段可用于确定如何将响应反序列化为正确的类型。 |
| SequenceMapper |
描述数组的映射器。 |
| SequenceMapperType |
帮助生成描述如何分析映射值的序列的映射器。 |
| SerializationPolicyOptions |
用于配置 API 请求序列化的选项。 |
| Serializer |
用于将原始响应对象映射到最终形状。 帮助打包和解压缩日期和其他编码类型,这些类型不是 JSON 固有的。 还允许从标头拉取值,以及插入默认值和常量。 |
| SerializerOptions |
用于配置序列化/取消序列化行为的选项。 |
| ServiceClientOptions |
创建客户端时要提供的选项。 |
| SimpleMapperType |
简单映射器的类型。 |
| SpanConfig |
用于创建新的跟踪范围的配置 |
| XmlOptions |
用于管理 xml 分析器和生成器行为的选项。 |
类型别名
| Mapper |
映射器是库中使用的数据模型的定义。 这些数据模型是响应或参数中的作或客户端定义的一部分。 |
| MapperType |
映射器的类型。 包括已知的映射器。 |
| OperationRequest |
用于将来校对的类型别名。 |
| ParameterPath |
对如何访问对象上的特定属性进行编码。 |
| QueryCollectionFormat |
将用于将值数组联接在一起的查询参数值的格式。 |
| RawResponseCallback |
在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。 |
函数
| authorize |
此函数可用作 使用以下选项调用
提供后, 声明的示例质询:
|
| authorize |
定义用于处理存储 API 的身份验证质询的回调。 这将实现此处所述的持有者质询过程:https://free.blessedness.top/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge 处理具有特定的存储功能,这些功能会迁移到常规 AAD 质询文档。 |
| create |
创建用于服务客户端的新管道。 默认情况下,在反序列化Policy 中添加。 如果传递 TokenCredential,则还添加了 bearerTokenAuthenticationPolicy。 |
| create |
创建和返回序列化程序的方法。 |
| deserialization |
此策略根据请求的 OperationSpecs 处理分析响应。 |
| serialization |
此策略使用 OperationSpec 和 OperationArguments 处理请求的程序集正文和标头。 |
函数详细信息
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
此函数可用作 bearerTokenAuthenticationPolicy@azure/core-rest-pipeline 的回调,以支持 CAE 质询:持续访问评估。
使用以下选项调用 bearerTokenAuthenticationPolicy:
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const policy = bearerTokenAuthenticationPolicy({
challengeCallbacks: {
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
},
scopes: ["https://service/.default"],
});
提供后,bearerTokenAuthenticationPolicy 策略将在内部处理持续访问评估(CAE)挑战。
当它无法完成质询时,它将从 ARM 返回 401(未授权)响应。
声明的示例质询:
Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
function authorizeRequestOnClaimChallenge(onChallengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>
参数
- onChallengeOptions
- AuthorizeRequestOnChallengeOptions
返回
Promise<boolean>
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)
定义用于处理存储 API 的身份验证质询的回调。 这将实现此处所述的持有者质询过程:https://free.blessedness.top/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge 处理具有特定的存储功能,这些功能会迁移到常规 AAD 质询文档。
function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>
参数
- challengeOptions
- AuthorizeRequestOnChallengeOptions
返回
Promise<boolean>
createClientPipeline(InternalClientPipelineOptions)
创建用于服务客户端的新管道。 默认情况下,在反序列化Policy 中添加。 如果传递 TokenCredential,则还添加了 bearerTokenAuthenticationPolicy。
function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline
参数
- options
- InternalClientPipelineOptions
用于自定义创建的管道的选项。
返回
createSerializer({[key: string]: any}, boolean)
创建和返回序列化程序的方法。
function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer
参数
- modelMappers
-
{[key: string]: any}
要映射的已知模型
- isXML
-
boolean
如果应支持 XML
返回
deserializationPolicy(DeserializationPolicyOptions)
此策略根据请求的 OperationSpecs 处理分析响应。
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy
参数
- options
- DeserializationPolicyOptions
返回
serializationPolicy(SerializationPolicyOptions)
此策略使用 OperationSpec 和 OperationArguments 处理请求的程序集正文和标头。
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy
参数
- options
- SerializationPolicyOptions