@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	各種值條件約束的描述，例如整數範圍和字串 RegEx。
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	對應器是程式庫中所使用的資料模型定義。這些資料模型是回應或參數中作業或用戶端定義的一部分。
MapperType	對應程式的型別。包含已知的對應器。
OperationRequest	未來校訂的類型別名。
ParameterPath	編碼如何觸達物件上的特定屬性。
QueryCollectionFormat	將用來將值陣列聯結在一起的查詢參數值格式。
RawResponseCallback	每次從伺服器收到回應時要呼叫的函式，同時執行要求的作業。可以多次呼叫。

函數

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	此函式可作為的 `bearerTokenAuthenticationPolicy@azure/core-rest-pipeline` 回呼，以支援 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)	建立新的管線以搭配服務用戶端使用。預設會在還原序列化Policy 中新增。如果傳遞 TokenCredential，也會在 bearerTokenAuthenticationPolicy 中新增。
createSerializer({[key: string]: any}, boolean)	建立和傳回序列化程式的方法。
deserializationPolicy(DeserializationPolicyOptions)	此原則會根據要求的 OperationSpecs 處理剖析回應。
serializationPolicy(SerializationPolicyOptions)	此原則會處理在要求上使用 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 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)

建立新的管線以搭配服務用戶端使用。預設會在還原序列化Policy 中新增。如果傳遞 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

傳回