DefaultAzureCredentialBuilder Classe

Pacote:

com.azure.identity

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

Construtor de credenciais fluente para instanciar um DefaultAzureCredential.

O DefaultAzureCredential é apropriado para a maioria dos cenários em que o aplicativo se destina a ser executado no Azure. DefaultAzureCredential combina credenciais que são comumente usadas para autenticar quando implantadas, com credenciais usadas para autenticar em um ambiente de desenvolvimento. A DefaultAzureCredential tentará realizar a autenticação usando os mecanismos a seguir na ordem.

Exemplo: Construir DefaultAzureCredential

O exemplo de código a seguir demonstra a criação de um DefaultAzureCredential, usando o DefaultAzureCredentialBuilder para configurá-lo. Depois que essa credencial for criada, ela poderá ser passada para o construtor de muitos dos construtores de clientes do SDK do Azure para Java como o parâmetro "credencial".

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

Exemplo: Construir DefaultAzureCredential com identidade gerenciada atribuída pelo usuário

User-Assigned UAMI (Identidade Gerenciada) no Azure é um recurso que permite criar uma identidade no Azure Active Directory (Azure AD) associada a um ou mais recursos do Azure. Essa identidade pode ser usada para autenticar e autorizar o acesso a vários serviços e recursos do Azure. O exemplo de código a seguir demonstra a criação de um DefaultAzureCredential para direcionar uma identidade gerenciada atribuída pelo usuário, usando DefaultAzureCredentialBuilder para configurá-la. Depois que essa credencial for criada, ela poderá ser passada para o construtor de muitos dos construtores de clientes do SDK do Azure para Java como o parâmetro "credencial".

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

Resumo do Construtor

Construtor	Description
DefaultAzureCredentialBuilder()	Cria uma instância de um Construtor de Credenciais padrãodo Azure.

Resumo do método

Modificador e tipo	Método e descrição
DefaultAzureCredentialBuilder	additionallyAllowedTenants(String[] additionallyAllowedTenants) Para aplicativos multilocatários, especifica locatários adicionais para os quais a credencial pode adquirir tokens.
DefaultAzureCredentialBuilder	additionallyAllowedTenants(List<String> additionallyAllowedTenants) Para aplicativos multilocatários, especifica locatários adicionais para os quais a credencial pode adquirir tokens.
DefaultAzureCredentialBuilder	authorityHost(String authorityHost) Especifica o ponto de extremidade do Azure Active Directory para adquirir tokens.
DefaultAzureCredential	build() Cria novo DefaultAzureCredential com o conjunto de opções configurado.
DefaultAzureCredentialBuilder	credentialProcessTimeout(Duration credentialProcessTimeout) Especifica um Duration tempo limite para credenciais de desenvolvedor (como a CLI do Azure) que dependem de invocações de processo separadas.
DefaultAzureCredentialBuilder	disableInstanceDiscovery() Desabilita a configuração que determina se a descoberta de instância é executada ou não ao tentar se autenticar.
DefaultAzureCredentialBuilder	executorService(ExecutorService executorService) Especifica o Serviço executora ser usado para executar as solicitações de autenticação.
DefaultAzureCredentialBuilder	intelliJKeePassDatabasePath(String databasePath) Especifica o caminho do banco de dados KeePass para ler as credenciais armazenadas em cache do kit de ferramentas do Azure para plug-in IntelliJ.
DefaultAzureCredentialBuilder	managedIdentityClientId(String clientId) Especifica a ID do cliente da identidade atribuída pelo usuário ou pelo sistema quando essa credencial está em execução em um ambiente com identidades gerenciadas.
DefaultAzureCredentialBuilder	managedIdentityResourceId(String resourceId) Especifica a ID de recurso da identidade atribuída pelo usuário ou pelo sistema quando essa credencial está em execução em um ambiente com identidades gerenciadas.
DefaultAzureCredentialBuilder	tenantId(String tenantId) Define a ID de locatário do usuário para autenticar por meio do DefaultAzureCredential.
DefaultAzureCredentialBuilder	workloadIdentityClientId(String clientId) Especifica a ID do cliente de Azure AD aplicativo a ser usado para autenticação de identidade de carga de trabalho do AKS.

Métodos herdados de CredentialBuilderBase

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

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

DefaultAzureCredentialBuilder

public DefaultAzureCredentialBuilder()

Cria uma instância de um DefaultAzureCredentialBuilder.

Detalhes do método

additionallyAllowedTenants

public DefaultAzureCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Para aplicativos multilocatários, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário instalado pelo aplicativo.

Parameters:

additionallyAllowedTenants - os locatários permitidos adicionalmente.

Returns:

Uma instância atualizada desse construtor com a ID do locatário definida conforme especificado.

additionallyAllowedTenants

public DefaultAzureCredentialBuilder additionallyAllowedTenants(List additionallyAllowedTenants)

Para aplicativos multilocatários, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário instalado pelo aplicativo.

Parameters:

additionallyAllowedTenants - os locatários permitidos adicionalmente.

Returns:

Uma instância atualizada desse construtor com a ID do locatário definida conforme especificado.

authorityHost

public DefaultAzureCredentialBuilder authorityHost(String authorityHost)

Especifica o ponto de extremidade do Azure Active Directory para adquirir tokens.

Parameters:

authorityHost - o ponto de extremidade do Azure Active Directory

Returns:

Uma instância atualizada desse construtor com o host de autoridade definido conforme especificado.

build

public DefaultAzureCredential build()

Cria novo DefaultAzureCredential com o conjunto de opções configurado.

Returns:

um DefaultAzureCredential com as configurações atuais.

credentialProcessTimeout

public DefaultAzureCredentialBuilder credentialProcessTimeout(Duration credentialProcessTimeout)

Especifica um Duration tempo limite para credenciais de desenvolvedor (como a CLI do Azure) que dependem de invocações de processo separadas.

Parameters:

credentialProcessTimeout - O Duration para esperar.

Returns:

Uma instância atualizada desse construtor com o tempo limite especificado.

disableInstanceDiscovery

public DefaultAzureCredentialBuilder disableInstanceDiscovery()

Desabilita a configuração que determina se a descoberta de instância é executada ou não ao tentar se autenticar. Isso desabilitará completamente a descoberta de instância e a validação de autoridade. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade. Ao utilizar essa API, a validação da autoridade é desabilitada. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável.

Returns:

Uma instância atualizada desse construtor com a descoberta de instância desabilitada.

executorService

public DefaultAzureCredentialBuilder executorService(ExecutorService executorService)

Especifica o ExecutorService a ser usado para executar as solicitações de autenticação. O desenvolvedor é responsável por manter o ciclo de vida do ExecutorService.

Se isso não estiver configurado, o common fork join pool será usado, que também será compartilhado com outras tarefas do aplicativo. Se o pool comum for fortemente usado para outras tarefas, as solicitações de autenticação poderão morrer de fome e a configuração desse serviço executor deverá ser considerada.

O serviço executor e poderá ser desligado com segurança se o TokenCredential não estiver mais sendo usado pelos clientes do SDK do Azure e deverá ser desligado antes da saída do aplicativo.

Parameters:

executorService - o serviço executor a ser usado para executar solicitações de autenticação.

Returns:

Uma instância atualizada desse construtor com o serviço executor definido conforme especificado.

intelliJKeePassDatabasePath

public DefaultAzureCredentialBuilder intelliJKeePassDatabasePath(String databasePath)

Especifica o caminho do banco de dados KeePass para ler as credenciais armazenadas em cache do kit de ferramentas do Azure para plug-in IntelliJ. O databasePath é necessário na plataforma Windows. Para macOS e linux, a cadeia de chaves/o anel de chave nativo da plataforma Linux será acessada, respectivamente, para recuperar as credenciais armazenadas em cache.

Esse caminho pode estar localizado no IDE do IntelliJ. Windows: Arquivo –> Configurações –> Comportamento da Aparência & –> Configurações do Sistema –> Senhas.

Parameters:

databasePath - o caminho para o banco de dados KeePass.

Returns:

Uma instância atualizada desse construtor com o caminho do banco de dados KeePass definido conforme especificado.

managedIdentityClientId

public DefaultAzureCredentialBuilder managedIdentityClientId(String clientId)

Especifica a ID do cliente da identidade atribuída pelo usuário ou pelo sistema quando essa credencial está em execução em um ambiente com identidades gerenciadas. Se não estiver definido, o valor na variável de ambiente AZURE_CLIENT_ID será usado. Se nenhum dos dois for definido, o valor padrão será nulo e funcionará apenas com identidades gerenciadas atribuídas pelo sistema e não com identidades gerenciadas atribuídas pelo usuário. Somente um de managedIdentityClientId e managedIdentityResourceId pode ser especificado.

Parameters:

clientId - a ID do cliente

Returns:

o defaultAzureCredentialBuilder em si

managedIdentityResourceId

public DefaultAzureCredentialBuilder managedIdentityResourceId(String resourceId)

Especifica a ID do recurso da identidade atribuída pelo usuário ou pelo sistema quando essa credencial está em execução em um ambiente com identidades gerenciadas. Se não estiver definido, o valor na variável de ambiente AZURE_CLIENT_ID será usado. Se nenhum dos dois for definido, o valor padrão será nulo e funcionará apenas com identidades gerenciadas atribuídas pelo sistema e não com identidades gerenciadas atribuídas pelo usuário. Somente um de managedIdentityResourceId e managedIdentityClientId pode ser especificado.

Parameters:

resourceId - a ID do recurso

Returns:

o defaultAzureCredentialBuilder propriamente dito

tenantId

public DefaultAzureCredentialBuilder tenantId(String tenantId)

Define a ID de locatário do usuário para autenticar por meio do DefaultAzureCredential. Se não estiver configurado, o valor na variável de ambiente AZURE_TENANT_ID será usado. Se nenhum for definido, o padrão será nulo e autenticará os usuários em seu locatário padrão.

Parameters:

tenantId - a ID do locatário a ser definida.

Returns:

Uma instância atualizada desse construtor com a ID do locatário definida conforme especificado.

workloadIdentityClientId

public DefaultAzureCredentialBuilder workloadIdentityClientId(String clientId)

Especifica a ID do cliente de Azure AD aplicativo a ser usado para autenticação de identidade de carga de trabalho do AKS. se não estiver em conjunto, managedIdentityClientId(String clientId) será usado. Se ambos os valores não estiverem configurados, o valor na variável de ambiente AZURE_CLIENT_ID será usado. Se nenhum for definido, o valor padrão será nulo e a autenticação de Identidade de Carga de Trabalho não será tentada.

Parameters:

clientId - a ID do cliente

Returns:

o defaultAzureCredentialBuilder propriamente dito