ClientSecretCredential クラス
クライアント シークレットを使用してサービス プリンシパルとして認証します。
- 継承
-
azure.identity.aio._internal.AsyncContextManagerClientSecretCredentialazure.identity.aio._internal.get_token_mixin.GetTokenMixinClientSecretCredential
コンストラクター
ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)
パラメーター
- authority
- str
"login.microsoftonline.com" などの Azure Active Directory エンドポイントの権限。Azure パブリック クラウドの権限 (既定値)。 AzureAuthorityHosts は、他のクラウドの権限を定義します。
- cache_persistence_options
- TokenCachePersistenceOptions
永続的なトークン キャッシュの構成。 指定しない場合、資格情報はメモリ内のトークンをキャッシュします。
資格情報がトークンを取得できる指定された "tenant_id" に加えて、テナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがアクセスできる任意のテナントのトークンを資格情報で取得できるようにします。
例
ClientSecretCredential を作成します。
from azure.identity.aio import ClientSecretCredential
credential = ClientSecretCredential(
tenant_id="<tenant_id>",
client_id="<client_id>",
client_secret="<client_secret>",
)
メソッド
close |
資格情報のトランスポート セッションを閉じます。 |
get_token |
スコープのアクセス トークンを要求 します。 このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。 |
close
資格情報のトランスポート セッションを閉じます。
async close() -> None
get_token
スコープのアクセス トークンを要求 します。
このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。
async 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
トークン要求に含める省略可能なテナント。
- enable_cae
- bool
は、要求されたトークンに対して継続的アクセス評価 (CAE) を有効にするかどうかを示します。 既定値は False です。
戻り値
目的のスコープを持つアクセス トークン。
の戻り値の型 :
例外
資格情報に必要なデータ、状態、またはプラットフォームのサポートがないため、認証を試みることができません
認証に失敗しました。 エラーの 属性には message
理由があります。