EnvironmentCredential クラス

  • リファレンス

定義

名前空間:
Azure.Identity
アセンブリ:
Azure.Identity.dll
パッケージ:
Azure.Identity v1.11.1
パッケージ:
Azure.Identity v1.11.0-beta.1
ソース:
EnvironmentCredential.cs
ソース:
EnvironmentCredential.cs

認証で、クライアント シークレットまたは証明書を使用して、またはユーザー名とパスワードを持つユーザーとして ID をMicrosoft Entraできるようにします。

構成は、次の環境変数を使用して、次の順序で試行されます。

シークレットを含むサービス プリンシパル:
変数説明
AZURE_TENANT_IDMicrosoft Entra テナント (ディレクトリ) ID。
AZURE_CLIENT_IDテナント内のアプリの登録のクライアント (アプリケーション) ID。
AZURE_CLIENT_SECRETアプリの登録で生成されたクライアント シークレット。
証明書を含むサービス プリンシパル:
変数説明
AZURE_TENANT_IDMicrosoft Entra テナント (ディレクトリ) ID。
AZURE_CLIENT_IDテナント内のアプリの登録のクライアント (アプリケーション) ID。
AZURE_CLIENT_CERTIFICATE_PATHPEM または PFX 形式の証明書と秘密キーのペアへのパス。これにより、アプリの登録を認証できます。
AZURE_CLIENT_CERTIFICATE_PASSWORD(省略可能)証明書ファイルを保護するパスワード (現在、PFX (PKCS12) 証明書でのみサポートされています)。
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN(省略可能)サブジェクト名/発行者ベースの認証をサポートする x5c ヘッダーを認証要求に含めるかどうかを指定します。 'true' または '1' に設定すると、認証要求には x5c ヘッダーが含まれます。
ユーザー名とパスワード:
変数説明
AZURE_TENANT_IDMicrosoft Entra テナント (ディレクトリ) ID。
AZURE_CLIENT_IDテナント内のアプリの登録のクライアント (アプリケーション) ID。
AZURE_USERNAMEMicrosoft Entra ユーザー アカウントのユーザー名 (upn とも呼ばれます)。
AZURE_PASSWORDMicrosoft Entra ユーザー アカウントのパスワード。 ただし、MFA が有効になっているアカウントはサポートされません。

この資格情報では、最終的に 、ClientCertificateCredential、または UsernamePasswordCredential をClientSecretCredential使用して、これらの詳細を使用して認証を実行します。 詳細については、そのクラスのドキュメントを参照してください。

public class EnvironmentCredential : Azure.Core.TokenCredential
type EnvironmentCredential = class
    inherit TokenCredential
Public Class EnvironmentCredential
Inherits TokenCredential
継承
Object
TokenCredential
EnvironmentCredential

コンストラクター

EnvironmentCredential()

EnvironmentCredential クラスのインスタンスを作成し、環境変数からクライアント シークレットの詳細を読み取ります。 この時点で予期される環境変数が見つからない場合、GetToken メソッドは呼び出されたときに既定値 AccessToken を返します。
EnvironmentCredential(EnvironmentCredentialOptions)

EnvironmentCredential クラスのインスタンスを作成し、環境変数からクライアント シークレットの詳細を読み取ります。 この時点で予期される環境変数が見つからない場合、GetToken メソッドは呼び出されたときに既定値 AccessToken を返します。

メソッド

GetToken(TokenRequestContext, CancellationToken)

環境変数AZURE_TENANT_ID、AZURE_CLIENT_ID、AZURE_CLIENT_SECRETまたはAZURE_USERNAME、AZURE_PASSWORDで指定されたクライアントの詳細を使用して、Microsoft Entra ID からトークンを取得します。 取得したトークンは、資格情報インスタンスによってキャッシュされます。 トークンの有効期間と更新は自動的に処理されます。 可能であれば、資格情報インスタンスを再利用してキャッシュの有効性を最適化します。
GetTokenAsync(TokenRequestContext, CancellationToken)

環境変数AZURE_TENANT_ID、AZURE_CLIENT_ID、AZURE_CLIENT_SECRETまたはAZURE_USERNAME、AZURE_PASSWORDで指定されたクライアントの詳細を使用して、Microsoft Entra ID からトークンを取得します。 取得したトークンは、資格情報インスタンスによってキャッシュされます。 トークンの有効期間と更新は自動的に処理されます。 可能であれば、資格情報インスタンスを再利用してキャッシュの有効性を最適化します。

適用対象