DefaultAzureCredential class
Azure SDK クライアント ライブラリを使用するほとんどのアプリケーションで動作する既定の ChainedTokenCredential 構成を提供します。 詳細については、「DefaultAzureCredential の概要 を参照してください。
次の資格情報の種類が順番に試行されます。
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential の
- AzurePowerShellCredential の
- AzureDeveloperCliCredential
認証の試行方法の詳細については、これらの資格情報の種類のドキュメントを参照してください。
資格情報の選択
環境変数 AZURE_TOKEN_CREDENTIALS を設定して、資格情報チェーンのサブセットを選択します。 DefaultAzureCredential は指定された資格情報のみを試行しますが、その他の動作は同じままです。 AZURE_TOKEN_CREDENTIALS の有効な値は、上記のチェーン内の任意の 1 つの型の名前 ("EnvironmentCredential" や "AzureCliCredential" など) と、次の特別な値です。
- "dev": [VisualStudioCodeCredential]、[AzureCliCredential]、[AzurePowerShellCredential]、[AzureDeveloperCliCredential] をこの順序で試してください
- "prod": [EnvironmentCredential]、[WorkloadIdentityCredential]、[ManagedIdentityCredential] をこの順序で試してください
- Extends
コンストラクター
| Default |
DefaultAzureCredentialClientIdOptions DefaultAzureCredential クラスのインスタンスを作成します。 |
| Default |
DefaultAzureCredentialOptions DefaultAzureCredential クラスのインスタンスを作成します。 |
| Default |
DefaultAzureCredentialResourceIdOptions DefaultAzureCredential クラスのインスタンスを作成します。 |
継承されたメソッド
| get |
チェーンされた このメソッドは、Azure SDK クライアント ライブラリによって自動的に呼び出されます。 このメソッドは直接呼び出すことができますが、トークンのキャッシュとトークンの更新も処理する必要があります。 |
コンストラクターの詳細
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
DefaultAzureCredential(DefaultAzureCredentialOptions)
DefaultAzureCredentialOptions DefaultAzureCredential クラスのインスタンスを作成します。
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)パラメーター
- options
- DefaultAzureCredentialOptions
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
継承済みメソッドの詳細
getToken(string | string[], GetTokenOptions)
チェーンされた TokenCredential 実装の 1 つによって返される最初のアクセス トークンを返します。 1 つ以上の資格情報が AuthenticationError をスローし、資格情報がアクセス トークンを返していない場合に、AggregateAuthenticationError をスローします。
このメソッドは、Azure SDK クライアント ライブラリによって自動的に呼び出されます。 このメソッドは直接呼び出すことができますが、トークンのキャッシュとトークンの更新も処理する必要があります。
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>パラメーター
- scopes
-
string | string[]
トークンがアクセスできるスコープの一覧。
- options
- GetTokenOptions
この TokenCredential 実装が行う可能性のある要求を構成するために使用されるオプション。
戻り値
Promise<AccessToken>