AzureDeveloperCliCredential クラス

  • リファレンス

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

Azure Developer CLIは、開発者が Azure でリソースを作成、管理、デプロイできるようにするコマンドライン インターフェイス ツールです。 これは Azure CLI の上に構築され、Azure 開発者に固有の追加機能を提供します。 これにより、ユーザーは Azure Active Directory (Azure AD) に対してユーザーまたはサービス プリンシパルとして認証できます。 AzureDeveloperCliCredential は開発環境で認証を行い、Azure Developer CLIにログインしているユーザーまたはサービス プリンシパルに代わってトークンを取得します。 これは、ログインしているユーザーまたはサービス プリンシパルAzure Developer CLIとして機能し、その下にある Azure CLI コマンドを実行して、Azure Active Directory に対してアプリケーションを認証します。

この資格情報を使用するには、開発者は次のいずれかのコマンドを使用して、Azure Developer CLIでローカルで認証する必要があります。

  • Azure Developer CLIで "azd auth login" を実行して、ユーザーとして対話形式で認証します。

  • "azd auth login –client-id 'client_id' –client-secret 'client_secret' –tenant-id 'tenant_id' を実行して、サービス プリンシパルとして認証します。

組織内の更新トークンの有効性によっては、一定期間後にこのプロセスを繰り返す必要がある場合があります。 一般に、更新トークンの有効期間は数週間から数か月です。 AzureDeveloperCliCredential では、もう一度サインインするように求められます。

継承
builtins.object
AzureDeveloperCliCredential

コンストラクター

AzureDeveloperCliCredential(*, 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 Developer CLI プロセスが応答するまで待機する秒数。 既定値は 10 秒です。

例

AzureDeveloperCliCredential を作成します。


   from azure.identity import AzureDeveloperCliCredential

   credential = AzureDeveloperCliCredential()

メソッド

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 Developer CLIを呼び出すことができませんでした。

ClientAuthenticationError

資格情報はAzure Developer CLIを呼び出しましたが、アクセス トークンを受け取りませんでした。