SharedTokenCacheCredential 類別

使用 Microsoft 應用程式之間共用本機快取中的權杖進行驗證。

繼承

azure.identity._internal.shared_token_cache.SharedTokenCacheBase

SharedTokenCacheCredential

azure.identity.aio._internal.AsyncContextManager

SharedTokenCacheCredential

建構函式

SharedTokenCacheCredential(username: str | None = None, *, authority: str | None = None, tenant_id: str | None = None, **kwargs: Any)

參數

username

str

預設值: None

使用者名稱 (通常會) 使用者的電子郵件地址進行驗證。 這是必要的，因為本機快取可能包含多個身分識別的權杖。

authority

str

Azure Active Directory 端點的授權單位，例如「login.microsoftonline.com」，這是 Azure 公用雲端 (的授權單位，這是預設) 。 AzureAuthorityHosts 定義其他雲端的授權單位。

tenant_id

str

Azure Active Directory 租使用者識別碼。 當快取包含多個身分識別的權杖時，用來選取帳戶。

cache_persistence_options

TokenCachePersistenceOptions

持續性權杖快取的組態。 如果未提供，認證將會使用 Microsoft 開發應用程式共用的永續性快取

方法

close	關閉認證的傳輸會話。
get_token	從共用快取取得 範圍的 存取權杖。 如果未快取任何存取權杖，請嘗試使用快取的重新整理權杖來取得存取權杖。 Azure SDK 用戶端會自動呼叫此方法。
supported	目前平臺上是否支援共用權杖快取。

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

必要

存取權杖所需的範圍。 這個方法至少需要一個範圍。 如需範圍的詳細資訊，請參閱 https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc 。

claims

str

權杖中所需的其他宣告，例如在授權失敗之後，在資源提供者的宣告挑戰中傳回的其他宣告。

tenant_id

str

要包含在權杖要求中的選擇性租使用者。

enable_cae

bool

指出是否為要求的權杖啟用持續存取評估 (CAE) 。 預設為 False。

傳回

具有所需範圍的存取權杖。

傳回類型

AccessToken

例外狀況

CredentialUnavailableError

快取無法使用或包含使用者資訊不足

ClientAuthenticationError

驗證失敗。 錯誤的 message 屬性會提供原因。 來自 Azure Active Directory 的任何錯誤回應都可以當做錯誤的 response 屬性使用。

supported

目前平臺上是否支援共用權杖快取。

static supported() -> bool

傳回

如果目前平臺上支援共用權杖快取，則為 True。

傳回類型

bool