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

DefaultAzureCredential class

提供默认的 ChainedTokenCredential 配置,该配置适用于使用 Azure SDK 客户端库的大多数应用程序。 有关详细信息,请参阅 DefaultAzureCredential 概述

将按顺序尝试以下凭据类型:

有关这些凭据类型尝试身份验证的详细信息,请参阅这些凭据类型的文档。

以下示例演示如何使用该 requiredEnvVars 选项来确保在实例化之前 DefaultAzureCredential 设置某些环境变量。 如果任何指定的环境变量缺失或为空,则会抛出错误,从而阻止应用程序在没有必要配置的情况下继续执行。 它还演示了如何设置 AZURE_TOKEN_CREDENTIALS 环境变量以控制链中包含哪些凭据。

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});
扩展

构造函数

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

使用 DefaultAzureCredentialClientIdOptions创建 DefaultAzureCredential 类的实例。

DefaultAzureCredential(DefaultAzureCredentialOptions)

使用 DefaultAzureCredentialOptions创建 DefaultAzureCredential 类的实例。

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

使用 DefaultAzureCredentialResourceIdOptions创建 DefaultAzureCredential 类的实例。

继承的方法

getToken(string | string[], GetTokenOptions)

返回链接 TokenCredential 实现之一返回的第一个访问令牌。 当一个或多个凭据引发 AuthenticationError 且未返回访问令牌时,引发 AggregateAuthenticationError

此方法由 Azure SDK 客户端库自动调用。 可以直接调用此方法,但还必须处理令牌缓存和令牌刷新。

构造函数详细信息

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

使用 DefaultAzureCredentialClientIdOptions创建 DefaultAzureCredential 类的实例。

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

参数

DefaultAzureCredential(DefaultAzureCredentialOptions)

使用 DefaultAzureCredentialOptions创建 DefaultAzureCredential 类的实例。

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

参数

options
DefaultAzureCredentialOptions

可选参数。 请参阅 DefaultAzureCredentialOptions

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

使用 DefaultAzureCredentialResourceIdOptions创建 DefaultAzureCredential 类的实例。

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

参数

继承的方法详细信息

getToken(string | string[], GetTokenOptions)

返回链接 TokenCredential 实现之一返回的第一个访问令牌。 当一个或多个凭据引发 AuthenticationError 且未返回访问令牌时,引发 AggregateAuthenticationError

此方法由 Azure SDK 客户端库自动调用。 可以直接调用此方法,但还必须处理令牌缓存和令牌刷新。

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

参数

scopes

string | string[]

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

options
GetTokenOptions

用于配置此 TokenCredential 实现可能发出的任何请求的选项。

返回

Promise<AccessToken>

继承自ChainedTokenCredential.getToken