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

@azure/core-client package

参考

类

初始化 ServiceClient 的新实例。

接口

AdditionalPolicyConfig	用于配置在构造时添加到管道的其他策略。
BaseMapper	映射器的基本定义。可用于 XML 和纯 JavaScript 对象。
CommonClientOptions	高级客户端应公开的常用选项集。
CompositeMapper	由其他映射器组成的映射器。
CompositeMapperType	帮助生成描述如何基于其他映射器映射对象的一组属性的映射器。应仅存在以下属性之一： `className`、 `modelProperties` 和 `additionalProperties`。
DeserializationContentTypes	指示应以特定方式反序列化操作响应的内容类型。
DeserializationPolicyOptions	用于配置 API 响应反序列化的选项。
DictionaryMapper	描述用作键/值对的纯 JavaScript 对象的映射器。
DictionaryMapperType	帮助生成描述如何分析映射值的字典的映射器。
EnumMapper	描述枚举值的映射器。
EnumMapperType	帮助生成描述如何分析枚举值的映射器。
FullOperationResponse	http 请求和响应的包装器对象。当以 JSON 或 XML 格式收到响应正文时，反序列化的对象存储在 `parsedBody` 属性中。
InternalClientPipelineOptions	用于创建用于 ServiceClient 的管道的选项。主要用于自定义身份验证策略 (如果使用令牌身份验证) 或使用 XML 时的反序列化选项。
MapperConstraints	各种值约束的说明，例如整数范围和字符串正则表达式。
OperationArguments	应用于操作的单个调用的属性集合。
OperationOptions	所有操作的基选项类型。
OperationParameter	所有 Operation 参数扩展的通用接口。
OperationQueryParameter	操作的参数，该参数将作为查询参数添加到操作的 HTTP 请求中。
OperationRequestInfo	用于正确分析响应的元数据。
OperationRequestOptions	创建和发送此操作的 HTTP 请求时使用的选项。
OperationResponseMap	可从单个状态代码的操作请求返回的 OperationResponse。
OperationSpec	定义操作的规范。
OperationURLParameter	操作的参数，将替换为操作的请求 URL。
PolymorphicDiscriminator	用于消除可区分类型联合的歧义。例如，如果响应可以有许多形状，但还包括 (或类似) 的“种类”字段，则可以使用该字段来确定如何将响应反序列化为正确的类型。
SequenceMapper	描述数组的映射器。
SequenceMapperType	帮助生成描述如何分析映射值的序列的映射器。
SerializationPolicyOptions	用于配置 API 请求序列化的选项。
Serializer	用于将原始响应对象映射到最终形状。帮助打包日期和其他不是 JSON 固有的编码类型。还允许从标头中拉取值，以及插入默认值和常量。
SerializerOptions	用于配置序列化/反序列化行为的选项。
ServiceClientOptions	创建客户端时要提供的选项。
SimpleMapperType	简单映射器的类型。
SpanConfig	用于创建新跟踪范围的配置
XmlOptions	用于控制 xml 分析器和生成器行为的选项。

类型别名

Mapper	映射器是库中使用的数据模型的定义。这些数据模型是响应或参数中的 Operation 或 Client 定义的一部分。
MapperType	映射器的类型。包括已知的映射器。
OperationRequest	用于将来校对的类型别名。
ParameterPath	编码如何访问对象上的特定属性。
QueryCollectionFormat	将用于将查询参数值的数组联接在一起的格式。
RawResponseCallback	在执行请求的操作时，每次从服务器收到响应时要调用的函数。可以多次调用。

函数

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	此函数可用作的`@azure/core-rest-pipeline`回调`bearerTokenAuthenticationPolicy`，以支持 CAE 质询：持续访问评估。 `bearerTokenAuthenticationPolicy`使用以下选项调用： `import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({ authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge });` 提供后，该 `bearerTokenAuthenticationPolicy` 策略将在内部处理持续访问评估 (CAE) 质询。当无法完成质询时，它将从 ARM 返回 401 (未经授权的) 响应。使用声明的示例质询： `Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="`
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	定义用于处理存储 API 的身份验证质询的回调。这将实现此处所述的持有者质询过程： https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge 处理具有特定的存储功能，这些功能将转为常规 AAD 质询文档。
createClientPipeline(InternalClientPipelineOptions)	创建用于服务客户端的新管道。默认情况下，在 deserializationPolicy 中添加。如果传递了 TokenCredential，则还会在 bearerTokenAuthenticationPolicy 中添加。
createSerializer({[key: string]: any}, boolean)	创建并返回序列化程序的方法。
deserializationPolicy(DeserializationPolicyOptions)	此策略根据请求上的 OperationSpecs 处理分析响应。
serializationPolicy(SerializationPolicyOptions)	此策略处理在请求上使用 OperationSpec 和 OperationArguments 汇编请求正文和标头。

函数详细信息

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

此函数可用作的@azure/core-rest-pipeline回调bearerTokenAuthenticationPolicy，以支持 CAE 质询：持续访问评估。

bearerTokenAuthenticationPolicy使用以下选项调用：

import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";

const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
  authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});

提供后，该 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://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge 处理具有特定的存储功能，这些功能将转为常规 AAD 质询文档。

function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

参数

challengeOptions: AuthorizeRequestOnChallengeOptions

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

创建用于服务客户端的新管道。默认情况下，在 deserializationPolicy 中添加。如果传递了 TokenCredential，则还会在 bearerTokenAuthenticationPolicy 中添加。

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

参数

options: InternalClientPipelineOptions

用于自定义创建的管道的选项。

Pipeline

createSerializer({[key: string]: any}, boolean)

创建并返回序列化程序的方法。

function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer

参数

modelMappers: {[key: string]: any}

要映射的已知模型

isXML: boolean

是否应支持 XML

Serializer

deserializationPolicy(DeserializationPolicyOptions)

此策略根据请求上的 OperationSpecs 处理分析响应。

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

参数

options: DeserializationPolicyOptions

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

此策略处理在请求上使用 OperationSpec 和 OperationArguments 汇编请求正文和标头。

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

参数

options: SerializationPolicyOptions