通过

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

EnvironmentCredential 类

  • 参考

环境变量配置的凭据。

此凭据能够使用客户端密码或证书作为服务主体进行身份验证，或者作为具有用户名和密码的用户进行身份验证。 使用以下环境变量按以下顺序尝试配置：

具有机密的服务主体：

  • AZURE_TENANT_ID：服务主体租户的 ID。 也称为其“目录”ID。

  • AZURE_CLIENT_ID：服务主体的客户端 ID

  • AZURE_CLIENT_SECRET：服务主体的客户端机密之一

  • AZURE_AUTHORITY_HOST：Azure Active Directory 终结点的颁发机构，例如“login.microsoftonline.com”，Azure 公有云的颁发机构，如果未给出任何值，则为默认值。

具有证书的服务主体：

  • AZURE_TENANT_ID：服务主体租户的 ID。 也称为其“目录”ID。

  • AZURE_CLIENT_ID：服务主体的客户端 ID

  • AZURE_CLIENT_CERTIFICATE_PATH：PEM 或 PKCS12 证书文件（包括私钥）的路径。

  • AZURE_CLIENT_CERTIFICATE_PASSWORD： (证书文件的可选) 密码（如果有）。

  • AZURE_AUTHORITY_HOST：Azure Active Directory 终结点的颁发机构，例如“login.microsoftonline.com”，Azure 公有云的颁发机构，如果未给出任何值，则为默认值。

具有用户名和密码的用户：

  • AZURE_CLIENT_ID：应用程序的客户端 ID

  • AZURE_USERNAME：用户名 (通常是电子邮件地址)

  • AZURE_PASSWORD：该用户的密码

  • AZURE_TENANT_ID： (服务主体租户的可选) ID。 也称为其“目录”ID。 如果未提供，则默认为“组织”租户，该租户仅支持 Azure Active Directory 工作或学校帐户。

  • AZURE_AUTHORITY_HOST：Azure Active Directory 终结点的颁发机构，例如“login.microsoftonline.com”，Azure 公有云的颁发机构，如果未给出任何值，则为默认值。

继承
builtins.object
EnvironmentCredential

构造函数

EnvironmentCredential(**kwargs: Any)

示例

创建 EnvironmentCredential。


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

方法

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

环境变量配置不完整