DefaultAzureCredentialBuilder 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.DefaultAzureCredentialBuilder

public class DefaultAzureCredentialBuilder
extends CredentialBuilderBase<DefaultAzureCredentialBuilder>

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

Convient à la DefaultAzureCredential plupart des scénarios où l’application est destinée à être exécutée dans Azure. DefaultAzureCredential combine les informations d’identification couramment utilisées pour l’authentification lors du déploiement avec les informations d’identification utilisées pour l’authentification dans un environnement de développement. DefaultAzureCredential tente de s’authentifier via les mécanismes suivants dans l’ordre.

Exemple : Construction DefaultAzureCredential

L’exemple de code suivant illustre la création d’un DefaultAzureCredential, à l’aide de DefaultAzureCredentialBuilder pour le configurer. 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 defaultAzureCredential = new DefaultAzureCredentialBuilder()
     .build();

Exemple : Construire DefaultAzureCredential avec une identité managée affectée par l’utilisateur

User-Assigned Identité managée (UAMI) dans Azure est une fonctionnalité qui vous permet de créer une identité dans Azure Active Directory (Azure AD) associée à une ou plusieurs ressources Azure. Cette identité peut ensuite être utilisée pour authentifier et autoriser l’accès à différents services et ressources Azure. L’exemple de code suivant illustre la création d’un DefaultAzureCredential pour cibler une identité managée affectée par l’utilisateur, à l’aide de DefaultAzureCredentialBuilder pour la configurer. 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 dacWithUserAssignedManagedIdentity = new DefaultAzureCredentialBuilder()
     .managedIdentityClientId("<Managed-Identity-Client-Id")
     .build();

Récapitulatif du constructeur

Constructeur	Description
DefaultAzureCredentialBuilder()	Crée un instance d’un générateur d’informations d’identificationAzurepar défaut.

Résumé de la méthode

Modificateur et type	Méthode et description
DefaultAzureCredentialBuilder	additionallyAllowedTenants(String[] additionallyAllowedTenants) Pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons.
DefaultAzureCredentialBuilder	additionallyAllowedTenants(List<String> additionallyAllowedTenants) Pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons.
DefaultAzureCredentialBuilder	authorityHost(String authorityHost) Spécifie le point de terminaison Azure Active Directory à acquérir des jetons.
DefaultAzureCredential	build() Crée avec DefaultAzureCredential les options configurées définies.
DefaultAzureCredentialBuilder	credentialProcessTimeout(Duration credentialProcessTimeout) Spécifie un délai d’expiration Duration pour les informations d’identification du développeur (telles qu’Azure CLI) qui reposent sur des appels de processus distincts.
DefaultAzureCredentialBuilder	disableInstanceDiscovery() Désactive le paramètre qui détermine si instance détection est effectuée lors de la tentative d’authentification.
DefaultAzureCredentialBuilder	executorService(ExecutorService executorService) Spécifie le service exécuteurà utiliser pour exécuter les demandes d’authentification.
DefaultAzureCredentialBuilder	intelliJKeePassDatabasePath(String databasePath) Spécifie le chemin de base de données KeePass pour lire les informations d’identification mises en cache du kit de ressources Azure pour le plug-in IntelliJ.
DefaultAzureCredentialBuilder	managedIdentityClientId(String clientId) Spécifie l’ID client de l’identité affectée par l’utilisateur ou affectée par le système, lorsque ces informations d’identification s’exécutent dans un environnement avec des identités managées.
DefaultAzureCredentialBuilder	managedIdentityResourceId(String resourceId) Spécifie l’ID de ressource de l’identité affectée par l’utilisateur ou par le système, lorsque ces informations d’identification s’exécutent dans un environnement avec des identités managées.
DefaultAzureCredentialBuilder	tenantId(String tenantId) Définit l’ID de locataire de l’utilisateur pour l’authentification via le DefaultAzureCredential.
DefaultAzureCredentialBuilder	workloadIdentityClientId(String clientId) Spécifie l’ID client de l’application Azure AD à utiliser pour l’authentification de l’identité de charge de travail AKS.

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

DefaultAzureCredentialBuilder

public DefaultAzureCredentialBuilder()

Crée un instance d’un DefaultAzureCredentialBuilder.

Détails de la méthode

additionallyAllowedTenants

public DefaultAzureCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons. Ajoutez la valeur générique « * » pour permettre aux informations d’identification d’acquérir des jetons pour n’importe quel locataire que l’application est installée.

Parameters:

additionallyAllowedTenants - les locataires autorisés en outre.

Returns:

Une instance mise à jour de ce générateur avec l’ID de locataire défini comme spécifié.

additionallyAllowedTenants

public DefaultAzureCredentialBuilder additionallyAllowedTenants(List additionallyAllowedTenants)

Pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons. Ajoutez la valeur générique « * » pour permettre aux informations d’identification d’acquérir des jetons pour n’importe quel locataire que l’application est installée.

Parameters:

additionallyAllowedTenants - les locataires autorisés en outre.

Returns:

Une instance mise à jour de ce générateur avec l’ID de locataire défini comme spécifié.

authorityHost

public DefaultAzureCredentialBuilder authorityHost(String authorityHost)

Spécifie le point de terminaison Azure Active Directory à acquérir des jetons.

Parameters:

authorityHost - point de terminaison Azure Active Directory

Returns:

Une instance mise à jour de ce générateur avec l’hôte d’autorité défini comme spécifié.

build

public DefaultAzureCredential build()

Crée avec DefaultAzureCredential les options configurées définies.

Returns:

avec DefaultAzureCredential les configurations actuelles.

credentialProcessTimeout

public DefaultAzureCredentialBuilder credentialProcessTimeout(Duration credentialProcessTimeout)

Spécifie un délai d’expiration Duration pour les informations d’identification du développeur (telles qu’Azure CLI) qui reposent sur des appels de processus distincts.

Parameters:

credentialProcessTimeout - à Duration attendre.

Returns:

Une instance mise à jour de ce générateur avec le délai d’expiration spécifié.

disableInstanceDiscovery

public DefaultAzureCredentialBuilder disableInstanceDiscovery()

Désactive le paramètre qui détermine si instance détection est effectuée lors de la tentative d’authentification. Cela désactive complètement la découverte instance et la validation de l’autorité. Cette fonctionnalité est destinée à être utilisée dans les scénarios où le point de terminaison de métadonnées n’est pas accessible, par exemple dans des clouds privés ou Azure Stack. Le processus de découverte instance implique la récupération des métadonnées d’autorité à partir de https://login.microsoft.com/ pour valider l’autorité. En utilisant cette API, la validation de l’autorité est désactivée. Par conséquent, il est essentiel de s’assurer que l’hôte d’autorité configuré est valide et digne de confiance.

Returns:

Une instance mise à jour de ce générateur avec instance détection désactivée.

executorService

public DefaultAzureCredentialBuilder executorService(ExecutorService executorService)

Spécifie l’ExecutorService à utiliser pour exécuter les demandes d’authentification. Le développeur est responsable de la maintenance du cycle de vie de l’ExecutorService.

Si ce n’est pas configuré, le common fork join pool est utilisé, qui est également partagé avec d’autres tâches d’application. Si le pool commun est fortement utilisé pour d’autres tâches, les demandes d’authentification peuvent être affamées et la configuration de ce service d’exécuteur doit être envisagée.

Le service exécuteur et peut être arrêté en toute sécurité si TokenCredential n’est plus utilisé par les clients du KIT de développement logiciel (SDK) Azure et doit être arrêté avant la fermeture de l’application.

Parameters:

executorService - service exécuteur à utiliser pour exécuter des demandes d’authentification.

Returns:

Une instance mise à jour de ce générateur avec le service de l’exécuteur défini comme spécifié.

intelliJKeePassDatabasePath

public DefaultAzureCredentialBuilder intelliJKeePassDatabasePath(String databasePath)

Spécifie le chemin de la base de données KeePass pour lire les informations d’identification mises en cache du plug-in Azure Toolkit pour IntelliJ. est databasePath obligatoire sur la plateforme Windows. Pour macOS et la plateforme Linux, la chaîne de clés/l’anneau de clés natifs sont accessibles respectivement pour récupérer les informations d’identification mises en cache.

Ce chemin d’accès peut se trouver dans l’IDE IntelliJ. Windows : Fichier -> Paramètres - Comportement de l’apparence>& -> Paramètres système -> Mots de passe.

Parameters:

databasePath - chemin d’accès à la base de données KeePass.

Returns:

Mise à jour instance de ce générateur avec le chemin de base de données KeePass défini comme spécifié.

managedIdentityClientId

public DefaultAzureCredentialBuilder managedIdentityClientId(String clientId)

Spécifie l’ID client de l’identité affectée par l’utilisateur ou affectée par le système, lorsque ces informations d’identification s’exécutent dans un environnement avec des identités managées. Si elle n’est pas définie, la valeur dans la variable d’environnement AZURE_CLIENT_ID est utilisée. Si aucun des deux n’est défini, la valeur par défaut est null et fonctionne uniquement avec les identités managées affectées par le système et non avec les identités managées affectées par l’utilisateur. Une seule des valeurs managedIdentityClientId et managedIdentityResourceId peut être spécifiée.

Parameters:

clientId - l’ID client

Returns:

DefaultAzureCredentialBuilder lui-même

managedIdentityResourceId

public DefaultAzureCredentialBuilder managedIdentityResourceId(String resourceId)

Spécifie l’ID de ressource de l’identité affectée par l’utilisateur ou par le système, lorsque ces informations d’identification s’exécutent dans un environnement avec des identités managées. Si elle n’est pas définie, la valeur dans la variable d’environnement AZURE_CLIENT_ID est utilisée. Si aucun des deux n’est défini, la valeur par défaut est null et fonctionne uniquement avec les identités managées affectées par le système et non avec les identités managées affectées par l’utilisateur. Une seule des valeurs managedIdentityResourceId et managedIdentityClientId peut être spécifiée.

Parameters:

resourceId - l’ID de ressource

Returns:

DefaultAzureCredentialBuilder lui-même

tenantId

public DefaultAzureCredentialBuilder tenantId(String tenantId)

Définit l’ID de locataire de l’utilisateur pour l’authentification via le DefaultAzureCredential. Si elle n’est pas définie, la valeur dans la variable d’environnement AZURE_TENANT_ID est utilisée. Si aucun des deux n’est défini, la valeur par défaut est Null et authentifie les utilisateurs auprès de leur locataire par défaut.

Parameters:

tenantId - ID de locataire à définir.

Returns:

Une instance mise à jour de ce générateur avec l’ID de locataire défini comme spécifié.

workloadIdentityClientId

public DefaultAzureCredentialBuilder workloadIdentityClientId(String clientId)

Spécifie l’ID client de l’application Azure AD à utiliser pour l’authentification de l’identité de charge de travail AKS. si elle n’est pas définie, managedIdentityClientId(String clientId) est utilisée. Si les deux valeurs ne sont pas définies, la valeur dans la variable d’environnement AZURE_CLIENT_ID est utilisée. Si aucune n’est définie, la valeur par défaut est null et l’authentification de l’identité de charge de travail ne sera pas tentée.

Parameters:

clientId - l’ID client

Returns:

DefaultAzureCredentialBuilder lui-même