通过

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

DefaultAzureCredentialResourceIdOptions interface

  • 参考
包:
@azure/identity

提供用于配置 DefaultAzureCredential 类的选项。 此变体支持 managedIdentityResourceId，不支持 managedIdentityClientId，因为仅支持其中一个。

扩展
DefaultAzureCredentialOptions

属性

managedIdentityResourceId

（可选）传入 ManagedIdentityCredential要使用的资源 ID。 在使用 ARM 模板创建用户分配的标识（其中标识的资源 ID 已知但客户端 ID 无法提前知道）的情况下，此参数允许程序使用这些用户分配的标识，而无需先确定已创建的标识的客户端 ID。

继承属性

additionallyAllowedTenants

对于多租户应用程序，指定凭据可以获取令牌的其他租户。 添加通配符值“*”，以允许凭据获取安装应用程序的任何租户的令牌。
additionalPolicies

要包含在 HTTP 管道中的其他策略。
agent

为传出请求配置代理实例的选项
allowInsecureConnection

如果请求通过 HTTP 而不是 HTTPS 发送，则设置为 true
authorityHost

用于身份验证请求的颁发机构主机。 可以通过 azureAuthorityHosts 获取可能的值。 默认值为“https://login.microsoftonline.com"。
disableInstanceDiscovery

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

将用于发送 HTTP 请求的 HttpClient。
loggingOptions

允许用户配置日志记录策略选项的设置、允许日志记录帐户信息和客户支持的个人身份信息。
processTimeoutInMs

超时可配置为开发人员凭据发出令牌请求，即 <xref:AzurePowershellCredential>、AzureDeveloperCliCredential 和 AzureCliCredential。 应以毫秒为单位提供凭据的进程超时。
proxyOptions

为传出请求配置代理的选项。
redirectOptions

有关如何处理重定向响应的选项。
retryOptions

控制如何重试失败请求的选项。
telemetryOptions

用于将常见遥测和跟踪信息设置为传出请求的选项。
tenantId

（可选）传入要用作凭据一部分的租户 ID。 默认情况下，它可能会根据基础凭据使用通用租户 ID。
tlsOptions

配置 TLS 身份验证的选项
userAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

属性详细信息

managedIdentityResourceId

（可选）传入 ManagedIdentityCredential要使用的资源 ID。 在使用 ARM 模板创建用户分配的标识（其中标识的资源 ID 已知但客户端 ID 无法提前知道）的情况下，此参数允许程序使用这些用户分配的标识，而无需先确定已创建的标识的客户端 ID。

managedIdentityResourceId: string

属性值

string

继承属性详细信息

additionallyAllowedTenants

对于多租户应用程序，指定凭据可以获取令牌的其他租户。 添加通配符值“*”，以允许凭据获取安装应用程序的任何租户的令牌。

additionallyAllowedTenants?: string[]

属性值

string[]

继承自DefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

要包含在 HTTP 管道中的其他策略。

additionalPolicies?: AdditionalPolicyConfig[]

属性值

AdditionalPolicyConfig[]

继承自DefaultAzureCredentialOptions.additionalPolicies

agent

为传出请求配置代理实例的选项

agent?: Agent

属性值

Agent

继承自DefaultAzureCredentialOptions.agent

allowInsecureConnection

如果请求通过 HTTP 而不是 HTTPS 发送，则设置为 true

allowInsecureConnection?: boolean

属性值

boolean

继承自DefaultAzureCredentialOptions.allowInsecureConnection

authorityHost

用于身份验证请求的颁发机构主机。 可以通过 azureAuthorityHosts 获取可能的值。 默认值为“https://login.microsoftonline.com"。

authorityHost?: string

属性值

string

继承自DefaultAzureCredentialOptions.authorityHost

disableInstanceDiscovery

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

disableInstanceDiscovery?: boolean

属性值

boolean

继承自DefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

将用于发送 HTTP 请求的 HttpClient。

httpClient?: HttpClient

属性值

HttpClient

继承自DefaultAzureCredentialOptions.httpClient

loggingOptions

允许用户配置日志记录策略选项的设置、允许日志记录帐户信息和客户支持的个人身份信息。

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

属性值

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

继承自DefaultAzureCredentialOptions.loggingOptions

processTimeoutInMs

超时可配置为开发人员凭据发出令牌请求，即 <xref:AzurePowershellCredential>、AzureDeveloperCliCredential 和 AzureCliCredential。 应以毫秒为单位提供凭据的进程超时。

processTimeoutInMs?: number

属性值

number

继承自defaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

为传出请求配置代理的选项。

proxyOptions?: ProxySettings

属性值

ProxySettings

继承自DefaultAzureCredentialOptions.proxyOptions

redirectOptions

有关如何处理重定向响应的选项。

redirectOptions?: RedirectPolicyOptions

属性值

RedirectPolicyOptions

继承自DefaultAzureCredentialOptions.redirectOptions

retryOptions

控制如何重试失败请求的选项。

retryOptions?: PipelineRetryOptions

属性值

PipelineRetryOptions

继承自DefaultAzureCredentialOptions.retryOptions

telemetryOptions

用于将常见遥测和跟踪信息设置为传出请求的选项。

telemetryOptions?: TelemetryOptions

属性值

TelemetryOptions

继承自DefaultAzureCredentialOptions.telemetryOptions

tenantId

（可选）传入要用作凭据一部分的租户 ID。 默认情况下，它可能会根据基础凭据使用通用租户 ID。

tenantId?: string

属性值

string

继承自DefaultAzureCredentialOptions.tenantId

tlsOptions

配置 TLS 身份验证的选项

tlsOptions?: TlsSettings

属性值

TlsSettings

继承自DefaultAzureCredentialOptions.tlsOptions

userAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

userAgentOptions?: UserAgentPolicyOptions

属性值

UserAgentPolicyOptions

继承自DefaultAzureCredentialOptions.userAgentOptions