你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
DefaultAzureCredentialClientIdOptions interface
提供用于配置 DefaultAzureCredential 类的选项。
此变体支持 managedIdentityClientId
而不是 managedIdentityResourceId
,因为两者只支持其中一个。
- Extends
属性
managed |
(可选)传入要由 ManagedIdentityCredential 使用的用户分配的客户端 ID。 还可以通过环境变量将此客户端 ID 传递给 ManagedIdentityCredential :AZURE_CLIENT_ID。 |
workload |
(可选)传入用户分配的客户端 ID,供 WorkloadIdentityCredential 使用。 还可以通过环境变量将此客户端 ID 传递到 WorkloadIdentityCredential :AZURE_CLIENT_ID。 |
继承属性
additionally |
对于多租户应用程序,指定凭据可能为其获取令牌的其他租户。 添加通配符值“*”以允许凭据为安装应用程序的任何租户获取令牌。 |
additional |
要包含在 HTTP 管道中的其他策略。 |
allow |
如果请求是通过 HTTP 而不是 HTTPS 发送的,则设置为 true |
authority |
用于身份验证请求的颁发机构主机。 可以通过 AzureAuthorityHosts 获取可能的值。 默认为 "https://login.microsoftonline.com"。 |
disable |
字段确定在尝试进行身份验证时是否执行实例发现。
将其设置为 |
http |
将用于发送 HTTP 请求的 HttpClient。 |
logging |
允许用户配置日志记录策略选项的设置,允许记录帐户信息和个人身份信息,以便客户支持。 |
process |
超时可配置为针对开发人员凭据发出令牌请求,即 <xref:AzurePowershellCredential>、 AzureDeveloperCliCredential 和 AzureCliCredential。 凭据的进程超时应以毫秒为单位提供。 |
proxy |
用于为传出请求配置代理的选项。 |
redirect |
有关如何处理重定向响应的选项。 |
retry |
控制如何重试失败请求的选项。 |
telemetry |
用于将常见遥测和跟踪信息设置为传出请求的选项。 |
tenant |
(可选)传入要用作凭据一部分的租户 ID。 默认情况下,它可能会使用泛型租户 ID,具体取决于基础凭据。 |
tls |
用于配置 TLS 身份验证的选项 |
user |
用于将用户代理详细信息添加到传出请求的选项。 |
属性详细信息
managedIdentityClientId
(可选)传入要由 ManagedIdentityCredential 使用的用户分配的客户端 ID。 还可以通过环境变量将此客户端 ID 传递给 ManagedIdentityCredential :AZURE_CLIENT_ID。
managedIdentityClientId?: string
属性值
string
workloadIdentityClientId
(可选)传入用户分配的客户端 ID,供 WorkloadIdentityCredential 使用。 还可以通过环境变量将此客户端 ID 传递到 WorkloadIdentityCredential :AZURE_CLIENT_ID。
workloadIdentityClientId?: string
属性值
string
继承属性详细信息
additionallyAllowedTenants
对于多租户应用程序,指定凭据可能为其获取令牌的其他租户。 添加通配符值“*”以允许凭据为安装应用程序的任何租户获取令牌。
additionallyAllowedTenants?: string[]
属性值
string[]
additionalPolicies
要包含在 HTTP 管道中的其他策略。
additionalPolicies?: AdditionalPolicyConfig[]
属性值
allowInsecureConnection
如果请求是通过 HTTP 而不是 HTTPS 发送的,则设置为 true
allowInsecureConnection?: boolean
属性值
boolean
authorityHost
用于身份验证请求的颁发机构主机。 可以通过 AzureAuthorityHosts 获取可能的值。 默认为 "https://login.microsoftonline.com"。
authorityHost?: string
属性值
string
disableInstanceDiscovery
字段确定在尝试进行身份验证时是否执行实例发现。
将其设置为 true
将完全禁用实例发现和颁发机构验证。
因此,确保配置的颁发机构主机有效且可信至关重要。
此功能适用于无法访问元数据终结点的方案,例如在私有云或 Azure Stack 中。
实例发现过程需要从 https://login.microsoft.com/ 中检索颁发机构元数据以验证颁发机构。
disableInstanceDiscovery?: boolean
属性值
boolean
httpClient
将用于发送 HTTP 请求的 HttpClient。
httpClient?: HttpClient
属性值
loggingOptions
允许用户配置日志记录策略选项的设置,允许记录帐户信息和个人身份信息,以便客户支持。
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
属性值
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
processTimeoutInMs
超时可配置为针对开发人员凭据发出令牌请求,即 <xref:AzurePowershellCredential>、 AzureDeveloperCliCredential 和 AzureCliCredential。 凭据的进程超时应以毫秒为单位提供。
processTimeoutInMs?: number
属性值
number
proxyOptions
用于为传出请求配置代理的选项。
proxyOptions?: ProxySettings
属性值
redirectOptions
有关如何处理重定向响应的选项。
redirectOptions?: RedirectPolicyOptions
属性值
retryOptions
控制如何重试失败请求的选项。
retryOptions?: PipelineRetryOptions
属性值
telemetryOptions
用于将常见遥测和跟踪信息设置为传出请求的选项。
telemetryOptions?: TelemetryOptions
属性值
tenantId
(可选)传入要用作凭据一部分的租户 ID。 默认情况下,它可能会使用泛型租户 ID,具体取决于基础凭据。
tenantId?: string
属性值
string
tlsOptions
用于配置 TLS 身份验证的选项
tlsOptions?: TlsSettings
属性值
userAgentOptions
用于将用户代理详细信息添加到传出请求的选项。
userAgentOptions?: UserAgentPolicyOptions