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

ClientCertificateCredentialOptions interface

包:

@azure/identity

ClientCertificateCredential 类的可选参数。

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

属性

sendCertificateChain

包含用于 SubjectName 和颁发者名称授权的 x5c 标头的选项。 设置此选项以将客户端断言标头中的 base64 编码公共证书作为 x5c 声明发送

继承属性

additionallyAllowedTenants	对于多租户应用程序，指定凭据可能为其获取令牌的其他租户。 添加通配符值“*”以允许凭据为安装应用程序的任何租户获取令牌。
additionalPolicies	要包含在 HTTP 管道中的其他策略。
allowInsecureConnection	如果请求是通过 HTTP 而不是 HTTPS 发送的，则设置为 true
authorityHost	用于身份验证请求的颁发机构主机。 可以通过 AzureAuthorityHosts 获取可能的值。 默认为 "https://login.microsoftonline.com"。
disableInstanceDiscovery	字段确定在尝试进行身份验证时是否执行实例发现。 将其设置为 true 将完全禁用实例发现和颁发机构验证。 因此，确保配置的颁发机构主机有效且可信至关重要。 此功能适用于无法访问元数据终结点的方案，例如在私有云或 Azure Stack 中。 实例发现过程需要从 https://login.microsoft.com/ 中检索颁发机构元数据以验证颁发机构。
httpClient	将用于发送 HTTP 请求的 HttpClient。
loggingOptions	允许用户配置日志记录策略选项的设置，允许记录帐户信息和个人身份信息，以便客户支持。
proxyOptions	用于为传出请求配置代理的选项。
redirectOptions	有关如何处理重定向响应的选项。
retryOptions	控制如何重试失败请求的选项。
telemetryOptions	用于将常见遥测和跟踪信息设置为传出请求的选项。
tlsOptions	用于配置 TLS 身份验证的选项
tokenCachePersistenceOptions	在存储凭据时，如果) 可用，则向持久性层提供的选项 (。 必须先注册持久性提供程序插件。 @azure/identity-cache-persistence请参阅 NPM 上的包。 例如： import { cachePersistencePlugin } from "@azure/identity-cache-persistence"; import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity"; useIdentityPlugin(cachePersistencePlugin); async function main() { const credential = new DeviceCodeCredential({ tokenCachePersistenceOptions: { enabled: true } }); } main().catch((error) => { console.error("An error occurred:", error); process.exit(1); });
userAgentOptions	用于将用户代理详细信息添加到传出请求的选项。

属性详细信息

sendCertificateChain

包含用于 SubjectName 和颁发者名称授权的 x5c 标头的选项。 设置此选项以将客户端断言标头中的 base64 编码公共证书作为 x5c 声明发送

sendCertificateChain?: boolean

属性值

boolean

继承属性详细信息

additionallyAllowedTenants

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

additionallyAllowedTenants?: string[]

属性值

string[]

继承自MultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

属性值

AdditionalPolicyConfig[]

继承自MultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

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

allowInsecureConnection?: boolean

属性值

boolean

继承自MultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

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

authorityHost?: string

属性值

string

继承自MultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

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

disableInstanceDiscovery?: boolean

属性值

boolean

继承自AuthorityValidationOptions.disableInstanceDiscovery

httpClient

将用于发送 HTTP 请求的 HttpClient。

httpClient?: HttpClient

属性值

HttpClient

继承自MultiTenantTokenCredentialOptions.httpClient

loggingOptions

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

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

属性值

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

继承自MultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

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

proxyOptions?: ProxySettings

属性值

ProxySettings

继承自MultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

属性值

RedirectPolicyOptions

继承自MultiTenantTokenCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

属性值

PipelineRetryOptions

继承自MultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

属性值

TelemetryOptions

继承自MultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

用于配置 TLS 身份验证的选项

tlsOptions?: TlsSettings

属性值

TlsSettings

继承自MultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

在存储凭据时，如果) 可用，则向持久性层提供的选项 (。

必须先注册持久性提供程序插件。 @azure/identity-cache-persistence请参阅 NPM 上的包。

例如：

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

属性值

TokenCachePersistenceOptions

继承自CredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

属性值

UserAgentPolicyOptions

继承自MultiTenantTokenCredentialOptions.userAgentOptions