@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 |
操作の 1 回の呼び出しに適用されるプロパティのコレクション。 |
| OperationOptions |
すべての操作の基本オプションの種類。 |
| OperationParameter |
すべての Operation パラメーターが拡張する共通インターフェイス。 |
| OperationQueryParameter |
操作の HTTP 要求にクエリ パラメーターとして追加される操作のパラメーター。 |
| OperationRequestInfo |
応答を適切に解析するために使用されるメタデータ。 |
| OperationRequestOptions |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| OperationResponseMap |
1 つの状態コードの操作要求から返すことができる OperationResponse。 |
| OperationSpec |
操作を定義する仕様。 |
| OperationURLParameter |
操作の要求 URL に置き換えられる操作のパラメーター。 |
| PolymorphicDiscriminator |
判別型共用体のあいまいさを解消するために使用されます。 たとえば、応答に多くの図形を含めることができるが、'kind' フィールド (または同様) も含まれている場合、そのフィールドを使用して、応答を正しい型に逆シリアル化する方法を決定できます。 |
| SequenceMapper |
配列を記述するマッパー。 |
| SequenceMapperType |
マップされた値のシーケンスを解析する方法を説明するマッパーを構築するのに役立ちます。 |
| SerializationPolicyOptions |
API 要求のシリアル化を構成するためのオプション。 |
| Serializer |
未加工の応答オブジェクトを最終的な図形にマップするために使用します。 JSON に組み込まれていない日付やその他のエンコードされた型のパッキングとアンパックに役立ちます。 また、ヘッダーから値をプルしたり、既定値や定数を挿入したりすることもできます。 |
| SerializerOptions |
シリアル化/シリアル化解除の動作を構成するためのオプション。 |
| ServiceClientOptions |
クライアントの作成時に指定するオプション。 |
| SimpleMapperType |
単純なマッパーの種類。 |
| SpanConfig |
新しいトレーススパンを作成するための構成 |
| XmlOptions |
xml パーサーとビルダーの動作を管理するためのオプション。 |
型エイリアス
| Mapper |
マッパーは、ライブラリで使用されるデータ モデルの定義です。 これらのデータ モデルは、応答またはパラメーターの Operation または Client 定義の一部です。 |
| MapperType |
マッパーの種類。 既知のマッパーが含まれています。 |
| OperationRequest |
将来の校正用の型エイリアス。 |
| ParameterPath |
オブジェクトの特定のプロパティに到達する方法をエンコードします。 |
| QueryCollectionFormat |
クエリ パラメーター値の値の配列を結合するために使用される形式。 |
| RawResponseCallback |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
機能
| authorize |
この関数は、 の 次のオプションを 指定されると、 要求に関するチャレンジの例: |
| authorize |
ストレージ API の認証チャレンジを処理するコールバックを定義します。 これは、ここで説明するベアラー チャレンジ プロセスを実装します。 https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge 処理には、一般的な AAD チャレンジ ドキュメントに従うストレージ用の特定の機能があります。 |
| create |
サービス クライアントで使用する新しいパイプラインを作成します。 既定では、deserializationPolicy に を追加します。 TokenCredential が渡された場合は bearerTokenAuthenticationPolicy にも を追加します。 |
| create |
シリアライザーを作成して返すメソッド。 |
| deserialization |
このポリシーは、要求の OperationSpecs に従って応答の解析を処理します。 |
| serialization |
このポリシーは、要求に対して 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
作成されたパイプラインをカスタマイズするためのオプション。
戻り値
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