你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 租户 ID。 用于在缓存包含多个标识的令牌时选择帐户。

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