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

public class DefaultAzureCredentialBuilder
extends CredentialBuilderBase<DefaultAzureCredentialBuilder>

Generador de credenciales de Fluent para crear instancias de .DefaultAzureCredential

DefaultAzureCredential es adecuado para la mayoría de los escenarios en los que la aplicación está pensada para ejecutarse en última instancia en Azure. DefaultAzureCredential combina las credenciales que se usan normalmente para autenticarse cuando se implementan, con credenciales que se usan para autenticarse en un entorno de desarrollo. DefaultAzureCredential intentará autenticarse mediante los siguientes mecanismos en orden.

Ejemplo: Construir DefaultAzureCredential

En el ejemplo de código siguiente se muestra la creación de un DefaultAzureCredentialobjeto , mediante DefaultAzureCredentialBuilder para configurarlo. Una vez creada esta credencial, se puede pasar al generador de muchos de los generadores de cliente de Azure SDK para Java como parámetro "credential".

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

Ejemplo: Construir DefaultAzureCredential con la identidad administrada asignada por el usuario

User-Assigned identidad administrada (UAMI) en Azure es una característica que permite crear una identidad en Azure Active Directory (Azure AD) asociada a uno o varios recursos de Azure. Esta identidad se puede usar para autenticar y autorizar el acceso a varios servicios y recursos de Azure. En el ejemplo de código siguiente se muestra la creación de un DefaultAzureCredential objeto para establecer como destino una identidad administrada asignada por el usuario mediante DefaultAzureCredentialBuilder para configurarla. Una vez creada esta credencial, se puede pasar al generador de muchos de los generadores de cliente de Azure SDK para Java como parámetro "credential".

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

Resumen del constructor

Constructor	Description
DefaultAzureCredentialBuilder()	Crea una instancia de un Generador de credencialesde Azurepredeterminado.

Resumen del método

Modificador y tipo	Método y descripción
DefaultAzureCredentialBuilder	additionallyAllowedTenants(String[] additionallyAllowedTenants) Para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens.
DefaultAzureCredentialBuilder	additionallyAllowedTenants(List<String> additionallyAllowedTenants) Para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens.
DefaultAzureCredentialBuilder	authorityHost(String authorityHost) Especifica el punto de conexión de Azure Active Directory para adquirir tokens.
DefaultAzureCredential	build() Crea una nueva DefaultAzureCredential con el conjunto de opciones configuradas.
DefaultAzureCredentialBuilder	credentialProcessTimeout(Duration credentialProcessTimeout) Especifica un Duration tiempo de espera para las credenciales de desarrollador (como la CLI de Azure) que se basan en invocaciones de proceso independientes.
DefaultAzureCredentialBuilder	disableInstanceDiscovery() Deshabilita la configuración que determina si se realiza o no la detección de instancias al intentar autenticarse.
DefaultAzureCredentialBuilder	executorService(ExecutorService executorService) Especifica el servicio Executorque se va a usar para ejecutar las solicitudes de autenticación.
DefaultAzureCredentialBuilder	intelliJKeePassDatabasePath(String databasePath) Especifica la ruta de acceso de la base de datos de KeePass para leer las credenciales almacenadas en caché del kit de herramientas de Azure para el complemento IntelliJ.
DefaultAzureCredentialBuilder	managedIdentityClientId(String clientId) Especifica el identificador de cliente de la identidad asignada por el usuario o asignada por el sistema, cuando esta credencial se ejecuta en un entorno con identidades administradas.
DefaultAzureCredentialBuilder	managedIdentityResourceId(String resourceId) Especifica el identificador de recurso de la identidad asignada por el usuario o asignada por el sistema, cuando esta credencial se ejecuta en un entorno con identidades administradas.
DefaultAzureCredentialBuilder	tenantId(String tenantId) Establece el identificador de inquilino del usuario que se autentica a través de DefaultAzureCredential.
DefaultAzureCredentialBuilder	workloadIdentityClientId(String clientId) Especifica el identificador de cliente de la aplicación de Azure AD que se va a usar para la autenticación de identidad de carga de trabajo de AKS.

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

DefaultAzureCredentialBuilder

public DefaultAzureCredentialBuilder()

Crea una instancia de DefaultAzureCredentialBuilder.

Detalles del método

additionallyAllowedTenants

public DefaultAzureCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens. Agregue el valor comodín "*" para permitir que la credencial adquiera tokens para cualquier inquilino que esté instalada la aplicación.

Parameters:

additionallyAllowedTenants - los inquilinos permitidos además.

Returns:

Instancia actualizada de este generador con el identificador de inquilino establecido como se especifica.

additionallyAllowedTenants

public DefaultAzureCredentialBuilder additionallyAllowedTenants(List additionallyAllowedTenants)

Para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens. Agregue el valor comodín "*" para permitir que la credencial adquiera tokens para cualquier inquilino que esté instalada la aplicación.

Parameters:

additionallyAllowedTenants - los inquilinos permitidos además.

Returns:

Instancia actualizada de este generador con el identificador de inquilino establecido como se especifica.

authorityHost

public DefaultAzureCredentialBuilder authorityHost(String authorityHost)

Especifica el punto de conexión de Azure Active Directory para adquirir tokens.

Parameters:

authorityHost - el punto de conexión de Azure Active Directory

Returns:

Instancia actualizada de este generador con el host de autoridad establecido como se especifica.

build

public DefaultAzureCredential build()

Crea una nueva DefaultAzureCredential con el conjunto de opciones configuradas.

Returns:

con DefaultAzureCredential las configuraciones actuales.

credentialProcessTimeout

public DefaultAzureCredentialBuilder credentialProcessTimeout(Duration credentialProcessTimeout)

Especifica un Duration tiempo de espera para las credenciales de desarrollador (como la CLI de Azure) que se basan en invocaciones de proceso independientes.

Parameters:

credentialProcessTimeout - que Duration se va a esperar.

Returns:

Instancia actualizada de este generador con el tiempo de espera especificado.

disableInstanceDiscovery

public DefaultAzureCredentialBuilder disableInstanceDiscovery()

Deshabilita la configuración que determina si se realiza o no la detección de instancias al intentar autenticarse. Esto deshabilitará completamente la detección de instancias y la validación de autoridad. Esta funcionalidad está pensada para su uso en escenarios en los que no se puede acceder al punto de conexión de metadatos, como en nubes privadas o Azure Stack. El proceso de detección de instancias implica recuperar los metadatos de autoridad de https://login.microsoft.com/ para validar la autoridad. Al usar esta API, la validación de la autoridad está deshabilitada. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y confiable.

Returns:

Una instancia actualizada de este generador con la detección de instancias deshabilitada.

executorService

public DefaultAzureCredentialBuilder executorService(ExecutorService executorService)

Especifica el executorService que se va a usar para ejecutar las solicitudes de autenticación. El desarrollador es responsable de mantener el ciclo de vida de ExecutorService.

Si no está configurado, common fork join pool se usará que también se comparte con otras tareas de la aplicación. Si el grupo común se usa en gran medida para otras tareas, es posible que las solicitudes de autenticación se vea afectado y la configuración de este servicio ejecutor.

El servicio executor y se puede apagar de forma segura si los clientes del SDK de Azure ya no usan TokenCredential y deben apagarse antes de que se cierre la aplicación.

Parameters:

executorService - el servicio executor que se va a usar para ejecutar solicitudes de autenticación.

Returns:

Instancia actualizada de este generador con el servicio executor establecido como se especifica.

intelliJKeePassDatabasePath

public DefaultAzureCredentialBuilder intelliJKeePassDatabasePath(String databasePath)

Especifica la ruta de acceso de la base de datos KeePass para leer las credenciales almacenadas en caché del kit de herramientas de Azure para el complemento IntelliJ. databasePath Es necesario en la plataforma Windows. Para macOS y el anillo de claves nativo de la plataforma Linux, se tendrá acceso al anillo de claves, respectivamente, para recuperar las credenciales almacenadas en caché.

Esta ruta de acceso se puede encontrar en el IDE de IntelliJ. Windows: Archivo - Configuración ->> Comportamiento de apariencia & -> Configuración del sistema -> Contraseñas.

Parameters:

databasePath - ruta de acceso a la base de datos KeePass.

Returns:

Instancia actualizada de este generador con la ruta de acceso de la base de datos KeePass establecida como se especifica.

managedIdentityClientId

public DefaultAzureCredentialBuilder managedIdentityClientId(String clientId)

Especifica el identificador de cliente de la identidad asignada por el usuario o asignada por el sistema, cuando esta credencial se ejecuta en un entorno con identidades administradas. Si no se establece, se usará el valor de la variable de entorno AZURE_CLIENT_ID. Si no se establece ninguno, el valor predeterminado es NULL y solo funcionará con identidades administradas asignadas por el sistema y no con identidades administradas asignadas por el usuario. Solo se puede especificar managedIdentityClientId y managedIdentityResourceId.

Parameters:

clientId - el identificador de cliente

Returns:

El propio DefaultAzureCredentialBuilder

managedIdentityResourceId

public DefaultAzureCredentialBuilder managedIdentityResourceId(String resourceId)

Especifica el identificador de recurso de la identidad asignada por el usuario o asignada por el sistema, cuando esta credencial se ejecuta en un entorno con identidades administradas. Si no se establece, se usará el valor de la variable de entorno AZURE_CLIENT_ID. Si no se establece ninguno, el valor predeterminado es NULL y solo funcionará con identidades administradas asignadas por el sistema y no con identidades administradas asignadas por el usuario. Solo se puede especificar uno de managedIdentityResourceId y managedIdentityClientId.

Parameters:

resourceId - el identificador de recurso

Returns:

El propio DefaultAzureCredentialBuilder

tenantId

public DefaultAzureCredentialBuilder tenantId(String tenantId)

Establece el identificador de inquilino del usuario que se autentica a través de DefaultAzureCredential. Si no se establece, se usará el valor de la variable de entorno AZURE_TENANT_ID. Si no se establece ninguno, el valor predeterminado es NULL y autenticará a los usuarios en su inquilino predeterminado.

Parameters:

tenantId - identificador de inquilino que se va a establecer.

Returns:

Instancia actualizada de este generador con el identificador de inquilino establecido como se especifica.

workloadIdentityClientId

public DefaultAzureCredentialBuilder workloadIdentityClientId(String clientId)

Especifica el identificador de cliente de la aplicación de Azure AD que se va a usar para la autenticación de identidad de carga de trabajo de AKS. si no se establece, managedIdentityClientId(String clientId) se usará. Si ambos valores no se establece, se usará el valor de la variable de entorno AZURE_CLIENT_ID. Si no se establece ninguno, el valor predeterminado es NULL y no se intentará la autenticación de identidad de carga de trabajo.

Parameters:

clientId - el identificador de cliente

Returns:

El propio DefaultAzureCredentialBuilder