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

EnvironmentCredential class

允许使用客户端机密或证书Microsoft Entra ID进行身份验证,或者以具有用户名和密码的用户身份进行身份验证。

构造函数

EnvironmentCredential(EnvironmentCredentialOptions)

创建 EnvironmentCredential 类的实例,并根据可用的环境变量决定要使用的凭据。

必需的环境变量:

  • AZURE_TENANT_ID:Microsoft Entra租户 (目录) ID。
  • AZURE_CLIENT_ID:客户端 (应用程序) 租户中应用注册的 ID。

如果设置AZURE_TENANT_ID,则还可以设置其他允许的租户

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS:对于多租户应用程序,指定凭据可以使用单个分号分隔字符串获取令牌的其他租户。 使用 * 允许所有租户。

用于客户端凭据身份验证的环境变量:

  • AZURE_CLIENT_SECRET:为应用注册生成的客户端密码。
  • AZURE_CLIENT_CERTIFICATE_PATH:身份验证期间要使用的 PEM 证书的路径,而不是客户端密码。
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (证书文件的可选) 密码。

或者,用户可以为用户名和密码身份验证提供环境变量:

  • AZURE_USERNAME:用于进行身份验证的用户名。
  • AZURE_PASSWORD:用于进行身份验证的密码。

如果缺少执行身份验证所需的环境变量,则会引发 CredentialUnavailableError 。 如果身份验证失败,或者存在未知错误,则会引发 AuthenticationError

方法

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。

构造函数详细信息

EnvironmentCredential(EnvironmentCredentialOptions)

创建 EnvironmentCredential 类的实例,并根据可用的环境变量决定要使用的凭据。

必需的环境变量:

  • AZURE_TENANT_ID:Microsoft Entra租户 (目录) ID。
  • AZURE_CLIENT_ID:客户端 (应用程序) 租户中应用注册的 ID。

如果设置AZURE_TENANT_ID,则还可以设置其他允许的租户

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS:对于多租户应用程序,指定凭据可以使用单个分号分隔字符串获取令牌的其他租户。 使用 * 允许所有租户。

用于客户端凭据身份验证的环境变量:

  • AZURE_CLIENT_SECRET:为应用注册生成的客户端密码。
  • AZURE_CLIENT_CERTIFICATE_PATH:身份验证期间要使用的 PEM 证书的路径,而不是客户端密码。
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (证书文件的可选) 密码。

或者,用户可以为用户名和密码身份验证提供环境变量:

  • AZURE_USERNAME:用于进行身份验证的用户名。
  • AZURE_PASSWORD:用于进行身份验证的密码。

如果缺少执行身份验证所需的环境变量,则会引发 CredentialUnavailableError 。 如果身份验证失败,或者存在未知错误,则会引发 AuthenticationError

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

参数

options
EnvironmentCredentialOptions

用于配置发出身份验证请求的客户端的选项。

方法详细信息

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

参数

scopes

string | string[]

令牌将有权访问的范围列表。

options
GetTokenOptions

可选参数。 请参阅 GetTokenOptions

返回

Promise<AccessToken>