EnvironmentCredential class
クライアント シークレットまたは証明書を使用して、またはユーザー名とパスワードを持つユーザーとして、Microsoft Entra ID への認証を有効にします。
コンストラクター
| Environment |
EnvironmentCredential クラスのインスタンスを作成し、使用可能な環境変数に応じて使用する資格情報を決定します。 必須の環境変数:
AZURE_TENANT_IDを設定する場合は、追加で許可されるテナントを設定することもできます。
クライアント資格情報認証に使用される環境変数:
または、ユーザーはユーザー名とパスワード認証の環境変数を指定できます。
認証を実行するために必要な環境変数がない場合は、CredentialUnavailableError がスローされます。 認証が失敗した場合、または不明なエラーが発生した場合は、AuthenticationError がスローされます。 |
メソッド
| get |
Microsoft Entra ID を使用して認証し、成功した場合はアクセス トークンを返します。 |
コンストラクターの詳細
EnvironmentCredential(EnvironmentCredentialOptions)
EnvironmentCredential クラスのインスタンスを作成し、使用可能な環境変数に応じて使用する資格情報を決定します。
必須の環境変数:
-
AZURE_TENANT_ID: Microsoft Entra テナント (ディレクトリ) ID。 -
AZURE_CLIENT_ID: テナント内のアプリ登録のクライアント (アプリケーション) ID。
AZURE_TENANT_IDを設定する場合は、追加で許可されるテナントを設定することもできます。
-
AZURE_ADDITIONALLY_ALLOWED_TENANTS: マルチテナント アプリケーションの場合、資格情報が単一のセミコロンで区切られた文字列でトークンを取得できる追加のテナントを指定します。 * を使用して、すべてのテナントを許可します。
クライアント資格情報認証に使用される環境変数:
-
AZURE_CLIENT_SECRET: アプリ登録用に生成されたクライアント シークレット。 -
AZURE_CLIENT_CERTIFICATE_PATH: クライアント シークレットではなく、認証時に使用する PEM 証明書へのパス。 -
AZURE_CLIENT_CERTIFICATE_PASSWORD: (省略可能) 証明書ファイルのパスワード。 -
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (省略可能) は、サブジェクト名/発行者ベースの認証をサポートするために、証明書チェーンを x5c ヘッダーに設定する必要があることを示します。
または、ユーザーはユーザー名とパスワード認証の環境変数を指定できます。
-
AZURE_USERNAME: 認証に使用するユーザー名。 -
AZURE_PASSWORD: 認証に使用するパスワード。
認証を実行するために必要な環境変数がない場合は、CredentialUnavailableError がスローされます。 認証が失敗した場合、または不明なエラーが発生した場合は、AuthenticationError がスローされます。
new EnvironmentCredential(options?: EnvironmentCredentialOptions)パラメーター
- options
- EnvironmentCredentialOptions
認証要求を行うクライアントを構成するためのオプション。
メソッドの詳細
getToken(string | string[], GetTokenOptions)
Microsoft Entra ID を使用して認証し、成功した場合はアクセス トークンを返します。
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>パラメーター
- scopes
-
string | string[]
トークンがアクセスできるスコープの一覧。
- options
- GetTokenOptions
省略可能なパラメーター。 GetTokenOptionsの
戻り値
Promise<AccessToken>