通过

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

ClientCertificateCredentialBuilder 类

  • 参考
包:
com.azure.identity
Maven 项目:
com.azure:azure-identity:1.10.4

public class ClientCertificateCredentialBuilder
extends AadCredentialBuilderBase<ClientCertificateCredentialBuilder>

用于实例化 的 ClientCertificateCredentialFluent 凭据生成器。

ClientCertificateCredential 通过服务主体身份验证获取令牌。 它是 Azure 中的一种身份验证类型，支持以非交互式方式登录到 Azure Active Directory (Azure AD) ，允许应用程序或服务使用 Azure 资源对自身进行身份验证。 服务主体实质上是为 Azure AD 中的应用程序创建的标识，可用于对 Azure 资源进行身份验证。 它类似于应用程序或服务的“用户标识”，它为应用程序提供了一种使用 Azure 资源进行身份验证的方法，而无需使用用户的凭据。 Azure Active Directory (Azure AD) 允许用户注册可用作身份验证标识的服务主体。 在对服务主体进行身份验证时，会使用与已注册的服务主体关联的客户端证书作为密码。 为 ClientCertificateCredentialBuilder 服务主体/已注册的 AAD 应用程序获取具有客户端证书的访问令牌。 此凭据需要服务主体的 tenantId、clientId 和 clientCertificate 才能获取访问令牌。 可以在 Azure 托管和本地开发环境中使用它进行身份验证。 有关详细信息，请参阅 概念知识和配置详细信息。

示例：构造简单的 ClientCertificateCredential

下面的代码示例演示如何创建 ， ClientCertificateCredential使用 ClientCertificateCredentialBuilder 进行配置。 创建 tenantId需要 ClientCertificateCredential和 certificateclientId 参数。 创建此凭据后，它可能会作为“credential”参数传递到许多 Azure SDK for Java 客户端生成器的生成器中。

TokenCredential clientCertificateCredential = new ClientCertificateCredentialBuilder()
     .tenantId(tenantId)
     .clientId(clientId)
     .pemCertificate("<PATH-TO-PEM-CERTIFICATE>")
     .build();

示例：在代理后面构造 ClientCertificateCredential

下面的代码示例演示如何创建 ， ClientCertificateCredential使用 ClientCertificateCredentialBuilder 进行配置。 创建 tenantId需要 ClientSecretCredential和 certificateclientId 参数。 proxyOptions可以选择将 配置为以代理为目标。 创建此凭据后，它可能会作为“credential”参数传递到许多 Azure SDK for Java 客户端生成器的生成器中。

TokenCredential certificateCredential = new ClientCertificateCredentialBuilder()
     .tenantId(tenantId)
     .clientId(clientId)
     .pfxCertificate("<PATH-TO-PFX-CERTIFICATE>", "P@s$w0rd")
     .proxyOptions(new ProxyOptions(Type.HTTP, new InetSocketAddress("10.21.32.43", 5465)))
     .build();

构造函数摘要

构造函数 说明
ClientCertificateCredentialBuilder()

方法摘要

修饰符和类型 方法和描述
ClientCertificateCredential build()

ClientCertificateCredential使用当前配置创建新的 。
ClientCertificateCredentialBuilder pemCertificate(String certificatePath)

设置用于向 AAD 进行身份验证的 PEM 证书的路径。
ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)

设置 PFX 证书的路径和密码，以便对 AAD 进行身份验证。
ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

指定是否应将证书) 的 x5c 声明 (公钥作为身份验证请求的一部分发送，并启用基于使用者名称/颁发者的身份验证。
ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

配置永久性共享令牌缓存选项，并启用默认禁用的永久性令牌缓存。

方法继承自 AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

方法继承自 CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

构造函数详细信息

ClientCertificateCredentialBuilder

public ClientCertificateCredentialBuilder()

方法详细信息

build

public ClientCertificateCredential build()

ClientCertificateCredential使用当前配置创建新的 。

Returns:

具有当前配置的 。ClientCertificateCredential

pemCertificate

public ClientCertificateCredentialBuilder pemCertificate(String certificatePath)

设置用于向 AAD 进行身份验证的 PEM 证书的路径。

Parameters:

certificatePath - 包含证书的 PEM 文件

Returns:

此生成器的更新实例。

pfxCertificate

public ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)

设置 PFX 证书的路径和密码，以便对 AAD 进行身份验证。

Parameters:

certificatePath - 包含证书的密码保护 PFX 文件
clientCertificatePassword - 保护 PFX 文件的密码

Returns:

此生成器的更新实例。

sendCertificateChain

public ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

指定是否应将证书) 的 x5c 声明 (公钥作为身份验证请求的一部分发送，并启用基于使用者名称/颁发者的身份验证。 默认值为 false。

Parameters:

sendCertificateChain - 指示证书链是否应作为身份验证请求的一部分发送的标志。

Returns:

此生成器的更新实例。

tokenCachePersistenceOptions

public ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

配置永久性共享令牌缓存选项，并启用默认禁用的永久性令牌缓存。 如果已配置，凭据会将令牌存储在保存到计算机的缓存中，该缓存受当前用户保护，可由其他凭据和进程共享。

Parameters:

tokenCachePersistenceOptions - 令牌缓存配置选项

Returns:

此生成器的更新实例，其中配置了令牌缓存选项。

适用于