ClientCertificateCredentialBuilder Classe

Paquet:

com.azure.identity

Artefact 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>

Générateur d’informations d’identification Fluent pour instancier un ClientCertificateCredential.

ClientCertificateCredential acquiert un jeton via l’authentification du principal de service. Il s’agit d’un type d’authentification dans Azure qui permet une connexion non interactive à Azure Active Directory (Azure AD), ce qui permet à une application ou à un service de s’authentifier auprès des ressources Azure. Un principal de service est essentiellement une identité créée pour une application dans Azure AD qui peut être utilisée pour s’authentifier auprès des ressources Azure. Il s’agit d’une « identité d’utilisateur » pour l’application ou le service, et permet à l’application de s’authentifier auprès des ressources Azure sans avoir à utiliser les informations d’identification d’un utilisateur. Azure Active Directory (Azure AD) permet aux utilisateurs d’inscrire des principaux de service qui peuvent être utilisés comme identité pour l’authentification. Un certificat client associé au principal de service inscrit est utilisé comme mot de passe lors de l’authentification du principal de service. Le ClientCertificateCredentialBuilder acquiert un jeton d’accès avec un certificat client pour un principal de service/une application AAD inscrite. TenantId, clientId et clientCertificate du principal de service sont requis pour que ces informations d’identification acquièrent un jeton d’accès. Il peut être utilisé à la fois dans les environnements de développement locaux et hébergés par Azure pour l’authentification. Pour plus d’informations, reportez-vous aux connaissances conceptuelles et aux détails de configuration.

Exemple : Construire un clientCertificateCredential simple

L’exemple de code suivant illustre la création d’un ClientCertificateCredential, à l’aide de pour le ClientCertificateCredentialBuilder configurer. Les tenantIdparamètres , clientId et certificate sont requis pour créer ClientCertificateCredential. Une fois ces informations d’identification créées, elles peuvent être passées au générateur de la plupart des générateurs de clients du SDK Azure pour Java en tant que paramètre « credential ».

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

Exemple : Construire un ClientCertificateCredential derrière un proxy

L’exemple de code suivant illustre la création d’un ClientCertificateCredential, à l’aide de pour le ClientCertificateCredentialBuilder configurer. Les tenantIdparamètres , clientId et certificate sont requis pour créer ClientSecretCredential. Peut proxyOptions éventuellement être configuré pour cibler un proxy. Une fois ces informations d’identification créées, elles peuvent être passées au générateur de la plupart des générateurs de clients du SDK Azure pour Java en tant que paramètre « 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();

Récapitulatif du constructeur

Constructeur	Description
ClientCertificateCredentialBuilder()

Résumé de la méthode

Modificateur et type	Méthode et description
ClientCertificateCredential	build() Crée un nouveau ClientCertificateCredential avec les configurations actuelles.
ClientCertificateCredentialBuilder	pemCertificate(String certificatePath) Définit le chemin d’accès du certificat PEM pour l’authentification auprès d’AAD.
ClientCertificateCredentialBuilder	pfxCertificate(String certificatePath, String clientCertificatePassword) Définit le chemin d’accès et le mot de passe du certificat PFX pour l’authentification auprès d’AAD.
ClientCertificateCredentialBuilder	sendCertificateChain(boolean sendCertificateChain) Spécifie si la revendication x5c (clé publique du certificat) doit être envoyée dans le cadre de la demande d’authentification et activer l’authentification basée sur le nom de l’objet/l’émetteur.
ClientCertificateCredentialBuilder	tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions) Configure les options de cache de jetons partagés persistants et active le cache de jetons persistants, qui est désactivé par défaut.

Méthodes héritées de AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

Méthodes héritées de CredentialBuilderBase

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

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du constructeur

ClientCertificateCredentialBuilder

public ClientCertificateCredentialBuilder()

Détails de la méthode

build

public ClientCertificateCredential build()

Crée un nouveau ClientCertificateCredential avec les configurations actuelles.

Returns:

avec ClientCertificateCredential les configurations actuelles.

pemCertificate

public ClientCertificateCredentialBuilder pemCertificate(String certificatePath)

Définit le chemin d’accès du certificat PEM pour l’authentification auprès d’AAD.

Parameters:

certificatePath - fichier PEM contenant le certificat

Returns:

Mise à jour instance de ce générateur.

pfxCertificate

public ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)

Définit le chemin d’accès et le mot de passe du certificat PFX pour l’authentification auprès d’AAD.

Parameters:

certificatePath - fichier PFX protégé par mot de passe contenant le certificat

clientCertificatePassword - le mot de passe protégeant le fichier PFX

Returns:

Mise à jour instance de ce générateur.

sendCertificateChain

public ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

Spécifie si la revendication x5c (clé publique du certificat) doit être envoyée dans le cadre de la demande d’authentification et activer l’authentification basée sur le nom de l’objet/l’émetteur. La valeur par défaut est false.

Parameters:

sendCertificateChain - indicateur pour indiquer si la chaîne de certificats doit être envoyée dans le cadre de la demande d’authentification.

Returns:

Mise à jour instance de ce générateur.

tokenCachePersistenceOptions

public ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Configure les options de cache de jetons partagés persistants et active le cache de jetons persistants, qui est désactivé par défaut. Si elles sont configurées, les informations d’identification stockent les jetons dans un cache conservé sur l’ordinateur, protégé pour l’utilisateur actuel, qui peut être partagé par d’autres informations d’identification et processus.

Parameters:

tokenCachePersistenceOptions - options de configuration du cache de jetons

Returns:

Une instance mise à jour de ce générateur avec les options de cache de jeton configurées.