次の方法で共有

EnvironmentCredential class

  • リファレンス
パッケージ:
@azure/identity

クライアント シークレットまたは証明書を使用して、またはユーザー名とパスワードを持つユーザーとして認証を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_USERNAME: 認証に使用するユーザー名。
  • AZURE_PASSWORD: 認証に使用するパスワード。

認証を実行するために必要な環境変数がない場合は、 CredentialUnavailableError がスローされます。 認証が失敗した場合、または不明なエラーが発生した場合は、 AuthenticationError がスローされます。

メソッド

getToken(string | string[], GetTokenOptions)

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_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>