ClientCertificateCredentialBuilder Clase

Paquete:

com.azure.identity

Artefacto Maven:

com.azure:azure-identity:1.10.4

• java.lang.Object
• • com.azure.identity.CredentialBuilderBase<T>
  • • com.azure.identity.AadCredentialBuilderBase<T>
    • • com.azure.identity.ClientCertificateCredentialBuilder

public class ClientCertificateCredentialBuilder
extends AadCredentialBuilderBase<ClientCertificateCredentialBuilder>

Generador de credenciales de Fluent para crear instancias de .ClientCertificateCredential

ClientCertificateCredential adquiere un token a través de la autenticación de la entidad de servicio. Es un tipo de autenticación en Azure que permite un inicio de sesión no interactivo en Azure Active Directory (Azure AD), lo que permite que una aplicación o un servicio se autentiquen con recursos de Azure. Una entidad de servicio es básicamente una identidad creada para una aplicación de Azure AD que se puede usar para autenticarse con los recursos de Azure. Es como una "identidad de usuario" para la aplicación o el servicio, y proporciona una manera de que la aplicación se autentique con recursos de Azure sin necesidad de usar las credenciales de un usuario. Azure Active Directory (Azure AD) permite a los usuarios registrar entidades de servicio que se pueden usar como identidad para la autenticación. Un certificado de cliente asociado a la entidad de servicio registrada se usa como contraseña al autenticar la entidad de servicio. ClientCertificateCredentialBuilder adquiere un token de acceso con un certificado de cliente para una entidad de servicio o una aplicación de AAD registrada. Los valores tenantId, clientId y clientCertificate de la entidad de servicio son necesarios para que esta credencial adquiera un token de acceso. Se puede usar tanto en entornos de desarrollo hospedados como locales de Azure para la autenticación. Para obtener más información, consulte los detalles de configuración y conocimientos conceptuales.

Ejemplo: Construcción de un clientCertificateCredential simple

En el ejemplo de código siguiente se muestra la creación de un ClientCertificateCredentialobjeto , mediante para ClientCertificateCredentialBuilder configurarlo. Los tenantIdparámetros , clientId y certificate son necesarios para crear ClientCertificateCredential. Una vez creada esta credencial, se puede pasar al generador de muchos de los generadores de cliente de Azure SDK para Java como el parámetro "credential".

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

Ejemplo: Construcción de un clientCertificateCredential detrás de un proxy

En el ejemplo de código siguiente se muestra la creación de un ClientCertificateCredentialobjeto , mediante para ClientCertificateCredentialBuilder configurarlo. Los tenantIdparámetros , clientId y certificate son necesarios para crear ClientSecretCredential. proxyOptions Opcionalmente, se puede configurar para tener como destino un proxy. Una vez creada esta credencial, se puede pasar al generador de muchos de los generadores de cliente de Azure SDK para Java como el parámetro "credential".

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();

Resumen del constructor

Constructor	Description
ClientCertificateCredentialBuilder()

Resumen del método

Modificador y tipo	Método y descripción
ClientCertificateCredential	build() Crea un objeto con ClientCertificateCredential las configuraciones actuales.
ClientCertificateCredentialBuilder	pemCertificate(String certificatePath) Establece la ruta de acceso del certificado PEM para autenticarse en AAD.
ClientCertificateCredentialBuilder	pfxCertificate(String certificatePath, String clientCertificatePassword) Establece la ruta de acceso y la contraseña del certificado PFX para autenticarse en AAD.
ClientCertificateCredentialBuilder	sendCertificateChain(boolean sendCertificateChain) Especifica si se debe enviar la notificación x5c (clave pública del certificado) como parte de la solicitud de autenticación y habilitar la autenticación basada en el firmante o el emisor.
ClientCertificateCredentialBuilder	tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions) Configura las opciones de caché de tokens compartidos persistentes y habilita la caché de tokens persistente que está deshabilitada de forma predeterminada.

Métodos heredados de AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

Métodos heredados de CredentialBuilderBase

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

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

ClientCertificateCredentialBuilder

public ClientCertificateCredentialBuilder()

Detalles del método

build

public ClientCertificateCredential build()

Crea un objeto con ClientCertificateCredential las configuraciones actuales.

Returns:

con ClientCertificateCredential las configuraciones actuales.

pemCertificate

public ClientCertificateCredentialBuilder pemCertificate(String certificatePath)

Establece la ruta de acceso del certificado PEM para autenticarse en AAD.

Parameters:

certificatePath - el archivo PEM que contiene el certificado

Returns:

Instancia actualizada de este generador.

pfxCertificate

public ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)

Establece la ruta de acceso y la contraseña del certificado PFX para autenticarse en AAD.

Parameters:

certificatePath - el archivo PFX protegido con contraseña que contiene el certificado

clientCertificatePassword - la contraseña que protege el archivo PFX

Returns:

Instancia actualizada de este generador.

sendCertificateChain

public ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

Especifica si se debe enviar la notificación x5c (clave pública del certificado) como parte de la solicitud de autenticación y habilitar la autenticación basada en el firmante o el emisor. El valor predeterminado es false.

Parameters:

sendCertificateChain - marca que indica si se debe enviar la cadena de certificados como parte de la solicitud de autenticación.

Returns:

Instancia actualizada de este generador.

tokenCachePersistenceOptions

public ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Configura las opciones de caché de tokens compartidos persistentes y habilita la caché de tokens persistente que está deshabilitada de forma predeterminada. Si se configura, la credencial almacenará tokens en una memoria caché almacenada en la máquina, protegida para el usuario actual, que pueden compartir otras credenciales y procesos.

Parameters:

tokenCachePersistenceOptions - las opciones de configuración de la caché de tokens

Returns:

Instancia actualizada de este generador con las opciones de caché de tokens configuradas.