通过

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

UsernamePasswordCredential 类

  • 参考

使用用户名和密码对用户进行身份验证。

通常，Microsoft 不建议使用此类身份验证，因为它比其他身份验证流不安全。

使用此凭据进行身份验证不是交互式的，因此它 与任何形式的多重身份验证或同意提示不兼容。 应用程序必须已获得用户或目录管理员的同意。

此凭据只能对工作和学校帐户进行身份验证;不支持 Microsoft 帐户。 有关帐户类型的详细信息，请参阅 Azure Active Directory 文档 。

继承
azure.identity._internal.interactive.InteractiveCredential
UsernamePasswordCredential

构造函数

UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)

参数

client_id
str
必需

应用程序的客户端 ID

username
str
必需

用户的用户名通常 (电子邮件地址)

password
str
必需

用户的密码

authority
str

Azure Active Directory 终结点的颁发机构，例如“login.microsoftonline.com”，即 Azure 公有云 (的颁发机构，这是默认) 。 AzureAuthorityHosts 定义其他云的颁发机构。

tenant_id
str

租户 ID 或与租户关联的域。 如果未提供，则默认为“组织”租户，该租户仅支持 Azure Active Directory 工作或学校帐户。

cache_persistence_options
TokenCachePersistenceOptions

永久性令牌缓存的配置。 如果未指定，凭据将在内存中缓存令牌。

disable_instance_discovery
bool

确定尝试进行身份验证时是否执行实例发现。 将其设置为 true 将完全禁用实例发现和颁发机构验证。 此功能适用于无法访问元数据终结点的方案，例如在私有云或 Azure Stack 中。 实例发现过程需要从 https://login.microsoft.com/ 中检索颁发机构元数据以验证颁发机构。 通过将此项设置为 True，将禁用颁发机构的验证。 因此，确保配置的颁发机构主机有效且可信至关重要。

additionally_allowed_tenants
List[str]

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

示例

创建 UsernamePasswordCredential。


   from azure.identity import UsernamePasswordCredential

   credential = UsernamePasswordCredential(
       client_id="<client_id>",
       username="<username>",
       password="<password>",
   )

方法

authenticate

以交互方式对用户进行身份验证。
close
get_token

请求 范围的访问令牌。

此方法由 Azure SDK 客户端自动调用。

authenticate

以交互方式对用户进行身份验证。

authenticate(**kwargs: Any) -> AuthenticationRecord

参数

scopes
Iterable[str]

身份验证期间要请求的范围，例如 提供的 scopes作用域。 如果提供，成功的身份验证将缓存这些范围的访问令牌。

claims
str

令牌中所需的其他声明，例如由 提供的声明 claims

返回类型

AuthenticationRecord

例外

ClientAuthenticationError

身份验证失败。 错误的 message 属性提供了一个原因。

close 

close() -> None

例外

ClientAuthenticationError

身份验证失败。 错误的 message 属性提供了一个原因。

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

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

enable_cae
bool

指示是否为请求的令牌启用持续访问评估 (CAE) 。 默认为 False。

返回

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

返回类型

AccessToken

例外

CredentialUnavailableError

凭据无法尝试身份验证，因为它缺少所需的数据、状态或平台支持

ClientAuthenticationError

身份验证失败。 错误的 message 属性提供了一个原因。

AuthenticationRequiredError

用户交互是获取令牌所必需的，并且凭据配置为不自动开始此操作。 调用

authenticate

开始交互式身份验证。