SecretClient Classe

Referência

Pacote:: com.azure.security.keyvault.secrets

Artefato Maven:: com.azure:azure-security-keyvault-secrets:4.8.3

java.lang.Object
- com.azure.security.keyvault.secrets.SecretClient

public final class SecretClient

O SecretClient fornece métodos síncronos para gerenciar KeyVaultSecret no Key Vault do Azure. O cliente dá suporte à criação, recuperação, atualização, exclusão, limpeza, backup, restauração e listagem do KeyVaultSecret. O cliente também dá suporte à listagem DeletedSecret para um cofre de chaves habilitado para exclusão reversível.

Introdução

Para interagir com o serviço de Key Vault do Azure, você precisará criar uma instância da SecretClient classe, uma URL do cofre e um objeto de credencial.

Os exemplos mostrados neste documento usam um objeto de credencial chamado DefaultAzureCredential para autenticação, que é apropriado para a maioria dos cenários, incluindo ambientes locais de desenvolvimento e produção. Além disso, recomendamos usar uma identidade gerenciada para autenticação em ambientes de produção. Você pode encontrar mais informações sobre diferentes maneiras de autenticação e seus tipos de credencial correspondentes na documentação da Identidade do Azure".

Exemplo: construir um cliente de segredo síncrono

SecretClient secretClient = new SecretClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("<your-key-vault-url>")
     .buildClient();

Criar um segredo

O SecretClient pode ser usado para criar um segredo no cofre de chaves.

Exemplo de código:

O exemplo de código a seguir demonstra como criar e armazenar de forma síncrona um segredo no cofre de chaves usando a setSecret(String name, String value) API.

KeyVaultSecret secret = secretClient.setSecret("secretName", "secretValue");
 System.out.printf("Secret is created with name %s and value %s%n", secret.getName(), secret.getValue());

Nota: Para o exemplo assíncrono, consulte SecretAsyncClient.

Obter um segredo

O SecretClient pode ser usado para recuperar um segredo do cofre de chaves.

Exemplo de código:

O exemplo de código a seguir demonstra como recuperar de forma síncrona um segredo armazenado anteriormente do Azure KeyVault usando a getSecret(String name) API.

KeyVaultSecret secret = secretClient.getSecret("secretName");
 System.out.printf("Secret is returned with name %s and value %s%n",
     secret.getName(), secret.getValue());

Nota: Para o exemplo assíncrono, consulte SecretAsyncClient.

Excluir um segredo

O SecretClient pode ser usado para excluir um segredo do cofre de chaves.

Exemplo de código:

O exemplo de código a seguir demonstra como excluir um segredo do cofre de chaves usando a beginDeleteSecret(String name) API.

SyncPoller<DeletedSecret, Void> deleteSecretPoller = secretClient.beginDeleteSecret("secretName");

 // Deleted Secret is accessible as soon as polling begins.
 PollResponse<DeletedSecret> deleteSecretPollResponse = deleteSecretPoller.poll();

 // Deletion date only works for a SoftDelete-enabled Key Vault.
 System.out.println("Deleted Date  %s" + deleteSecretPollResponse.getValue()
     .getDeletedOn().toString());
 System.out.printf("Deleted Secret's Recovery Id %s", deleteSecretPollResponse.getValue()
     .getRecoveryId());

 // Secret is being deleted on server.
 deleteSecretPoller.waitForCompletion();

Nota: Para o exemplo assíncrono, consulte SecretAsyncClient.

Resumo do método

Modificador e tipo	Método e descrição
byte[]	backupSecret(String name) Solicita que um backup do segredo seja baixado para o cliente.
Response<byte[]>	backupSecretWithResponse(String name, Context context) Solicita que um backup do segredo seja baixado para o cliente.
SyncPoller<DeletedSecret,Void>	beginDeleteSecret(String name) Exclui um segredo do cofre de chaves.
SyncPoller<KeyVaultSecret,Void>	beginRecoverDeletedSecret(String name) Recupera o segredo excluído no cofre de chaves para sua versão mais recente.
DeletedSecret	getDeletedSecret(String name) Obtém um segredo que foi excluído para um cofre de chaves habilitado para exclusão reversível.
Response<DeletedSecret>	getDeletedSecretWithResponse(String name, Context context) Obtém um segredo que foi excluído para um cofre de chaves habilitado para exclusão reversível.
KeyVaultSecret	getSecret(String name) Obtém a versão mais recente do segredo especificado do cofre de chaves.
KeyVaultSecret	getSecret(String name, String version) Obtém o segredo especificado com a versão especificada do cofre de chaves.
Response<KeyVaultSecret>	getSecretWithResponse(String name, String version, Context context) Obtém o segredo especificado com a versão especificada do cofre de chaves.
String	getVaultUrl() Obtém a URL do ponto de extremidade do cofre para a qual as solicitações de serviço são enviadas.
PagedIterable<DeletedSecret>	listDeletedSecrets() Listas DeletedSecret do cofre de chaves se ele tiver habilitado a exclusão reversível.
PagedIterable<DeletedSecret>	listDeletedSecrets(Context context) Listas DeletedSecret do cofre de chaves se ele tiver habilitado a exclusão reversível.
PagedIterable<SecretProperties>	listPropertiesOfSecretVersions(String name) Lista todas as versões do segredo especificado.
PagedIterable<SecretProperties>	listPropertiesOfSecretVersions(String name, Context context) Lista todas as versões do segredo especificado.
PagedIterable<SecretProperties>	listPropertiesOfSecrets() Lista segredos no cofre de chaves.
PagedIterable<SecretProperties>	listPropertiesOfSecrets(Context context) Lista segredos no cofre de chaves.
void	purgeDeletedSecret(String name) Remove permanentemente um segredo excluído, sem a possibilidade de recuperação.
Response<Void>	purgeDeletedSecretWithResponse(String name, Context context) Remove permanentemente um segredo excluído, sem a possibilidade de recuperação.
KeyVaultSecret	restoreSecretBackup(byte[] backup) Restaura um segredo de backup e todas as suas versões em um cofre.
Response<KeyVaultSecret>	restoreSecretBackupWithResponse(byte[] backup, Context context) Restaura um segredo de backup e todas as suas versões em um cofre.
KeyVaultSecret	setSecret(KeyVaultSecret secret) Adiciona um segredo ao cofre de chaves se ele não existir.
KeyVaultSecret	setSecret(String name, String value) Adiciona um segredo ao cofre de chaves se ele não existir.
Response<KeyVaultSecret>	setSecretWithResponse(KeyVaultSecret secret, Context context) Adiciona um segredo ao cofre de chaves se ele não existir.
SecretProperties	updateSecretProperties(SecretProperties secretProperties) Atualizações os atributos associados ao segredo.
Response<SecretProperties>	updateSecretPropertiesWithResponse(SecretProperties secretProperties, Context context) Atualizações os atributos associados ao segredo.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

backupSecret

public byte[] backupSecret(String name)

Solicita que um backup do segredo seja baixado para o cliente. Todas as versões do segredo serão baixadas. Essa operação requer a secrets/backup permissão.

Exemplo de código

Faz backup do segredo do cofre de chaves e imprime o comprimento da matriz de bytes de backup do segredo retornada na resposta

byte[] secretBackup = secretClient.backupSecret("secretName");
 System.out.printf("Secret's Backup Byte array's length %s", secretBackup.length);

Parameters:

name - O nome do segredo.

Returns:

Um Response<T> cujo value contém o blob de segredo de backup.

backupSecretWithResponse

public Response backupSecretWithResponse(String name, Context context)

Solicita que um backup do segredo seja baixado para o cliente. Todas as versões do segredo serão baixadas. Essa operação requer a secrets/backup permissão.

Exemplo de código

Faz backup do segredo do cofre de chaves e imprime o comprimento da matriz de bytes de backup do segredo retornada na resposta

byte[] secretBackup = secretClient.backupSecretWithResponse("secretName",
     new Context(key1, value1)).getValue();
 System.out.printf("Secret's Backup Byte array's length %s", secretBackup.length);

Parameters:

name - O nome do segredo.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o blob de segredo de backup.

beginDeleteSecret

public SyncPoller beginDeleteSecret(String name)

Exclui um segredo do cofre de chaves. Se a exclusão reversível estiver habilitada no cofre de chaves, o segredo será colocado no estado excluído e, para exclusão permanente, precisará ser limpo. Caso contrário, o segredo será excluído permanentemente. Todas as versões de um segredo são excluídas. Isso não pode ser aplicado a versões individuais de um segredo. Essa operação requer a secrets/delete permissão.

Exemplo de código

Exclui o segredo de um cofre de chaves habilitado para exclusão reversível. ID de recuperação do segredo excluído retornado na resposta.

SyncPoller<DeletedSecret, Void> deleteSecretPoller = secretClient.beginDeleteSecret("secretName");

 // Deleted Secret is accessible as soon as polling begins.
 PollResponse<DeletedSecret> deleteSecretPollResponse = deleteSecretPoller.poll();

 // Deletion date only works for a SoftDelete-enabled Key Vault.
 System.out.println("Deleted Date  %s" + deleteSecretPollResponse.getValue()
     .getDeletedOn().toString());
 System.out.printf("Deleted Secret's Recovery Id %s", deleteSecretPollResponse.getValue()
     .getRecoveryId());

 // Secret is being deleted on server.
 deleteSecretPoller.waitForCompletion();

Parameters:

name - O nome do segredo a ser excluído.

Returns:

Um SyncPoller<T,U> para sondar e recuperar o DeletedSecret.

beginRecoverDeletedSecret

public SyncPoller beginRecoverDeletedSecret(String name)

Recupera o segredo excluído no cofre de chaves para sua versão mais recente. Só pode ser executado em um cofre habilitado para exclusão reversível . Essa operação requer a secrets/recover permissão .

Exemplo de código

Recupera o segredo excluído do cofre de chaves habilitado para exclusão reversível. Imprime os detalhes do segredo recuperado retornado na resposta.

SyncPoller<KeyVaultSecret, Void> recoverSecretPoller =
     secretClient.beginRecoverDeletedSecret("deletedSecretName");

 // Deleted Secret can be accessed as soon as polling is in progress.
 PollResponse<KeyVaultSecret> recoveredSecretPollResponse = recoverSecretPoller.poll();
 System.out.println("Recovered Key Name %s" + recoveredSecretPollResponse.getValue().getName());
 System.out.printf("Recovered Key's Id %s", recoveredSecretPollResponse.getValue().getId());

 // Key is being recovered on server.
 recoverSecretPoller.waitForCompletion();

Parameters:

name - O nome do segredo excluído a ser recuperado.

Returns:

Um SyncPoller<T,U> para sondar e recuperar o KeyVaultSecret.

getDeletedSecret

public DeletedSecret getDeletedSecret(String name)

Obtém um segredo que foi excluído para um cofre de chaves habilitado para exclusão reversível. Essa operação requer a secrets/list permissão .

Exemplo de código

Obtém o segredo excluído do cofre de chaves habilitado para exclusão reversível. Imprime os detalhes do segredo excluído retornado na resposta.

DeletedSecret deletedSecret = secretClient.getDeletedSecret("secretName");
 System.out.printf("Deleted Secret's Recovery Id %s", deletedSecret.getRecoveryId());

Parameters:

name - O nome do segredo excluído.

Returns:

O DeletedSecret.

getDeletedSecretWithResponse

public Response getDeletedSecretWithResponse(String name, Context context)

Obtém um segredo que foi excluído para um cofre de chaves habilitado para exclusão reversível. Essa operação requer a secrets/list permissão .

Exemplo de código

Obtém o segredo excluído do cofre de chaves habilitado para exclusão reversível. Imprime os detalhes do segredo excluído retornado na resposta.

DeletedSecret deletedSecret = secretClient.getDeletedSecretWithResponse("secretName",
     new Context(key2, value2)).getValue();
 System.out.printf("Deleted Secret's Recovery Id %s", deletedSecret.getRecoveryId());

Parameters:

name - O nome do segredo excluído.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o deleted secret.

getSecret

public KeyVaultSecret getSecret(String name)

Obtém a versão mais recente do segredo especificado do cofre de chaves. Essa operação requer a secrets/get permissão .

Exemplo de código

Obtém a versão mais recente do segredo no cofre de chaves. Imprime os detalhes do segredo retornado.

KeyVaultSecret secret = secretClient.getSecret("secretName");
 System.out.printf("Secret is returned with name %s and value %s%n",
     secret.getName(), secret.getValue());

Parameters:

name - O nome do segredo.

Returns:

O KeyVaultSecret solicitado.

getSecret

public KeyVaultSecret getSecret(String name, String version)

Obtém o segredo especificado com a versão especificada do cofre de chaves. Essa operação requer a secrets/get permissão .

Exemplo de código

Obtém uma versão específica do segredo no cofre de chaves. Imprime os detalhes do segredo retornado.

String secretVersion = "6A385B124DEF4096AF1361A85B16C204";
 KeyVaultSecret secretWithVersion = secretClient.getSecret("secretName", secretVersion);
 System.out.printf("Secret is returned with name %s and value %s%n",
     secretWithVersion.getName(), secretWithVersion.getValue());

Parameters:

name - O nome do segredo não pode ser nulo.

version - A versão do segredo a ser recuperada. Se essa for uma cadeia de caracteres vazia ou nula, essa chamada será equivalente a chamar getSecret(String name), com a versão mais recente sendo recuperada.

Returns:

O KeyVaultSecret solicitado.

getSecretWithResponse

public Response getSecretWithResponse(String name, String version, Context context)

Obtém o segredo especificado com a versão especificada do cofre de chaves. Essa operação requer a secrets/get permissão .

Exemplo de código

Obtém uma versão específica do segredo no cofre de chaves. Imprime os detalhes do segredo retornado.

String secretVersion = "6A385B124DEF4096AF1361A85B16C204";
 KeyVaultSecret secretWithVersion = secretClient.getSecretWithResponse("secretName", secretVersion,
     new Context(key2, value2)).getValue();
 System.out.printf("Secret is returned with name %s and value %s%n",
     secretWithVersion.getName(), secretWithVersion.getValue());

Parameters:

name - O nome do segredo não pode ser nulo

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o solicitado KeyVaultSecret.

getVaultUrl

public String getVaultUrl()

Obtém a URL do ponto de extremidade do cofre para a qual as solicitações de serviço são enviadas.

Returns:

a URL do ponto de extremidade do cofre.

listDeletedSecrets

public PagedIterable listDeletedSecrets()

Listas DeletedSecret do cofre de chaves se ele tiver habilitado a exclusão reversível. Essa operação requer a secrets/list permissão .

Iterar sobre segredos

Lista os segredos excluídos no cofre de chaves e para cada segredo excluído imprime sua ID de recuperação.

for (DeletedSecret deletedSecret : secretClient.listDeletedSecrets()) {
     System.out.printf("Deleted secret's recovery Id %s", deletedSecret.getRecoveryId());
 }

Iterar sobre segredos por página

Iterar em Lista os segredos excluídos por página no cofre de chaves e para cada segredo excluído imprime sua ID de recuperação.

secretClient.listDeletedSecrets().iterableByPage().forEach(resp -> {
     System.out.printf("Got response headers . Url: %s, Status code: %d %n",
         resp.getRequest().getUrl(), resp.getStatusCode());
     resp.getItems().forEach(value -> {
         System.out.printf("Deleted secret's recovery Id %s", value.getRecoveryId());
     });
 });

Returns:

PagedIterable<T> de todos os DeletedSecret no cofre.

listDeletedSecrets

public PagedIterable listDeletedSecrets(Context context)

Listas DeletedSecret do cofre de chaves se ele tiver habilitado a exclusão reversível. Essa operação requer a secrets/list permissão .

Exemplo de código

Lista os segredos excluídos no cofre de chaves e para cada segredo excluído imprime sua ID de recuperação.

for (DeletedSecret deletedSecret : secretClient.listDeletedSecrets(new Context(key1, value2))) {
     System.out.printf("Deleted secret's recovery Id %s", deletedSecret.getRecoveryId());
 }

Parameters:

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

PagedIterable<T> de todos os DeletedSecret no cofre.

listPropertiesOfSecretVersions

public PagedIterable listPropertiesOfSecretVersions(String name)

Lista todas as versões do segredo especificado. Cada SecretProperties retornado tem apenas seu identificador e atributos preenchidos. Os valores secretos e as versões secretas não estão listados na resposta. Essa operação requer a secrets/list permissão .

Exemplo de código

O exemplo a seguir busca todas as versões do segredo especificado. Para cada versão secreta recuperada, faz uma chamada para getSecret(String name, String version) para obter o valor da versão e, em seguida, imprime-o.

for (SecretProperties secret : secretClient.listPropertiesOfSecretVersions("secretName")) {
     KeyVaultSecret secretWithValue = secretClient.getSecret(secret.getName(), secret.getVersion());
     System.out.printf("Received secret's version with name %s and value %s",
         secretWithValue.getName(), secretWithValue.getValue());
 }

Parameters:

name - O nome do segredo.

Returns:

PagedIterable<T> de SecretProperties todas as versões do segredo especificado no cofre. A lista estará vazia se o segredo com name não existir no cofre de chaves

listPropertiesOfSecretVersions

public PagedIterable listPropertiesOfSecretVersions(String name, Context context)

Exemplo de código

for (SecretProperties secret : secretClient
     .listPropertiesOfSecretVersions("secretName", new Context(key1, value2))) {
     KeyVaultSecret secretWithValue = secretClient.getSecret(secret.getName(), secret.getVersion());
     System.out.printf("Received secret's version with name %s and value %s",
         secretWithValue.getName(), secretWithValue.getValue());
 }

Iterar em versões secretas por página

O exemplo abaixo itera em cada SecretProperties página e chama getSecret(String name, String version). Isso retornará o KeyVaultSecret com o valor da versão correspondente.

secretClient.listPropertiesOfSecretVersions("secretName", new Context(key1, value2))
     .iterableByPage().forEach(resp -> {
         System.out.printf("Got response headers . Url: %s, Status code: %d %n",
             resp.getRequest().getUrl(), resp.getStatusCode());
         resp.getItems().forEach(value -> {
             KeyVaultSecret secretWithValue = secretClient.getSecret(value.getName(), value.getVersion());
             System.out.printf("Received secret's version with name %s and value %s",
                 secretWithValue.getName(), secretWithValue.getValue());
         });
     });

Parameters:

name - O nome do segredo.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

PagedIterable<T> de SecretProperties todas as versões do segredo especificado no cofre. A lista estará vazia se o segredo com name não existir no cofre de chaves

listPropertiesOfSecrets

public PagedIterable listPropertiesOfSecrets()

Lista segredos no cofre de chaves. Cada SecretProperties retornado tem apenas seu identificador e atributos preenchidos. Os valores secretos e suas versões não estão listados na resposta. Essa operação requer a secrets/list permissão.

Iterar por meio de segredos e buscar seu valor mais recente

O snippet abaixo faz um loop sobre cada SecretProperties e chama getSecret(String name, String version). Isso obtém o KeyVaultSecret valor e de sua versão mais recente.

for (SecretProperties secret : secretClient.listPropertiesOfSecrets()) {
     KeyVaultSecret secretWithValue = secretClient.getSecret(secret.getName(), secret.getVersion());
     System.out.printf("Received secret with name %s and value %s",
         secretWithValue.getName(), secretWithValue.getValue());
 }

Iterar sobre segredos por página

O snippet abaixo faz um loop sobre cada SecretProperties por página e chama getSecret(String name, String version). Isso obtém o KeyVaultSecret valor e de sua versão mais recente.

secretClient.listPropertiesOfSecrets().iterableByPage().forEach(resp -> {
     System.out.printf("Response headers are %s. Url %s  and status code %d %n", resp.getHeaders(),
         resp.getRequest().getUrl(), resp.getStatusCode());
     resp.getItems().forEach(value -> {
         KeyVaultSecret secretWithValue = secretClient.getSecret(value.getName(), value.getVersion());
         System.out.printf("Received secret with name %s and value %s",
             secretWithValue.getName(), secretWithValue.getValue());
     });
 });

Returns:

PagedIterable<T> de SecretProperties todos os segredos no cofre. O SecretProperties contém todas as informações sobre o segredo, exceto seu valor.

listPropertiesOfSecrets

public PagedIterable listPropertiesOfSecrets(Context context)

Iterar sobre segredos e buscar seu valor mais recente

O snippet abaixo faz um loop sobre cada SecretProperties e chama getSecret(String name, String version). Isso obtém o KeyVaultSecret valor e de sua versão mais recente.

for (SecretProperties secret : secretClient.listPropertiesOfSecrets(new Context(key1, value2))) {
     KeyVaultSecret secretWithValue = secretClient.getSecret(secret.getName(), secret.getVersion());
     System.out.printf("Received secret with name %s and value %s",
         secretWithValue.getName(), secretWithValue.getValue());
 }

Parameters:

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

PagedIterable<T> de SecretProperties todos os segredos no cofre. SecretProperties contém todas as informações sobre o segredo, exceto seu valor.

purgeDeletedSecret

public void purgeDeletedSecret(String name)

Remove permanentemente um segredo excluído, sem a possibilidade de recuperação. Essa operação só pode ser executada em um cofre habilitado para exclusão reversível . Essa operação requer a secrets/purge permissão.

Exemplo de código

Limpa o segredo excluído do cofre de chaves habilitado para exclusão reversível. Imprime o código status da resposta do servidor.

secretClient.purgeDeletedSecret("secretName");

Parameters:

name - O nome do segredo.

purgeDeletedSecretWithResponse

public Response purgeDeletedSecretWithResponse(String name, Context context)

Exemplo de código

Limpa o segredo excluído do cofre de chaves habilitado para exclusão reversível. Imprime o código status da resposta do servidor.

Response<Void> purgeResponse = secretClient.purgeDeletedSecretWithResponse("secretName",
     new Context(key1, value1));
 System.out.printf("Purge Status Code: %d", purgeResponse.getStatusCode());

Parameters:

name - O nome do segredo.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Uma resposta que contém status código e cabeçalhos HTTP.

restoreSecretBackup

public KeyVaultSecret restoreSecretBackup(byte[] backup)

Restaura um segredo de backup e todas as suas versões em um cofre. Essa operação requer a secrets/restore permissão.

Exemplo de código

Restaura o segredo no cofre de chaves de sua matriz de bytes de backup. Imprime os detalhes do segredo restaurado retornado na resposta.

// Pass the secret backup byte array of the secret to be restored.
 byte[] secretBackupByteArray = {};
 KeyVaultSecret restoredSecret = secretClient.restoreSecretBackup(secretBackupByteArray);
 System.out
     .printf("Restored Secret with name %s and value %s", restoredSecret.getName(), restoredSecret.getValue());

Parameters:

backup - O blob de backup associado ao segredo.

Returns:

Um Response<T> cujo value contém o KeyVaultSecret.

restoreSecretBackupWithResponse

public Response restoreSecretBackupWithResponse(byte[] backup, Context context)

Restaura um segredo de backup e todas as suas versões em um cofre. Essa operação requer a secrets/restore permissão.

Exemplo de código

Restaura o segredo no cofre de chaves de sua matriz de bytes de backup. Imprime os detalhes do segredo restaurado retornado na resposta.

// Pass the secret backup byte array of the secret to be restored.
 byte[] secretBackupByteArray = {};
 KeyVaultSecret restoredSecret = secretClient.restoreSecretBackupWithResponse(secretBackupByteArray,
     new Context(key2, value2)).getValue();
 System.out
     .printf("Restored Secret with name %s and value %s", restoredSecret.getName(), restoredSecret.getValue());

Parameters:

backup - O blob de backup associado ao segredo.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o KeyVaultSecret.

setSecret

public KeyVaultSecret setSecret(KeyVaultSecret secret)

Adiciona um segredo ao cofre de chaves se ele não existir. Se o segredo nomeado existir, uma nova versão do segredo será criada. Essa operação requer a secrets/set permissão.

Os getExpiresOn()valores , getContentType()e getNotBefore() em secret são opcionais. Se não for especificado, isEnabled() será definido como true pelo cofre de chaves.

Exemplo de código

Cria um novo segredo no cofre de chaves. Imprime os detalhes do segredo recém-criado retornado na resposta.

KeyVaultSecret newSecret = new KeyVaultSecret("secretName", "secretValue")
     .setProperties(new SecretProperties().setExpiresOn(OffsetDateTime.now().plusDays(60)));
 KeyVaultSecret returnedSecret = secretClient.setSecret(newSecret);
 System.out.printf("Secret is created with name %s and value %s%n", returnedSecret.getName(),
     returnedSecret.getValue());

Parameters:

secret - O objeto Secret que contém informações sobre o segredo e suas propriedades. As propriedades getName() e getValue() não podem ser nulas.

Returns:

O KeyVaultSecret.

setSecret

public KeyVaultSecret setSecret(String name, String value)

Adiciona um segredo ao cofre de chaves se ele não existir. Se o segredo nomeado existir, uma nova versão do segredo será criada. Essa operação requer a secrets/set permissão.

Exemplo de código

Cria um novo segredo no cofre de chaves. Imprime os detalhes do segredo recém-criado retornado na resposta.

KeyVaultSecret secret = secretClient.setSecret("secretName", "secretValue");
 System.out.printf("Secret is created with name %s and value %s%n", secret.getName(), secret.getValue());

Parameters:

name - O nome do segredo. Ela é necessária e não pode ser nula.

value - O valor do segredo. Ela é necessária e não pode ser nula.

Returns:

O KeyVaultSecret.

setSecretWithResponse

public Response setSecretWithResponse(KeyVaultSecret secret, Context context)

Adiciona um segredo ao cofre de chaves se ele não existir. Se o segredo nomeado existir, uma nova versão do segredo será criada. Essa operação requer a secrets/set permissão.

Exemplo de código

Cria um novo segredo no cofre de chaves. Imprime os detalhes do segredo recém-criado retornado na resposta.

KeyVaultSecret newSecret = new KeyVaultSecret("secretName", "secretValue")
     .setProperties(new SecretProperties().setExpiresOn(OffsetDateTime.now().plusDays(60)));
 KeyVaultSecret secret = secretClient.setSecretWithResponse(newSecret, new Context(key1, value1)).getValue();
 System.out.printf("Secret is created with name %s and value %s%n", secret.getName(), secret.getValue());

Parameters:

secret - O objeto Secret que contém informações sobre o segredo e suas propriedades. As propriedades secret.name e secret.value devem ser não nulas.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o KeyVaultSecret.

updateSecretProperties

public SecretProperties updateSecretProperties(SecretProperties secretProperties)

Atualizações os atributos associados ao segredo. O valor do segredo no cofre de chaves não pode ser alterado. Somente os atributos preenchidos em secretProperties são alterados. Os atributos não especificados na solicitação não são alterados. Essa operação requer a secrets/set permissão.

O secret é necessário e seus campos getName() e getVersion() não pode ser nulo.

Exemplo de código

Obtém a versão mais recente do segredo, altera o tempo de expiração e atualiza o segredo no cofre de chaves.

SecretProperties secretProperties = secretClient.getSecret("secretName").getProperties();
 secretProperties.setExpiresOn(OffsetDateTime.now().plusDays(60));
 SecretProperties updatedSecretProperties = secretClient.updateSecretProperties(secretProperties);
 KeyVaultSecret updatedSecret = secretClient.getSecret(updatedSecretProperties.getName());
 System.out.printf("Updated Secret is returned with name %s, value %s and expires %s%n",
     updatedSecret.getName(), updatedSecret.getValue(), updatedSecret.getProperties().getExpiresOn());

Parameters:

secretProperties - O SecretProperties objeto com propriedades atualizadas.

Returns:

O SecretProperties.

updateSecretPropertiesWithResponse

public Response updateSecretPropertiesWithResponse(SecretProperties secretProperties, Context context)

O secret é necessário e seus campos getName() e getVersion() não pode ser nulo.

Exemplo de código

Obtém a versão mais recente do segredo, altera o tempo de expiração e atualiza o segredo no cofre de chaves.

SecretProperties secretProperties = secretClient.getSecret("secretName").getProperties();
 secretProperties.setExpiresOn(OffsetDateTime.now().plusDays(60));
 SecretProperties updatedSecretBase = secretClient.updateSecretPropertiesWithResponse(secretProperties,
     new Context(key2, value2)).getValue();
 KeyVaultSecret updatedSecret = secretClient.getSecret(updatedSecretBase.getName());
 System.out.printf("Updated Secret is returned with name %s, value %s and expires %s%n",
     updatedSecret.getName(), updatedSecret.getValue(), updatedSecret.getProperties().getExpiresOn());

Parameters:

secretProperties - O SecretProperties objeto com propriedades atualizadas.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um Response<T> cujo value contém o SecretProperties.

Partilhar via

SecretClient Classe

Introdução

Criar um segredo

Obter um segredo

Excluir um segredo

Resumo do método

Métodos herdados de java.lang.Object

Detalhes do método

backupSecret

backupSecretWithResponse

beginDeleteSecret

beginRecoverDeletedSecret

getDeletedSecret

getDeletedSecretWithResponse

getSecret

getSecret

getSecretWithResponse

getVaultUrl

listDeletedSecrets

listDeletedSecrets

listPropertiesOfSecretVersions

listPropertiesOfSecretVersions

listPropertiesOfSecrets

listPropertiesOfSecrets

purgeDeletedSecret

purgeDeletedSecretWithResponse

restoreSecretBackup

restoreSecretBackupWithResponse

setSecret

setSecret

setSecretWithResponse

updateSecretProperties

updateSecretPropertiesWithResponse

Aplica-se a

Recursos adicionais