通过

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

AzureCliCredential 类

  • 参考

通过从 Azure CLI 请求令牌进行身份验证。

这需要以前通过“az login”登录到 Azure，并使用 CLI 的当前登录标识。

继承
builtins.object
AzureCliCredential

构造函数

AzureCliCredential(*, tenant_id: str = '', additionally_allowed_tenants: List[str] | None = None, process_timeout: int = 10)

参数

tenant_id
str

要包含在令牌请求中的可选租户。

additionally_allowed_tenants
List[str]

除了指定凭据可能为其获取令牌的指定“tenant_id”之外，还指定租户。 添加通配符值“*”以允许凭据获取应用程序可以访问的任何租户的令牌。

process_timeout
int

等待 Azure CLI 进程响应的几秒钟。 默认值为 10 秒。

示例

创建 AzureCliCredential。


   from azure.identity import AzureCliCredential

   credential = AzureCliCredential()

方法

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

要包含在令牌请求中的可选租户。

返回

具有所需范围的访问令牌。

返回类型

AccessToken

例外

CredentialUnavailableError

凭据无法调用 Azure CLI。

ClientAuthenticationError

凭据已调用 Azure CLI，但未收到访问令牌。