SharedTokenCacheCredential クラス
Microsoft アプリケーション間で共有されるローカル キャッシュ内のトークンを使用して認証を行います。
- 継承
-
azure.identity._internal.shared_token_cache.SharedTokenCacheBaseSharedTokenCacheCredentialazure.identity.aio._internal.AsyncContextManagerSharedTokenCacheCredential
コンストラクター
SharedTokenCacheCredential(username: str | None = None, *, authority: str | None = None, tenant_id: str | None = None, **kwargs: Any)パラメーター
- username
- str
認証を行うユーザーのユーザー名 (通常はメール アドレス)。 これは、ローカル キャッシュに複数の ID のトークンが含まれている可能性があるため、必須です。
- authority
- str
"login.microsoftonline.com" などの Azure Active Directory エンドポイントの権限。Azure パブリック クラウドの権限 (既定値)。 AzureAuthorityHosts は、他のクラウドの権限を定義します。
- tenant_id
- str
Azure Active Directory テナント ID。 キャッシュに複数の ID のトークンが含まれている場合にアカウントを選択するために使用します。
- cache_persistence_options
- TokenCachePersistenceOptions
永続的なトークン キャッシュの構成。 指定しない場合、資格情報は Microsoft 開発アプリケーションによって共有される永続キャッシュを使用します
メソッド
| close |
資格情報のトランスポート セッションを閉じます。 |
| get_token |
共有キャッシュから スコープの アクセス トークンを取得します。 アクセス トークンがキャッシュされていない場合は、キャッシュされた更新トークンを使用してアクセス トークンの取得を試みます。 このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。 |
| supported |
共有トークン キャッシュが現在のプラットフォームでサポートされているかどうか。 |
close
資格情報のトランスポート セッションを閉じます。
async close() -> Noneget_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 理由があります。 Azure Active Directory からのエラー応答は、エラーの response 属性として使用できます。
supported
共有トークン キャッシュが現在のプラットフォームでサポートされているかどうか。
static supported() -> bool戻り値
現在のプラットフォームで共有トークン キャッシュがサポートされている場合は True。