DefaultAzureCredential class
提供默认的 ChainedTokenCredential 配置,该配置适用于使用 Azure SDK 客户端库的大多数应用程序。 有关详细信息,请参阅 DefaultAzureCredential 概述。
将按顺序尝试以下凭据类型:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
有关这些凭据类型尝试身份验证的详细信息,请参阅这些凭据类型的文档。
选择凭据
设置环境变量 AZURE_TOKEN_CREDENTIALS 以选择凭据链的子集。 DefaultAzureCredential 将仅尝试指定的凭据 () ,但其其他行为保持不变。 AZURE_TOKEN_CREDENTIALS的有效值是上述链中任何单个类型的名称,例如“EnvironmentCredential”或“AzureCliCredential”,以及以下特殊值:
- “dev”:按此顺序尝试 [VisualStudioCodeCredential]、[AzureCliCredential]、[AzurePowerShellCredential] 和 [AzureDeveloperCliCredential]
- “prod”:按此顺序尝试 [EnvironmentCredential]、[WorkloadIdentityCredential] 和 [ManagedIdentityCredential]
构造函数
Default |
使用 DefaultAzureCredentialClientIdOptions创建 DefaultAzureCredential 类的实例。 |
Default |
使用 DefaultAzureCredentialOptions创建 DefaultAzureCredential 类的实例。 |
Default |
使用 DefaultAzureCredentialResourceIdOptions创建 DefaultAzureCredential 类的实例。 |
继承的方法
get |
返回链接 此方法由 Azure SDK 客户端库自动调用。 可以直接调用此方法,但还必须处理令牌缓存和令牌刷新。 |
构造函数详细信息
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
使用 DefaultAzureCredentialClientIdOptions创建 DefaultAzureCredential 类的实例。
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)
参数
可选参数。 请参阅 DefaultAzureCredentialClientIdOptions。
DefaultAzureCredential(DefaultAzureCredentialOptions)
使用 DefaultAzureCredentialOptions创建 DefaultAzureCredential 类的实例。
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)
参数
- options
- DefaultAzureCredentialOptions
可选参数。 请参阅 DefaultAzureCredentialOptions。
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
使用 DefaultAzureCredentialResourceIdOptions创建 DefaultAzureCredential 类的实例。
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)
参数
可选参数。 请参阅 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>