Freigeben über

ClientCertificateCredentialBuilder Klasse

  • Referenz
Paket:
com.azure.identity
Maven-Artefakt:
com.azure:azure-identity:1.10.4

public class ClientCertificateCredentialBuilder
extends AadCredentialBuilderBase<ClientCertificateCredentialBuilder>

Fluent-Generator für Anmeldeinformationen zum Instanziieren von ClientCertificateCredential.

ClientCertificateCredential ruft ein Token über die Dienstprinzipalauthentifizierung ab. Es handelt sich um einen Authentifizierungstyp in Azure, der eine nicht interaktive Anmeldung bei Azure Active Directory (Azure AD) ermöglicht, sodass sich eine Anwendung oder ein Dienst bei Azure-Ressourcen authentifizieren kann. Ein Dienstprinzipal ist im Wesentlichen eine Identität, die für eine Anwendung in Azure AD erstellt wurde und zur Authentifizierung bei Azure-Ressourcen verwendet werden kann. Es ähnelt einer "Benutzeridentität" für die Anwendung oder den Dienst und bietet eine Möglichkeit für die Anwendung, sich bei Azure-Ressourcen zu authentifizieren, ohne die Anmeldeinformationen eines Benutzers verwenden zu müssen. Mit Azure Active Directory (Azure AD) können Benutzer Dienstprinzipale registrieren, die als Identität für die Authentifizierung verwendet werden können. Bei der Authentifizierung des Dienstprinzipals wird ein dem registrierten Dienstprinzipal zugeordnetes Clientzertifikat als Kennwort verwendet. Der ClientCertificateCredentialBuilder ruft ein Zugriffstoken mit einem Clientzertifikat für eine Dienstprinzipal-/registrierte AAD-Anwendung ab. Die tenantId, clientId und clientCertificate des Dienstprinzipals sind erforderlich, damit diese Anmeldeinformationen ein Zugriffstoken abrufen können. Sie kann sowohl in von Azure gehosteten als auch in lokalen Entwicklungsumgebungen für die Authentifizierung verwendet werden. Weitere Informationen finden Sie in den konzeptionellen Kenntnissen und Konfigurationsdetails.

Beispiel: Erstellen eines einfachen ClientCertificateCredential

Im folgenden Codebeispiel wird die Erstellung eines ClientCertificateCredentialveranschaulicht, wobei verwendet wird, um sie ClientCertificateCredentialBuilder zu konfigurieren. Die tenantIdParameter und certificateclientId sind erforderlich, um zu erstellenClientCertificateCredential. Nachdem diese Anmeldeinformationen erstellt wurden, werden sie möglicherweise als "credential"-Parameter an den Generator vieler Client-Generatoren des Azure SDK für Java übergeben.

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

Beispiel: Erstellen eines ClientCertificateCredential hinter einem Proxy

Im folgenden Codebeispiel wird die Erstellung eines ClientCertificateCredentialveranschaulicht, wobei verwendet wird, um sie ClientCertificateCredentialBuilder zu konfigurieren. Die tenantIdParameter und certificateclientId sind erforderlich, um zu erstellenClientSecretCredential. Die proxyOptions kann optional für einen Proxy konfiguriert werden. Nachdem diese Anmeldeinformationen erstellt wurden, werden sie möglicherweise als "credential"-Parameter an den Generator vieler Client-Generatoren des Azure SDK für Java übergeben.

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

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
ClientCertificateCredentialBuilder()

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
ClientCertificateCredential build()

Erstellt eine neue ClientCertificateCredential mit den aktuellen Konfigurationen.
ClientCertificateCredentialBuilder pemCertificate(String certificatePath)

Legt den Pfad des PEM-Zertifikats für die Authentifizierung bei AAD fest.
ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)

Legt den Pfad und das Kennwort des PFX-Zertifikats für die Authentifizierung bei AAD fest.
ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

Gibt an, ob der x5c-Anspruch (öffentlicher Schlüssel des Zertifikats) als Teil der Authentifizierungsanforderung gesendet werden soll, und aktiviert die antragsteller-/ausstellerbasierte Authentifizierung.
ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Konfiguriert die Cacheoptionen für persistente freigegebene Token und aktiviert den persistenten Tokencache, der standardmäßig deaktiviert ist.

Geerbte Methoden von AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

Geerbte Methoden von CredentialBuilderBase

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

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

ClientCertificateCredentialBuilder

public ClientCertificateCredentialBuilder()

Details zur Methode

build

public ClientCertificateCredential build()

Erstellt eine neue ClientCertificateCredential mit den aktuellen Konfigurationen.

Returns:

a ClientCertificateCredential mit den aktuellen Konfigurationen.

pemCertificate

public ClientCertificateCredentialBuilder pemCertificate(String certificatePath)

Legt den Pfad des PEM-Zertifikats für die Authentifizierung bei AAD fest.

Parameters:

certificatePath - die PEM-Datei, die das Zertifikat enthält

Returns:

Eine aktualisierte instance dieses Generators.

pfxCertificate

public ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)

Legt den Pfad und das Kennwort des PFX-Zertifikats für die Authentifizierung bei AAD fest.

Parameters:

certificatePath - die kennwortgeschützte PFX-Datei mit dem Zertifikat
clientCertificatePassword - das Kennwort, das die PFX-Datei schützt

Returns:

Eine aktualisierte instance dieses Generators.

sendCertificateChain

public ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

Gibt an, ob der x5c-Anspruch (öffentlicher Schlüssel des Zertifikats) als Teil der Authentifizierungsanforderung gesendet werden soll, und aktiviert die antragsteller-/ausstellerbasierte Authentifizierung. Der Standardwert ist „FALSE“.

Parameters:

sendCertificateChain - das Flag, um anzugeben, ob die Zertifikatkette als Teil der Authentifizierungsanforderung gesendet werden soll.

Returns:

Eine aktualisierte instance dieses Generators.

tokenCachePersistenceOptions

public ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Konfiguriert die Cacheoptionen für persistente freigegebene Token und aktiviert den persistenten Tokencache, der standardmäßig deaktiviert ist. Wenn sie konfiguriert sind, speichern die Anmeldeinformationen Token in einem Cache, der auf dem Computer gespeichert ist und für den aktuellen Benutzer geschützt ist, der von anderen Anmeldeinformationen und Prozessen freigegeben werden kann.

Parameters:

tokenCachePersistenceOptions - Die Konfigurationsoptionen für den Tokencache

Returns:

Eine aktualisierte instance dieses Generators mit konfigurierten Tokencacheoptionen.

Gilt für: