KeyClientBuilder Classe

Pacote:

com.azure.security.keyvault.keys

Artefato Maven:

com.azure:azure-security-keyvault-keys:4.7.3

• java.lang.Object
• • com.azure.security.keyvault.keys.KeyClientBuilder

Implementações

ConfigurationTrait<KeyClientBuilder> HttpTrait<KeyClientBuilder> TokenCredentialTrait<KeyClientBuilder>

public final class KeyClientBuilder
implements TokenCredentialTrait<KeyClientBuilder>, HttpTrait<KeyClientBuilder>, ConfigurationTrait<KeyClientBuilder>

Essa classe fornece uma API de construtor fluente para ajudar a ajudar na configuração e na instanciação do KeyAsyncClient e KeyClientdo , chamando buildAsyncClient() e buildClient() , respectivamente. Ele constrói uma instância do cliente desejado.

As opções de configuração mínimas necessárias KeyClientBuilder para compilar KeyAsyncClient são vaultUrl e TokenCredential.

KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
     .vaultUrl("<your-key-vault-url>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();

O log detail level, vários personalizados policies e personalizados HttpClient podem ser configurados opcionalmente no KeyClientBuilder.

KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
     .vaultUrl("<your-key-vault-url>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .httpClient(HttpClient.createDefault())
     .buildAsyncClient();

As opções de configuração mínimas necessárias KeyClientBuilder para compilar KeyClient são vaultUrl e TokenCredential.

KeyClient keyClient = new KeyClientBuilder()
     .vaultUrl("<your-key-vault-url>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();

Resumo do Construtor

Construtor	Description
KeyClientBuilder()	O construtor com padrões.

Resumo do método

Modificador e tipo	Método e descrição
KeyClientBuilder	addPolicy(HttpPipelinePolicy policy) Adiciona um HttpPipelinePolicy a ser aplicado em cada solicitação enviada.
KeyAsyncClient	buildAsyncClient() Cria um KeyAsyncClient com base nas opções definidas no construtor.
KeyClient	buildClient() Cria um KeyClient com base nas opções definidas no construtor.
KeyClientBuilder	clientOptions(ClientOptions clientOptions) Permite definir propriedades comuns, como ID do aplicativo, cabeçalhos, configuração de proxy etc.
KeyClientBuilder	configuration(Configuration configuration) Define o repositório de configuração usado durante a construção do cliente de serviço.
KeyClientBuilder	credential(TokenCredential credential) Define o TokenCredential usado para autorizar solicitações enviadas ao serviço.
KeyClientBuilder	disableChallengeResourceVerification() Desabilita a verificação se o recurso de desafio de autenticação corresponde ao Key Vault ou ao domínio HSM Gerenciado.
KeyClientBuilder	httpClient(HttpClient client) Define o HttpClient a ser usado para enviar e receber solicitações de e para o serviço.
KeyClientBuilder	httpLogOptions(HttpLogOptions logOptions) Define o HttpLogOptions a ser usado ao enviar e receber solicitações de e para o serviço.
KeyClientBuilder	pipeline(HttpPipeline pipeline) Define o HttpPipeline a ser usado para o cliente de serviço.
KeyClientBuilder	retryOptions(RetryOptions retryOptions) Define o RetryOptions para todas as solicitações feitas por meio do cliente.
KeyClientBuilder	retryPolicy(RetryPolicy retryPolicy) Define o RetryPolicy que é usado quando cada solicitação é enviada.
KeyClientBuilder	serviceVersion(KeyServiceVersion version) Define o KeyServiceVersion que é usado ao fazer solicitações de API.
KeyClientBuilder	vaultUrl(String vaultUrl) Define a URL do ponto de extremidade do cofre para o qual enviar solicitações HTTP.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

KeyClientBuilder

public KeyClientBuilder()

O construtor com padrões.

Detalhes do método

addPolicy

public KeyClientBuilder addPolicy(HttpPipelinePolicy policy)

Adiciona um HttpPipelinePolicy a ser aplicado em cada solicitação enviada.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Parameters:

policy - Uma HttpPipelinePolicy.

Returns:

O objeto atualizado KeyClientBuilder.

buildAsyncClient

public KeyAsyncClient buildAsyncClient()

Cria um KeyAsyncClient com base nas opções definidas no construtor. Sempre que buildAsyncClient() é chamado, uma nova instância de KeyAsyncClient é criada.

Se pipeline(HttpPipeline pipeline) estiver definido, o pipeline e vaultUrl(String vaultUrl) serão usados para criar o KeyClientBuilder. Todas as outras configurações do construtor são ignoradas. Se pipeline não estiver definido, credential(TokenCredential credential) e a vaultUrl(String vaultUrl) URL do cofre de chaves serão necessárias para compilar o KeyAsyncClient.

Returns:

Um KeyAsyncClient com as opções definidas do construtor.

buildClient

public KeyClient buildClient()

Cria um KeyClient com base nas opções definidas no construtor. Sempre que buildClient() é chamado, uma nova instância de KeyClient é criada.

Se pipeline(HttpPipeline pipeline) estiver definido, o pipeline e vaultUrl(String vaultUrl) serão usados para criar o KeyClientBuilder. Todas as outras configurações do construtor são ignoradas. Se pipeline não estiver definido, e credential(TokenCredential credential)vaultUrl(String vaultUrl) serão necessários para compilar o KeyClient.

Returns:

Um KeyClient com as opções definidas do construtor.

clientOptions

public KeyClientBuilder clientOptions(ClientOptions clientOptions)

Permite definir propriedades comuns, como ID do aplicativo, cabeçalhos, configuração de proxy etc. Observe que é recomendável que esse método seja chamado com uma instância da HttpClientOptions classe (uma subclasse da ClientOptions classe base). A subclasse HttpClientOptions fornece mais opções de configuração adequadas para clientes HTTP, que é aplicável a qualquer classe que implemente essa interface HttpTrait.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Parameters:

clientOptions - Uma instância configurada de HttpClientOptions.

Returns:

O objeto atualizado KeyClientBuilder.

configuration

public KeyClientBuilder configuration(Configuration configuration)

Define o repositório de configuração usado durante a construção do cliente de serviço. O repositório de configuração padrão é um clone do global configuration store, usado NONE para ignorar o uso das configurações durante a construção.

Parameters:

configuration - O repositório de configuração usado para obter detalhes de configuração.

Returns:

O objeto atualizado KeyClientBuilder.

credential

public KeyClientBuilder credential(TokenCredential credential)

Define o TokenCredential usado para autorizar solicitações enviadas ao serviço. Consulte a documentação de identidade e autenticação do SDK do Azure para Java para obter mais detalhes sobre o uso adequado do TokenCredential tipo.

Parameters:

credential - TokenCredential usado para autorizar solicitações enviadas ao serviço.

Returns:

O objeto atualizado KeyClientBuilder.

disableChallengeResourceVerification

public KeyClientBuilder disableChallengeResourceVerification()

Desabilita a verificação se o recurso de desafio de autenticação corresponde ao Key Vault ou ao domínio HSM Gerenciado. Essa verificação é executada por padrão.

Returns:

O objeto atualizado KeyClientBuilder.

httpClient

public KeyClientBuilder httpClient(HttpClient client)

Define o HttpClient a ser usado para enviar e receber solicitações de e para o serviço.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Parameters:

client - O HttpClient a ser usado para solicitações.

Returns:

O objeto atualizado KeyClientBuilder.

httpLogOptions

public KeyClientBuilder httpLogOptions(HttpLogOptions logOptions)

Define o HttpLogOptions a ser usado ao enviar e receber solicitações de e para o serviço. Se um logLevel não for fornecido, o valor padrão de HttpLogDetailLevel#NONE será definido.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se nenhum HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também serão ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Parameters:

logOptions - O HttpLogOptions a ser usado ao enviar e receber solicitações de e para o serviço.

Returns:

O objeto atualizado KeyClientBuilder.

pipeline

public KeyClientBuilder pipeline(HttpPipeline pipeline)

Define o HttpPipeline a ser usado para o cliente de serviço.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se nenhum HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também serão ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

O vaultUrl(String vaultUrl) não é ignorado quando pipeline é definido.

Parameters:

pipeline - HttpPipeline a ser usado para enviar solicitações de serviço e receber respostas.

Returns:

O objeto atualizado KeyClientBuilder.

retryOptions

public KeyClientBuilder retryOptions(RetryOptions retryOptions)

Define o RetryOptions para todas as solicitações feitas por meio do cliente.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se nenhum HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também serão ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Definir isso é mutuamente exclusivo com o uso de retryPolicy(RetryPolicy retryPolicy).

Parameters:

retryOptions - O RetryOptions a ser usado para todas as solicitações feitas por meio do cliente.

Returns:

O objeto atualizado KeyClientBuilder.

retryPolicy

public KeyClientBuilder retryPolicy(RetryPolicy retryPolicy)

Define o RetryPolicy que é usado quando cada solicitação é enviada. A política de repetição padrão será usada no pipeline, se não for fornecida. Definir isso é mutuamente exclusivo com o uso de retryOptions(RetryOptions retryOptions).

Parameters:

retryPolicy - política de repetição do usuário aplicada a cada solicitação.

Returns:

O objeto atualizado KeyClientBuilder.

serviceVersion

public KeyClientBuilder serviceVersion(KeyServiceVersion version)

Define o KeyServiceVersion que é usado ao fazer solicitações de API.

Se uma versão de serviço não for fornecida, a versão do serviço que será usada será a versão de serviço conhecida mais recente com base na versão da biblioteca de clientes que está sendo usada. Se nenhuma versão de serviço for especificada, a atualização para uma versão mais recente da biblioteca de clientes terá o resultado da possível mudança para uma versão de serviço mais recente.

Parameters:

version - KeyServiceVersion do serviço a ser usado ao fazer solicitações.

Returns:

O objeto atualizado KeyClientBuilder.

vaultUrl

public KeyClientBuilder vaultUrl(String vaultUrl)

Define a URL do ponto de extremidade do cofre para o qual enviar solicitações HTTP. Você deve validar se essa URL faz referência a um recurso de Key Vault ou HSM Gerenciado válido. Consulte a documentação a seguir para obter detalhes.

Parameters:

vaultUrl - A URL do cofre é usada como destino no Azure para o qual enviar solicitações. Se você tiver um identificador de chave, crie um novo KeyVaultKeyIdentifier para analisá-lo e obter o vaultUrl e outras informações.

Returns:

O objeto atualizado KeyClientBuilder.