DefaultAzureCredential クラス

  • リファレンス

ほとんどの Azure SDK 認証シナリオを処理できる既定の資格情報。

ここで使用される ID は、環境によって異なります。 アクセス トークンが必要な場合は、次の ID を使用してアクセス トークンが要求され、トークンが提供されると停止します。

  1. 環境変数によって構成されたサービス プリンシパル。 詳細については、 EnvironmentCredential をご覧ください。

  2. Azure ワークロード ID Webhook によって環境変数の構成が設定されている場合は WorkloadIdentityCredential。

  3. Azure マネージド ID。 詳細については、 ManagedIdentityCredential をご覧ください。

  4. Windows のみ: Visual Studio などの Microsoft アプリケーションでサインインしたユーザー。 キャッシュ内に複数の ID がある場合は、環境変数 AZURE_USERNAME の値を使用して、使用する ID を選択します。 詳細については、 SharedTokenCacheCredential をご覧ください。

  5. 現在 Azure CLI にログインしている ID。

  6. 現在Azure PowerShellにログインしている ID。

  7. 現在Azure Developer CLIにログインしている ID。

この既定の動作は、キーワード (keyword)引数で構成できます。

継承
azure.identity._credentials.chained.ChainedTokenCredential
DefaultAzureCredential

コンストラクター

DefaultAzureCredential(**kwargs: Any)

パラメーター

authority
str

"login.microsoftonline.com" などの Azure Active Directory エンドポイントの権限。Azure パブリック クラウドの権限 (既定値)。 AzureAuthorityHosts は、他のクラウドの権限を定義します。 マネージド ID は、1 つのクラウドに存在するため、これを無視します。

exclude_workload_identity_credential
bool

ワークロード ID を資格情報から除外するかどうか。 既定値は False です。

exclude_developer_cli_credential
bool

資格情報からAzure Developer CLIを除外するかどうか。 既定値は False です。

exclude_cli_credential
bool

資格情報から Azure CLI を除外するかどうか。 既定値は False です。

exclude_environment_credential
bool

環境変数によって構成されたサービス プリンシパルを資格情報から除外するかどうか。 既定値は False です。

exclude_managed_identity_credential
bool

資格情報からマネージド ID を除外するかどうか。 既定値は False です。

exclude_powershell_credential
bool

Azure PowerShellを除外するかどうか。 既定値は False です。

exclude_visual_studio_code_credential
bool

格納されている資格情報を VS Code から除外するかどうか。 既定値は True です。

exclude_shared_token_cache_credential
bool

共有トークン キャッシュを除外するかどうか。 既定値は False です。

exclude_interactive_browser_credential
bool

対話型ブラウザー認証を除外するかどうか (「」を参照 InteractiveBrowserCredential)。 既定値は True です。

interactive_browser_tenant_id
str

を使用して InteractiveBrowserCredentialユーザーを認証するときに使用するテナント ID。 既定値は、環境変数AZURE_TENANT_IDの値 (存在する場合) です。 指定しない場合、ユーザーはホーム テナントで認証を行います。

managed_identity_client_id
str

ユーザー割り当てマネージド ID のクライアント ID。 既定値は、環境変数AZURE_CLIENT_IDの値 (存在する場合) です。 指定しない場合は、システム割り当て ID が使用されます。

workload_identity_client_id
str

ポッドに割り当てられた ID のクライアント ID。 既定値は、環境変数AZURE_CLIENT_IDの値 (存在する場合) です。 指定しない場合は、ポッドの既定の ID が使用されます。

workload_identity_tenant_id
str

の WorkloadIdentityCredential推奨テナント。 既定値は、環境変数AZURE_TENANT_IDの値 (存在する場合) です。

interactive_browser_client_id
str

対話型ブラウザー資格情報で使用されるクライアント ID。 指定しない場合、ユーザーは Azure 開発アプリケーションに対して認証を行います。

shared_cache_username
str

の優先ユーザー名 SharedTokenCacheCredential。 既定値は、環境変数AZURE_USERNAMEの値 (存在する場合) です。

shared_cache_tenant_id
str

の SharedTokenCacheCredential推奨テナント。 既定値は、環境変数AZURE_TENANT_IDの値 (存在する場合) です。

visual_studio_code_tenant_id
str

で認証するときに使用する VisualStudioCodeCredentialテナント ID。 既定では、VS Code のユーザー設定の "Azure: テナント" 設定、またはその設定に値がない場合は、Azure Active Directory の職場または学校アカウントのみをサポートする "組織" テナントが使用されます。

process_timeout
int

サブプロセス (AzureCliCredential、AzurePowerShellCredential など) を実行する開発者資格情報に使用するタイムアウト (秒単位)。 既定値は 10 秒です。

例

DefaultAzureCredential を作成します。


   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

メソッド

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

例外

ClientAuthenticationError

認証に失敗しました。 例外には、各認証試行とそのエラー メッセージが一覧表示される メッセージ 属性があります。