EnvironmentCredential クラス

  • リファレンス

環境変数によって構成された資格情報。

この資格情報は、クライアント シークレットまたは証明書を使用してサービス プリンシパルとして、またはユーザー名とパスワードを持つユーザーとして認証できます。 構成は、次の環境変数を使用して、次の順序で試行されます。

シークレットを含むサービス プリンシパル:

  • AZURE_TENANT_ID: サービス プリンシパルのテナントの ID。 "ディレクトリ" ID とも呼ばれます。

  • AZURE_CLIENT_ID: サービス プリンシパルのクライアント ID

  • AZURE_CLIENT_SECRET: サービス プリンシパルのクライアント シークレットの 1 つ

  • AZURE_AUTHORITY_HOST: Azure Active Directory エンドポイントの権限 ("login.microsoftonline.com" など) は、値が指定されていない場合の既定値である Azure パブリック クラウドの権限です。

証明書を含むサービス プリンシパル:

  • AZURE_TENANT_ID: サービス プリンシパルのテナントの ID。 "ディレクトリ" ID とも呼ばれます。

  • AZURE_CLIENT_ID: サービス プリンシパルのクライアント ID

  • AZURE_CLIENT_CERTIFICATE_PATH: 秘密キーを含む PEM または PKCS12 証明書ファイルへのパス。

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: 証明書ファイルの (省略可能) パスワード (存在する場合)。

  • AZURE_AUTHORITY_HOST: Azure Active Directory エンドポイントの権限 ("login.microsoftonline.com" など) は、値が指定されていない場合の既定値である Azure パブリック クラウドの権限です。

ユーザー名とパスワードを持つユーザー:

  • AZURE_CLIENT_ID: アプリケーションのクライアント ID

  • AZURE_USERNAME: ユーザー名 (通常はメール アドレス)

  • AZURE_PASSWORD: そのユーザーのパスワード

  • AZURE_TENANT_ID: (省略可能) サービス プリンシパルのテナントの ID。 "ディレクトリ" ID とも呼ばれます。 指定しない場合、既定では "organizations" テナントが使用され、Azure Active Directory の職場または学校アカウントのみがサポートされます。

  • AZURE_AUTHORITY_HOST: Azure Active Directory エンドポイントの権限 ("login.microsoftonline.com" など) は、値が指定されていない場合の既定値である Azure パブリック クラウドの権限です。

継承
builtins.object
EnvironmentCredential

コンストラクター

EnvironmentCredential(**kwargs: Any)

例

EnvironmentCredential を作成します。


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

メソッド

close

資格情報のトランスポート セッションを閉じます。
get_token

スコープのアクセス トークンを要求 します。

このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。

close

資格情報のトランスポート セッションを閉じます。

close() -> None

get_token

スコープのアクセス トークンを要求 します。

このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

パラメーター

scopes
str
必須

アクセス トークンの目的のスコープ。 このメソッドには、少なくとも 1 つのスコープが必要です。 スコープの詳細については、「」を参照してください https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc。

claims
str

承認エラーの後にリソース プロバイダーの要求チャレンジで返される要求など、トークンに必要な追加の要求。

tenant_id
str

トークン要求に含める省略可能なテナント。

戻り値

目的のスコープを持つアクセス トークン。

の戻り値の型 :

AccessToken

例外

CredentialUnavailableError

環境変数の構成が不完全です