AzureCliCredential クラス

  • リファレンス

Azure CLI にトークンを要求して認証します。

これには、以前に "az login" を使用して Azure にログインする必要があり、CLI の現在ログインしている ID が使用されます。

継承
builtins.object
AzureCliCredential

コンストラクター

AzureCliCredential(*, tenant_id: str = '', additionally_allowed_tenants: List[str] | None = None, process_timeout: int = 10)

パラメーター

tenant_id
str

トークン要求に含めるオプションのテナント。

additionally_allowed_tenants
List[str]

資格情報がトークンを取得できる指定した "tenant_id" に加えて、テナントを指定します。 ワイルドカード値 "*" を追加して、資格情報がアプリケーションがアクセスできる任意のテナントのトークンを取得できるようにします。

process_timeout
int

Azure CLI プロセスが応答するまで待機する秒数。 既定値は 10 秒です。

例

AzureCliCredential を作成します。


   from azure.identity import AzureCliCredential

   credential = AzureCliCredential()

メソッド

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

資格情報で Azure CLI を呼び出すことができませんでした。

ClientAuthenticationError

資格情報が Azure CLI を呼び出したが、アクセス トークンを受け取らなかった。