ClientCertificateCredentialBuilder Classe
- java.
lang. Object - com.
azure. identity. CredentialBuilderBase<T> - com.
azure. identity. AadCredentialBuilderBase<T> - com.
azure. identity. ClientCertificateCredentialBuilder
- com.
- com.
- com.
public class ClientCertificateCredentialBuilder
extends AadCredentialBuilderBase<ClientCertificateCredentialBuilder>
Construtor de credenciais fluente para instanciar um ClientCertificateCredential.
O ClientCertificateCredential adquire um token por meio da autenticação da entidade de serviço. É um tipo de autenticação no Azure que permite um logon não interativo no Azure Active Directory (Azure AD), permitindo que um aplicativo ou serviço se autentique com recursos do Azure. Uma Entidade de Serviço é essencialmente uma identidade criada para um aplicativo em Azure AD que pode ser usada para autenticar com recursos do Azure. É como uma "identidade de usuário" para o aplicativo ou serviço e fornece uma maneira de o aplicativo se autenticar com recursos do Azure sem precisar usar as credenciais de um usuário. O Azure Active Directory (Azure AD) permite que os usuários registrem entidades de serviço que podem ser usadas como uma identidade para autenticação. Um certificado de cliente associado à entidade de serviço registrada é usado como a senha ao autenticar a entidade de serviço. O ClientCertificateCredentialBuilder adquire um token de acesso com um certificado de cliente para uma entidade de serviço/aplicativo AAD registrado. A tenantId, clientId e clientCertificate da entidade de serviço são necessárias para que essa credencial adquira um token de acesso. Ele pode ser usado em ambientes de desenvolvimento hospedados no Azure e locais para autenticação. Para obter mais informações, consulte os detalhes conceituais de conhecimento e configuração.
Exemplo: Construir um ClientCertificateCredential simples
O exemplo de código a seguir demonstra a criação de um ClientCertificateCredential, usando o ClientCertificateCredentialBuilder para configurá-lo. Os tenantIdparâmetros , clientId e certificate são necessários para criar ClientCertificateCredential. Depois que essa credencial é criada, ela pode ser passada para o construtor de muitos dos construtores de cliente do SDK do Azure para Java como o parâmetro 'credential'.
TokenCredential clientCertificateCredential = new ClientCertificateCredentialBuilder()
.tenantId(tenantId)
.clientId(clientId)
.pemCertificate("<PATH-TO-PEM-CERTIFICATE>")
.build();
Exemplo: construir um ClientCertificateCredential por trás de um proxy
O exemplo de código a seguir demonstra a criação de um ClientCertificateCredential, usando o ClientCertificateCredentialBuilder para configurá-lo. Os tenantIdparâmetros , clientId e certificate são necessários para criar ClientSecretCredential. Opcionalmente proxyOptions , o pode ser configurado para direcionar um proxy. Depois que essa credencial é criada, ela pode ser passada para o construtor de muitos dos construtores de cliente do SDK do Azure para Java como o parâmetro 'credential'.
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();
Resumo do Construtor
| Construtor | Description | |
|---|---|---|
| ClientCertificateCredentialBuilder() | ||
Resumo do método
| Modificador e tipo | Método e descrição |
|---|---|
|
Client |
build()
Cria um novo ClientCertificateCredential com as configurações atuais. |
|
Client |
pemCertificate(String certificatePath)
Define o caminho do certificado PEM para autenticação no AAD. |
|
Client |
pfxCertificate(String certificatePath, String clientCertificatePassword)
Define o caminho e a senha do certificado PFX para autenticação no AAD. |
|
Client |
sendCertificateChain(boolean sendCertificateChain)
Especifica se a declaração x5c (chave pública do certificado) deve ser enviada como parte da solicitação de autenticação e habilitar o nome da entidade/autenticação baseada no emissor. |
|
Client |
tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)
Configura as opções persistentes de cache de token compartilhado e habilita o cache de token persistente que está desabilitado por padrão. |
Métodos herdados de AadCredentialBuilderBase
Métodos herdados de CredentialBuilderBase
Métodos herdados de java.lang.Object
Detalhes do construtor
ClientCertificateCredentialBuilder
public ClientCertificateCredentialBuilder()
Detalhes do método
build
public ClientCertificateCredential build()
Cria um novo ClientCertificateCredential com as configurações atuais.
Returns:
pemCertificate
public ClientCertificateCredentialBuilder pemCertificate(String certificatePath)
Define o caminho do certificado PEM para autenticação no AAD.
Parameters:
Returns:
pfxCertificate
public ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)
Define o caminho e a senha do certificado PFX para autenticação no AAD.
Parameters:
Returns:
sendCertificateChain
public ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)
Especifica se a declaração x5c (chave pública do certificado) deve ser enviada como parte da solicitação de autenticação e habilitar o nome da entidade/autenticação baseada no emissor. O valor padrão é false.
Parameters:
Returns:
tokenCachePersistenceOptions
public ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)
Configura as opções persistentes de cache de token compartilhado e habilita o cache de token persistente que está desabilitado por padrão. Se configurada, a credencial armazenará tokens em um cache persistido no computador, protegidos para o usuário atual, que podem ser compartilhados por outras credenciais e processos.
Parameters:
Returns: