DefaultAzureCredential class
Azure SDK クライアント ライブラリを使用するほとんどのアプリケーションで動作する既定の ChainedTokenCredential 構成を提供します。 詳細については、「DefaultAzureCredential の概要 を参照してください。
次の資格情報の種類が順番に試行されます。
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential の
- AzurePowerShellCredential の
- AzureDeveloperCliCredential
- BrokerCredential ( @azure/identity-broker がインストールされている必要があるブローカー対応資格情報)
認証の試行方法の詳細については、これらの資格情報の種類のドキュメントを参照してください。
次の例は、 requiredEnvVars オプションを使用して、 DefaultAzureCredential がインスタンス化される前に特定の環境変数が設定されていることを確認する方法を示しています。
指定された環境変数のいずれかが欠落しているか空の場合、エラーがスローされ、必要な構成なしでアプリケーションの実行を続行できなくなります。
また、 AZURE_TOKEN_CREDENTIALS 環境変数を設定して、チェーンに含める資格情報を制御する方法も示します。
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential({
requiredEnvVars: [
"AZURE_CLIENT_ID",
"AZURE_TENANT_ID",
"AZURE_CLIENT_SECRET",
"AZURE_TOKEN_CREDENTIALS",
],
});
- 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>