你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
AuthorizationCodeCredential 类
通过兑换以前从 Azure Active Directory 获取的授权代码进行身份验证。
有关身份验证流的详细信息,请参阅 Azure Active Directory 文档 。
- 继承
-
azure.identity._internal.get_token_mixin.GetTokenMixinAuthorizationCodeCredential
构造函数
AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, **kwargs: Any)
参数
- authority
- str
Azure Active Directory 终结点的颁发机构,例如“login.microsoftonline.com”,即 Azure 公有云 (的颁发机构,这是默认) 。 AzureAuthorityHosts 定义其他云的颁发机构。
- client_secret
- str
应用程序的客户端机密之一。 仅适用于 Web 应用和 Web API。
除了指定凭据可能为其获取令牌的指定“tenant_id”之外,还指定租户。 添加通配符值“*”以允许凭据为应用程序可以访问的任何租户获取令牌。
示例
创建 AuthorizationCodeCredential。
from azure.identity import AuthorizationCodeCredential
credential = AuthorizationCodeCredential(
tenant_id="<tenant_id>",
client_id="<client_id>",
authorization_code="<auth_code>",
redirect_uri="<redirect_uri>",
)
方法
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
访问令牌的所需范围。 此方法至少需要一个范围。 有关范围的详细信息,请参阅 https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc。
- claims
- str
令牌中所需的其他声明,例如授权失败后资源提供程序的声明质询中返回的声明。
- tenant_id
- str
要包含在令牌请求中的可选租户。
返回
具有所需范围的访问令牌。
返回类型
例外
身份验证失败。 错误的 message
属性提供了一个原因。 来自 Azure Active Directory 的任何错误响应都可用作错误的 response
属性。