DefaultAzureCredentialBuilder Klasse

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

public class DefaultAzureCredentialBuilder
extends CredentialBuilderBase<DefaultAzureCredentialBuilder>

Fluent-Anmeldeinformationsgenerator zum Instanziieren von DefaultAzureCredential.

eignet DefaultAzureCredential sich für die meisten Szenarien, in denen die Anwendung letztendlich in Azure ausgeführt werden soll. DefaultAzureCredential kombiniert Anmeldeinformationen, die häufig für die Authentifizierung bei der Bereitstellung verwendet werden, mit Anmeldeinformationen, die für die Authentifizierung in einer Entwicklungsumgebung verwendet werden. DefaultAzureCredential versucht, die Authentifizierung über die folgenden Mechanismen in der angegebenen Reihenfolge auszuführen.

Beispiel: Erstellen von DefaultAzureCredential

Im folgenden Codebeispiel wird die Erstellung eines DefaultAzureCredentialveranschaulicht, wobei der DefaultAzureCredentialBuilder zum Konfigurieren verwendet wird. Nachdem diese Anmeldeinformationen erstellt wurden, können sie als Parameter "credential" an den Generator vieler Client-Generatoren des Azure SDK für Java übergeben werden.

TokenCredential defaultAzureCredential = new DefaultAzureCredentialBuilder()
     .build();

Beispiel: Erstellen von DefaultAzureCredential mit benutzerseitig zugewiesener verwalteter Identität

User-Assigned verwaltete Identität (UAMI) in Azure ist ein Feature, mit dem Sie in Azure Active Directory (Azure AD) eine Identität erstellen können, die einer oder mehreren Azure-Ressourcen zugeordnet ist. Diese Identität kann dann verwendet werden, um den Zugriff auf verschiedene Azure-Dienste und -Ressourcen zu authentifizieren und zu autorisieren. Im folgenden Codebeispiel wird die Erstellung einer DefaultAzureCredential für eine benutzerseitig zugewiesene verwaltete Identität veranschaulicht, wobei der DefaultAzureCredentialBuilder zum Konfigurieren verwendet wird. Nachdem diese Anmeldeinformationen erstellt wurden, können sie als Parameter "credential" an den Generator vieler Client-Generatoren des Azure SDK für Java übergeben werden.

TokenCredential dacWithUserAssignedManagedIdentity = new DefaultAzureCredentialBuilder()
     .managedIdentityClientId("<Managed-Identity-Client-Id")
     .build();

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
DefaultAzureCredentialBuilder()

Erstellt eine instance eines StandardmäßigenAzure-Anmeldeinformations-Generators.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
DefaultAzureCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können.
DefaultAzureCredentialBuilder additionallyAllowedTenants(List<String> additionallyAllowedTenants)

Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können.
DefaultAzureCredentialBuilder authorityHost(String authorityHost)

Gibt den Azure Active Directory-Endpunkt zum Abrufen von Token an.
DefaultAzureCredential build()

Erstellt neu DefaultAzureCredential mit den konfigurierten Optionen.
DefaultAzureCredentialBuilder credentialProcessTimeout(Duration credentialProcessTimeout)

Gibt ein Duration Timeout für Entwickleranmeldeinformationen (z. B. Azure CLI) an, die auf separaten Prozessaufrufen basieren.
DefaultAzureCredentialBuilder disableInstanceDiscovery()

Deaktiviert die Einstellung, die bestimmt, ob beim Authentifizierungsversuch instance Ermittlung ausgeführt wird.
DefaultAzureCredentialBuilder executorService(ExecutorService executorService)

Gibt den Executor-Dienstan, der zum Ausführen der Authentifizierungsanforderungen verwendet werden soll.
DefaultAzureCredentialBuilder intelliJKeePassDatabasePath(String databasePath)

Gibt den KeePass-Datenbankpfad an, um die zwischengespeicherten Anmeldeinformationen des Azure-Toolkits für IntelliJ-Plug-In zu lesen.
DefaultAzureCredentialBuilder managedIdentityClientId(String clientId)

Gibt die Client-ID der vom Benutzer zugewiesenen oder vom System zugewiesenen Identität an, wenn diese Anmeldeinformationen in einer Umgebung mit verwalteten Identitäten ausgeführt werden.
DefaultAzureCredentialBuilder managedIdentityResourceId(String resourceId)

Gibt die Ressourcen-ID der vom Benutzer zugewiesenen oder vom System zugewiesenen Identität an, wenn diese Anmeldeinformationen in einer Umgebung mit verwalteten Identitäten ausgeführt werden.
DefaultAzureCredentialBuilder tenantId(String tenantId)

Legt die Mandanten-ID des Benutzers fest, der sich über authentifizieren DefaultAzureCredentialsoll.
DefaultAzureCredentialBuilder workloadIdentityClientId(String clientId)

Gibt die Client-ID der Azure AD-App an, die für die AKS-Workloadidentitätsauthentifizierung verwendet werden soll.

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

DefaultAzureCredentialBuilder

public DefaultAzureCredentialBuilder()

Erstellt eine instance eines DefaultAzureCredentialBuilders.

Details zur Methode

additionallyAllowedTenants

public DefaultAzureCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, für den die Anwendung installiert ist.

Parameters:

additionallyAllowedTenants - die zusätzlich zulässigen Mandanten.

Returns:

Eine aktualisierte instance dieses Generators, wobei die Mandanten-ID wie angegeben festgelegt ist.

additionallyAllowedTenants

public DefaultAzureCredentialBuilder additionallyAllowedTenants(List additionallyAllowedTenants)

Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, für den die Anwendung installiert ist.

Parameters:

additionallyAllowedTenants - die zusätzlich zulässigen Mandanten.

Returns:

Eine aktualisierte instance dieses Generators, wobei die Mandanten-ID wie angegeben festgelegt ist.

authorityHost

public DefaultAzureCredentialBuilder authorityHost(String authorityHost)

Gibt den Azure Active Directory-Endpunkt zum Abrufen von Token an.

Parameters:

authorityHost - Der Azure Active Directory-Endpunkt

Returns:

Eine aktualisierte instance dieses Generators, wobei der Autoritätshost wie angegeben festgelegt ist.

build

public DefaultAzureCredential build()

Erstellt neu DefaultAzureCredential mit den konfigurierten Optionen.

Returns:

a DefaultAzureCredential mit den aktuellen Konfigurationen.

credentialProcessTimeout

public DefaultAzureCredentialBuilder credentialProcessTimeout(Duration credentialProcessTimeout)

Gibt ein Duration Timeout für Entwickleranmeldeinformationen (z. B. Azure CLI) an, die auf separaten Prozessaufrufen basieren.

Parameters:

credentialProcessTimeout - Die Duration zu wartende.

Returns:

Eine aktualisierte instance dieses Generators mit dem angegebenen Timeout.

disableInstanceDiscovery

public DefaultAzureCredentialBuilder disableInstanceDiscovery()

Deaktiviert die Einstellung, die bestimmt, ob beim Authentifizierungsversuch instance Ermittlung ausgeführt wird. Dadurch werden sowohl die instance ermittlung als auch die Validierung von Autoritäten vollständig deaktiviert. Diese Funktionalität ist für die Verwendung in Szenarien vorgesehen, in denen der Metadatenendpunkt nicht erreicht werden kann, z. B. in privaten Clouds oder Azure Stack. Der Prozess der instance Ermittlung umfasst das Abrufen von Autoritätsmetadaten aus, https://login.microsoft.com/ um die Autorität zu überprüfen. Durch Die Verwendung dieser API wird die Validierung der Autorität deaktiviert. Daher ist es wichtig sicherzustellen, dass der konfigurierte Autoritätshost gültig und vertrauenswürdig ist.

Returns:

Eine aktualisierte instance dieses Generators mit deaktivierter instance Ermittlung.

executorService

public DefaultAzureCredentialBuilder executorService(ExecutorService executorService)

Gibt den ExecutorService an, der zum Ausführen der Authentifizierungsanforderungen verwendet werden soll. Entwickler sind für die Aufrechterhaltung des Lebenszyklus von ExecutorService verantwortlich.

Wenn dies nicht konfiguriert ist, wird verwendet common fork join pool , das auch für andere Anwendungsaufgaben freigegeben wird. Wenn der gemeinsame Pool stark für andere Aufgaben verwendet wird, können Authentifizierungsanforderungen verhungern, und die Einrichtung dieses Executordiensts sollte in Betracht gezogen werden.

Der Executordienst und kann sicher heruntergefahren werden, wenn tokenCredential nicht mehr von den Azure SDK-Clients verwendet wird und vor dem Beenden der Anwendung heruntergefahren werden sollte.

Parameters:

executorService - der Executordienst, der zum Ausführen von Authentifizierungsanforderungen verwendet werden soll.

Returns:

Eine aktualisierte instance dieses Generators, wobei der Executordienst wie angegeben festgelegt ist.

intelliJKeePassDatabasePath

public DefaultAzureCredentialBuilder intelliJKeePassDatabasePath(String databasePath)

Gibt den KeePass-Datenbankpfad zum Lesen der zwischengespeicherten Anmeldeinformationen des Azure-Toolkits für IntelliJ-Plug-In an. Ist databasePath auf der Windows-Plattform erforderlich. Für macOS und die Linux-Plattform wird auf native Schlüsselkette bzw. Schlüsselring zugegriffen, um die zwischengespeicherten Anmeldeinformationen abzurufen.

Dieser Pfad kann sich in der IntelliJ-IDE befinden. Windows: Datei –> Einstellungen –> Darstellungsverhalten & –> Systemeinstellungen –> Kennwörter.

Parameters:

databasePath - der Pfad zur KeePass-Datenbank.

Returns:

Eine aktualisierte instance dieses Generators, wobei der KeePass-Datenbankpfad wie angegeben festgelegt ist.

managedIdentityClientId

public DefaultAzureCredentialBuilder managedIdentityClientId(String clientId)

Gibt die Client-ID der vom Benutzer zugewiesenen oder vom System zugewiesenen Identität an, wenn diese Anmeldeinformationen in einer Umgebung mit verwalteten Identitäten ausgeführt werden. Wenn nicht festgelegt, wird der Wert in der umgebungsvariablen AZURE_CLIENT_ID verwendet. Wenn keines festgelegt ist, ist der Standardwert NULL und funktioniert nur mit systemseitig zugewiesenen verwalteten Identitäten und nicht mit benutzerseitig zugewiesenen verwalteten Identitäten. Es kann nur eine der Optionen managedIdentityClientId und managedIdentityResourceId angegeben werden.

Parameters:

clientId - Die Client-ID

Returns:

DefaultAzureCredentialBuilder selbst

managedIdentityResourceId

public DefaultAzureCredentialBuilder managedIdentityResourceId(String resourceId)

Gibt die Ressourcen-ID der vom Benutzer zugewiesenen oder vom System zugewiesenen Identität an, wenn diese Anmeldeinformationen in einer Umgebung mit verwalteten Identitäten ausgeführt werden. Wenn nicht festgelegt, wird der Wert in der umgebungsvariablen AZURE_CLIENT_ID verwendet. Wenn keines festgelegt ist, ist der Standardwert NULL und funktioniert nur mit systemseitig zugewiesenen verwalteten Identitäten und nicht mit benutzerseitig zugewiesenen verwalteten Identitäten. Es kann nur eine der Optionen managedIdentityResourceId und managedIdentityClientId angegeben werden.

Parameters:

resourceId - Die Ressourcen-ID

Returns:

DefaultAzureCredentialBuilder selbst

tenantId

public DefaultAzureCredentialBuilder tenantId(String tenantId)

Legt die Mandanten-ID des Benutzers fest, der sich über authentifizieren DefaultAzureCredentialsoll. Wenn nicht festgelegt, wird der Wert in der umgebungsvariablen AZURE_TENANT_ID verwendet. Wenn keines festgelegt ist, ist der Standardwert NULL und authentifiziert Benutzer bei ihrem Standardmandanten.

Parameters:

tenantId - die festzulegende Mandanten-ID.

Returns:

Eine aktualisierte instance dieses Generators, wobei die Mandanten-ID wie angegeben festgelegt ist.

workloadIdentityClientId

public DefaultAzureCredentialBuilder workloadIdentityClientId(String clientId)

Gibt die Client-ID der Azure AD-App an, die für die AKS-Workloadidentitätsauthentifizierung verwendet werden soll. wenn nicht festgelegt, managedIdentityClientId(String clientId) wird verwendet. Wenn beide Werte nicht festgelegt sind, wird der Wert in der umgebungsvariablen AZURE_CLIENT_ID verwendet. Wenn keine festgelegt ist, ist der Standardwert NULL, und die Workloadidentitätsauthentifizierung wird nicht versucht.

Parameters:

clientId - Die Client-ID

Returns:

DefaultAzureCredentialBuilder selbst

Gilt für: