KeyClient Classe
- java.
lang. Object - com.
azure. security. keyvault. keys. KeyClient
- com.
public final class KeyClient
O KeyClient fornece métodos síncronos a serem gerenciados KeyVaultKey no Key Vault do Azure. O cliente dá suporte à criação, recuperação, atualização, exclusão, limpeza, backup, restauração, listagem, liberação e rotação do KeyVaultKey. O cliente também dá suporte à listagem DeletedKey para uma Key Vault do Azure habilitada 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 KeyClient 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 cliente de chave síncrona
O exemplo de código a seguir demonstra a criação de um KeyClient, usando o KeyClientBuilder para configurá-lo.
KeyClient keyClient = new KeyClientBuilder()
.vaultUrl("<your-key-vault-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
Criar uma chave criptográfica
O KeyClient pode ser usado para criar uma chave no cofre de chaves.
Exemplo de código:
O exemplo de código a seguir demonstra como criar uma chave criptográfica de forma síncrona no cofre de chaves usando a createKey(String name, KeyType keyType) API.
KeyVaultKey key = keyClient.createKey("keyName", KeyType.EC);
System.out.printf("Created key with name: %s and id: %s%n", key.getName(), key.getId());
Nota: Para o exemplo assíncrono, consulte KeyAsyncClient.
Obter uma chave criptográfica
O KeyClient pode ser usado para recuperar uma chave do cofre de chaves.
Exemplo de código:
O exemplo de código a seguir demonstra como recuperar uma chave de forma síncrona do cofre de chaves usando a getKey(String name) API.
KeyVaultKey keyWithVersionValue = keyClient.getKey("keyName");
System.out.printf("Retrieved key with name: %s and: id %s%n", keyWithVersionValue.getName(),
keyWithVersionValue.getId());
Nota: Para o exemplo assíncrono, consulte KeyAsyncClient.
Excluir uma chave criptográfica
O KeyClient pode ser usado para excluir uma chave do cofre de chaves.
Exemplo de código:
O exemplo de código a seguir demonstra como excluir de forma síncrona uma chave do cofre de chaves usando a beginDeleteKey(String name) API.
SyncPoller<DeletedKey, Void> deleteKeyPoller = keyClient.beginDeleteKey("keyName");
PollResponse<DeletedKey> deleteKeyPollResponse = deleteKeyPoller.poll();
// Deleted date only works for SoftDelete Enabled Key Vault.
DeletedKey deletedKey = deleteKeyPollResponse.getValue();
System.out.printf("Key delete date: %s%n", deletedKey.getDeletedOn());
System.out.printf("Deleted key's recovery id: %s%n", deletedKey.getRecoveryId());
// Key is being deleted on the server.
deleteKeyPoller.waitForCompletion();
// Key is deleted
Nota: Para o exemplo assíncrono, consulte KeyAsyncClient.
Resumo do método
Métodos herdados de java.lang.Object
Detalhes do método
backupKey
public byte[] backupKey(String name)
Solicita que um backup do especificado KeyVaultKey seja baixado para o cliente. A operação de backup de chave exporta um KeyVaultKey do Azure Key Vault em um formulário protegido. Observe que essa operação não retorna material de chave em um formulário que pode ser usado fora do sistema de Key Vault do Azure, o material de chave retornado é protegido para um HSM Key Vault do Azure ou para o próprio Azure Key Vault. A intenção dessa operação é permitir que um cliente gere um em uma KeyVaultKey instância Key Vault do Azure, faça backup do e restaure-o KeyVaultKeyem outra instância do Azure Key Vault. A operação de backup pode ser usada para exportar, de forma protegida, qualquer KeyType um do Azure Key Vault. Não é possível fazer backup de versões individuais de um KeyVaultKey . Backup/Restore pode ser executado somente dentro de limites geográficos; o que significa que um backup de uma área geográfica não pode ser restaurado para outra área geográfica. Por exemplo, um backup da área geográfica dos EUA não pode ser restaurado em uma área geográfica da UE. Essa operação requer a key/backup permissão.
Exemplos de código
Faz backup do KeyVaultKey do cofre de chaves.
byte[] keyBackup = keyClient.backupKey("keyName");
System.out.printf("Key backup byte array length: %s%n", keyBackup.length);
Parameters:
Returns:
backupKeyWithResponse
public Response
Solicita que um backup do especificado KeyVaultKey seja baixado para o cliente. A operação de backup de chave exporta um KeyVaultKey do Azure Key Vault em um formulário protegido. Observe que essa operação não retorna material de chave em um formulário que pode ser usado fora do sistema de Key Vault do Azure, o material de chave retornado é protegido para um HSM Key Vault do Azure ou para o próprio Azure Key Vault. A intenção dessa operação é permitir que um cliente gere um em uma KeyVaultKey instância Key Vault do Azure, faça backup do e restaure-o KeyVaultKeyem outra instância do Azure Key Vault. A operação de backup pode ser usada para exportar, de forma protegida, qualquer KeyType um do Azure Key Vault. Não é possível fazer backup de versões individuais de um KeyVaultKey . Backup/Restore pode ser executado somente dentro de limites geográficos; o que significa que um backup de uma área geográfica não pode ser restaurado para outra área geográfica. Por exemplo, um backup da área geográfica dos EUA não pode ser restaurado em uma área geográfica da UE. Essa operação requer a key/backup permissão.
Exemplos de código
Faz backup do KeyVaultKey do cofre de chaves e imprime o comprimento da matriz de bytes de backup da chave retornada no Response<T>.
Response<byte[]> backupKeyResponse = keyClient.backupKeyWithResponse("keyName", new Context("key1", "value1"));
System.out.printf("Key backup byte array length: %s%n", backupKeyResponse.getValue().length);
Parameters:
Returns:
beginDeleteKey
public SyncPoller
Exclui um KeyVaultKey de qualquer tipo do cofre de chaves. Se a exclusão reversível estiver habilitada no cofre de chaves, o KeyVaultKey será colocado no estado excluído e precisará ser limpo para exclusão permanente, caso contrário, o KeyVaultKey será excluído permanentemente. A operação de exclusão se aplica a qualquer KeyVaultKey armazenado no Azure Key Vault mas não pode ser aplicada a uma versão individual de um KeyVaultKey. Essa operação remove o material criptográfico associado ao , o KeyVaultKeyque significa que o KeyVaultKey não é utilizável para Wrap/UnwrapSign/Verifyoperações ou Encrypt/Decrypt . Essa operação requer a keys/delete permissão.
Exemplos de código
Exclui o KeyVaultKey do cofre de chaves. ID de recuperação impressa do KeyVaultKey.
SyncPoller<DeletedKey, Void> deleteKeyPoller = keyClient.beginDeleteKey("keyName");
PollResponse<DeletedKey> deleteKeyPollResponse = deleteKeyPoller.poll();
// Deleted date only works for SoftDelete Enabled Key Vault.
DeletedKey deletedKey = deleteKeyPollResponse.getValue();
System.out.printf("Key delete date: %s%n", deletedKey.getDeletedOn());
System.out.printf("Deleted key's recovery id: %s%n", deletedKey.getRecoveryId());
// Key is being deleted on the server.
deleteKeyPoller.waitForCompletion();
// Key is deleted
Parameters:
Returns:
beginRecoverDeletedKey
public SyncPoller
Recupera o KeyVaultKey no cofre de chaves para sua versão mais recente e só pode ser executado em um cofre habilitado para exclusão reversível. Uma tentativa de recuperar um KeyVaultKey retornará um erro. Considere isso o inverso da operação de exclusão em cofres habilitados para exclusão reversível. Essa operação requer a keys/recover permissão.
Exemplos de código
Recupera o KeyVaultKey do cofre de chaves habilitado para exclusão reversível.
SyncPoller<KeyVaultKey, Void> recoverKeyPoller = keyClient.beginRecoverDeletedKey("deletedKeyName");
PollResponse<KeyVaultKey> recoverKeyPollResponse = recoverKeyPoller.poll();
KeyVaultKey recoveredKey = recoverKeyPollResponse.getValue();
System.out.printf("Recovered key name: %s%n", recoveredKey.getName());
System.out.printf("Recovered key id: %s%n", recoveredKey.getId());
// Key is being recovered on the server.
recoverKeyPoller.waitForCompletion();
// Key is recovered
Parameters:
Returns:
createEcKey
public KeyVaultKey createEcKey(CreateEcKeyOptions createEcKeyOptions)
Cria um novo KeyVaultKey e o armazena no cofre de chaves. A operação criar chave EC pode ser usada para criar qualquer EC KeyType no Azure Key Vault. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Ele requer a keys/create permissão.
O CreateEcKeyOptions parâmetro é obrigatório. Opcionalmente getCurveName() , o pode ser especificado. Se não for especificado, o valor P_256 padrão será usado pelo Key Vault do Azure. Os expires valores e notBefore são opcionais. O enabled campo será definido true como pelo Key Vault do Azure, se não for especificado.
O keyType indica o tipo de KeyVaultKey chave a ser criado. Os valores possíveis incluem: EC e EC_HSM.
Exemplos de código
Cria um novo KeyVaultKey com uma P_384 curva de chave da Web. A chave é ativada em um dia e expira em um ano. Imprime os detalhes do KeyVaultKey.
CreateEcKeyOptions createEcKeyOptions = new CreateEcKeyOptions("keyName")
.setCurveName(KeyCurveName.P_384)
.setNotBefore(OffsetDateTime.now().plusDays(1))
.setExpiresOn(OffsetDateTime.now().plusYears(1));
KeyVaultKey ecKey = keyClient.createEcKey(createEcKeyOptions);
System.out.printf("Created key with name: %s and id: %s%n", ecKey.getName(), ecKey.getId());
Parameters:
Returns:
createEcKeyWithResponse
public Response
Cria um novo KeyVaultKey e o armazena no cofre de chaves. A operação criar chave EC pode ser usada para criar qualquer EC KeyType no Azure Key Vault. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Ele requer a keys/create permissão.
O CreateEcKeyOptions parâmetro é obrigatório. Opcionalmente getCurveName() , o pode ser especificado. Se não for especificado, o valor P_256 padrão será usado pelo Key Vault do Azure. Os expires valores e notBefore são opcionais. O enabled campo será definido true como pelo Key Vault do Azure, se não for especificado.
O keyType indica o tipo de KeyVaultKey chave a ser criado. Os valores possíveis incluem: EC e EC_HSM.
Exemplos de código
Cria um novo KeyVaultKey com uma P_384 curva de chave da Web. A chave é ativada em um dia e expira em um ano. Imprime os detalhes do KeyVaultKey.
CreateEcKeyOptions createEcKeyOptions = new CreateEcKeyOptions("keyName")
.setCurveName(KeyCurveName.P_384)
.setNotBefore(OffsetDateTime.now().plusDays(1))
.setExpiresOn(OffsetDateTime.now().plusYears(1));
Response<KeyVaultKey> createEcKeyResponse =
keyClient.createEcKeyWithResponse(createEcKeyOptions, new Context("key1", "value1"));
System.out.printf("Created key with name: %s and: id %s%n", createEcKeyResponse.getValue().getName(),
createEcKeyResponse.getValue().getId());
Parameters:
Returns:
createKey
public KeyVaultKey createKey(CreateKeyOptions createKeyOptions)
Cria um novo KeyVaultKey e o armazena no cofre de chaves. A operação criar chave pode ser usada para criar qualquer KeyType no Key Vault do Azure. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Ele requer a keys/create permissão.
O CreateKeyOptions parâmetro é obrigatório. Os getExpiresOn() valores e getNotBefore() são opcionais. O isEnabled() campo enabled} é definido como true pelo Key Vault do Azure, se não especificado.
O getKeyType() indica o tipo de KeyVaultKey a ser criado. Os valores possíveis incluem: EC, EC_HSM, RSA, RSA_HSM, OCT, e OCT_HSM.
Exemplos de código
Cria um novo KeyVaultKey que é ativado em um dia e expira em um ano. Imprime os detalhes do KeyVaultKey.
CreateKeyOptions createKeyOptions = new CreateKeyOptions("keyName", KeyType.RSA)
.setNotBefore(OffsetDateTime.now().plusDays(1))
.setExpiresOn(OffsetDateTime.now().plusYears(1));
KeyVaultKey optionsKey = keyClient.createKey(createKeyOptions);
System.out.printf("Created key with name: %s and id: %s%n", optionsKey.getName(), optionsKey.getId());
Parameters:
Returns:
createKey
public KeyVaultKey createKey(String name, KeyType keyType)
Cria um novo KeyVaultKey e o armazena no cofre de chaves. A operação criar chave pode ser usada para criar qualquer KeyType no Key Vault do Azure. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Ele requer a keys/create permissão.
O KeyType indica o tipo de KeyVaultKey a ser criado. Os valores possíveis incluem: EC, EC_HSM, RSA, RSA_HSM, OCT, e OCT_HSM.
Exemplos de código
Cria um novo KeyVaultKey. Imprime os detalhes do KeyVaultKey.
KeyVaultKey key = keyClient.createKey("keyName", KeyType.EC);
System.out.printf("Created key with name: %s and id: %s%n", key.getName(), key.getId());
Parameters:
Returns:
createKeyWithResponse
public Response
Cria um novo KeyVaultKey e o armazena no cofre de chaves. A operação criar chave pode ser usada para criar qualquer KeyType no Key Vault do Azure. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Ele requer a keys/create permissão.
O CreateKeyOptions parâmetro é obrigatório. Os getExpiresOn() valores e getNotBefore() são opcionais. O isEnabled() campo será definido true como pelo Key Vault do Azure, se não for especificado.
O getKeyType() indica o tipo de KeyVaultKey a ser criado. Os valores possíveis incluem: EC, EC_HSM, RSA, RSA_HSM, OCT, e OCT_HSM.
Exemplos de código
Cria um novo KeyVaultKey que é ativado em um dia e expira em um ano. Imprime os detalhes do KeyVaultKey.
CreateKeyOptions createKeyOptions = new CreateKeyOptions("keyName", KeyType.RSA)
.setNotBefore(OffsetDateTime.now().plusDays(1))
.setExpiresOn(OffsetDateTime.now().plusYears(1));
Response<KeyVaultKey> createKeyResponse =
keyClient.createKeyWithResponse(createKeyOptions, new Context("key1", "value1"));
System.out.printf("Created key with name: %s and: id %s%n", createKeyResponse.getValue().getName(),
createKeyResponse.getValue().getId());
Parameters:
Returns:
createOctKey
public KeyVaultKey createOctKey(CreateOctKeyOptions createOctKeyOptions)
Cria e armazena um novo KeyVaultKey no cofre de chaves. Se um KeyVaultKey com o nome fornecido já existir, o Key Vault do Azure criará uma nova versão da chave. Essa operação requer a keys/create permissão.
O CreateOctKeyOptions parâmetro é obrigatório. Os expires valores e notBefore são opcionais. O enabled campo será definido true como pelo Key Vault do Azure, se não for especificado.
O keyType indica o tipo de KeyVaultKey chave a ser criado. Os valores possíveis incluem: OCT e OCT_HSM.
Exemplos de código
Cria um novo KeyVaultKey. O KeyVaultKey é ativado em um dia e expira em um ano. Imprime os detalhes do recém-.KeyVaultKey
CreateOctKeyOptions createOctKeyOptions = new CreateOctKeyOptions("keyName")
.setNotBefore(OffsetDateTime.now().plusDays(1))
.setExpiresOn(OffsetDateTime.now().plusYears(1));
KeyVaultKey octKey = keyClient.createOctKey(createOctKeyOptions);
System.out.printf("Created key with name: %s and id: %s%n", octKey.getName(), octKey.getId());
Parameters:
Returns:
createOctKeyWithResponse
public Response
Cria e armazena um novo KeyVaultKey no cofre de chaves. Se um KeyVaultKey com o nome fornecido já existir, o Key Vault do Azure criará uma nova versão da chave. Essa operação requer a keys/create permissão.
O CreateOctKeyOptions parâmetro é obrigatório. Os expires valores e notBefore são opcionais. O enabled campo será definido true como pelo Key Vault do Azure, se não for especificado.
O keyType indica o tipo de KeyVaultKey chave a ser criado. Os valores possíveis incluem: OCT e OCT_HSM.
Exemplos de código
Cria um novo KeyVaultKey. O KeyVaultKey é ativado em um dia e expira em um ano. Imprime os detalhes do recém-.KeyVaultKey
CreateOctKeyOptions createOctKeyOptions = new CreateOctKeyOptions("keyName")
.setNotBefore(OffsetDateTime.now().plusDays(1))
.setExpiresOn(OffsetDateTime.now().plusYears(1));
Response<KeyVaultKey> createOctKeyResponse =
keyClient.createOctKeyWithResponse(createOctKeyOptions, new Context("key1", "value1"));
System.out.printf("Created key with name: %s and: id %s%n", createOctKeyResponse.getValue().getName(),
createOctKeyResponse.getValue().getId());
Parameters:
Returns:
createRsaKey
public KeyVaultKey createRsaKey(CreateRsaKeyOptions createRsaKeyOptions)
Cria um novo KeyVaultKey e o armazena no cofre de chaves. A operação criar chave RSA pode ser usada para criar qualquer tipo de chave RSA no Azure Key Vault. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Ele requer a keys/create permissão.
O CreateRsaKeyOptions parâmetro é obrigatório. Opcionalmente getKeySize() , o pode ser especificado. Os expires valores e notBefore são opcionais. O enabled campo será definido true como pelo Key Vault do Azure, se não for especificado.
O keyType indica o tipo de KeyVaultKey a ser criado. Os valores possíveis incluem: RSA e RSA_HSM.
Exemplos de código
Cria um novo KeyVaultKey com o tamanho 2048 que é ativado em um dia e expira em um ano. Imprime os detalhes do KeyVaultKey.
CreateRsaKeyOptions createRsaKeyOptions = new CreateRsaKeyOptions("keyName")
.setKeySize(2048)
.setNotBefore(OffsetDateTime.now().plusDays(1))
.setExpiresOn(OffsetDateTime.now().plusYears(1));
KeyVaultKey rsaKey = keyClient.createRsaKey(createRsaKeyOptions);
System.out.printf("Created key with name: %s and id: %s%n", rsaKey.getName(), rsaKey.getId());
Parameters:
Returns:
createRsaKeyWithResponse
public Response
Cria um novo KeyVaultKey e o armazena no cofre de chaves. A operação criar chave RSA pode ser usada para criar qualquer tipo de chave RSA no Azure Key Vault. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Ele requer a keys/create permissão .
O CreateRsaKeyOptions parâmetro é obrigatório. O getKeySize() pode ser especificado opcionalmente. Os expires valores e notBefore são opcionais. O enabled campo é definido true como pelo Azure Key Vault, se não especificado.
O keyType indica o tipo de KeyVaultKey a ser criado. Os valores possíveis incluem: RSA e RSA_HSM.
Exemplos de código
Cria um novo KeyVaultKey com tamanho 2048 que é ativado em um dia e expira em um ano. Imprime os detalhes do KeyVaultKey.
CreateRsaKeyOptions createRsaKeyOptions = new CreateRsaKeyOptions("keyName")
.setKeySize(2048)
.setNotBefore(OffsetDateTime.now().plusDays(1))
.setExpiresOn(OffsetDateTime.now().plusYears(1));
Response<KeyVaultKey> createRsaKeyResponse =
keyClient.createRsaKeyWithResponse(createRsaKeyOptions, new Context("key1", "value1"));
System.out.printf("Created key with name: %s and: id %s%n", createRsaKeyResponse.getValue().getName(),
createRsaKeyResponse.getValue().getId());
Parameters:
Returns:
getCryptographyClient
public CryptographyClient getCryptographyClient(String keyName)
Cria um CryptographyClient para a versão mais recente de uma determinada chave.
Para garantir o comportamento correto ao executar operações como Decrypt, Unwrap e Verify, é recomendável usar um CryptographyClient criado para a versão de chave específica que foi usada para a operação inversa correspondente: Encrypt, Wrapou Sign, respectivamente.
Você pode fornecer uma versão de chave por meio getCryptographyClient(String keyName, String keyVersion) de ou garantindo que ela seja incluída no keyIdentifier passado para keyIdentifier(String keyId) antes de criar um cliente.
Parameters:
Returns:
getCryptographyClient
public CryptographyClient getCryptographyClient(String keyName, String keyVersion)
Cria um CryptographyClient para uma determinada versão de chave.
Parameters:
Returns:
keyVersion estiver null ou estiver vazio, o cliente usará a versão mais recente da chave.getDeletedKey
public DeletedKey getDeletedKey(String name)
Obtém a parte pública de um KeyVaultKey. A operação Obter Chave excluída é aplicável a cofres habilitados para exclusão reversível. Essa operação requer a keys/get permissão .
Exemplos de código
Obtém o KeyVaultKey do cofre de chaves habilitado para exclusão reversível. Imprime os detalhes do KeyVaultKey.
DeletedKey deletedKey = keyClient.getDeletedKey("keyName");
System.out.printf("Deleted key's recovery id: %s%n", deletedKey.getRecoveryId());
Parameters:
Returns:
getDeletedKeyWithResponse
public Response
Obtém a parte pública de um KeyVaultKey. A operação Obter Chave excluída é aplicável a cofres habilitados para exclusão reversível. Essa operação requer a keys/get permissão .
Exemplos de código
Obtém o KeyVaultKey do cofre de chaves habilitado para exclusão reversível. Imprime os detalhes do KeyVaultKey retornado no Response<T>.
Response<DeletedKey> deletedKeyResponse =
keyClient.getDeletedKeyWithResponse("keyName", new Context("key1", "value1"));
System.out.printf("Deleted key with recovery id: %s%n", deletedKeyResponse.getValue().getRecoveryId());
Parameters:
Returns:
getKey
public KeyVaultKey getKey(String name)
Obtém a parte pública da versão de chave e especificada KeyVaultKey . A operação obter chave é aplicável a todos KeyType e requer a keys/get permissão.
Exemplos de código
Obtém uma versão específica do no cofre de KeyVaultKey chaves. Imprime os detalhes do KeyVaultKey.
KeyVaultKey keyWithVersionValue = keyClient.getKey("keyName");
System.out.printf("Retrieved key with name: %s and: id %s%n", keyWithVersionValue.getName(),
keyWithVersionValue.getId());
Parameters:
Returns:
getKey
public KeyVaultKey getKey(String name, String version)
Obtém a parte pública da versão de chave e especificada KeyVaultKey . A operação obter chave é aplicável a todos KeyType e requer a keys/get permissão.
Exemplos de código
Obtém uma versão específica do no cofre de KeyVaultKey chaves. Imprime os detalhes do KeyVaultKey.
String keyVersion = "6A385B124DEF4096AF1361A85B16C204";
KeyVaultKey keyWithVersion = keyClient.getKey("keyName", keyVersion);
System.out.printf("Retrieved key with name: %s and: id %s%n", keyWithVersion.getName(),
keyWithVersion.getId());
Parameters:
null, essa chamada será equivalente a chamar getKey(String name), com a versão mais recente sendo recuperada.
Returns:
nameversion estiverem ou vazios nullnull.getKeyRotationPolicy
public KeyRotationPolicy getKeyRotationPolicy(String keyName)
Obtém o KeyRotationPolicy para o KeyVaultKey com o nome fornecido. Essa operação requer a keys/get permissão .
Exemplos de código
Recupera o KeyRotationPolicy de um determinado KeyVaultKey. Imprime os KeyRotationPolicy detalhes.
KeyRotationPolicy keyRotationPolicy = keyClient.getKeyRotationPolicy("keyName");
System.out.printf("Retrieved key rotation policy with id: %s%n", keyRotationPolicy.getId());
Parameters:
Returns:
getKeyRotationPolicyWithResponse
public Response
Obtém o KeyRotationPolicy para o KeyVaultKey com o nome fornecido. Essa operação requer a keys/get permissão .
Exemplos de código
Recupera o KeyRotationPolicy de um determinado KeyVaultKey. Imprime os Response<T> detalhes e KeyRotationPolicy .
Response<KeyRotationPolicy> keyRotationPolicyResponse =
keyClient.getKeyRotationPolicyWithResponse("keyName", new Context("key1", "value1"));
System.out.printf("Response received successfully with status code: %d. Retrieved key rotation policy"
+ "with id: %s%n", keyRotationPolicyResponse.getStatusCode(), keyRotationPolicyResponse.getValue().getId());
Parameters:
Returns:
getKeyWithResponse
public Response
Obtém a parte pública da versão de chave e especificada KeyVaultKey . A operação obter chave é aplicável a todos KeyType e requer a keys/get permissão.
Exemplos de código
Obtém uma versão específica do no cofre de KeyVaultKey chaves. Imprime os detalhes do KeyVaultKey.
String keyVersion = "6A385B124DEF4096AF1361A85B16C204";
Response<KeyVaultKey> getKeyResponse =
keyClient.getKeyWithResponse("keyName", keyVersion, new Context("key1", "value1"));
System.out.printf("Retrieved key with name: %s and: id %s%n", getKeyResponse.getValue().getName(),
getKeyResponse.getValue().getId());
Parameters:
null, essa chamada será equivalente a chamar getKey(String name), com a versão mais recente sendo recuperada.
Returns:
nameversion estiverem ou vazios nullnull.getRandomBytes
public byte[] getRandomBytes(int count)
Obtenha o número solicitado de bytes que contêm valores aleatórios de um HSM gerenciado.
Exemplos de código
Obtém um número de bytes que contêm valores aleatórios de um HSM Gerenciado. Imprime os bytes recuperados no formato base64Url.
int amount = 16;
byte[] randomBytes = keyClient.getRandomBytes(amount);
System.out.printf("Retrieved %d random bytes: %s%n", amount, Arrays.toString(randomBytes));
Parameters:
Returns:
getRandomBytesWithResponse
public Response
Obtenha o número solicitado de bytes que contêm valores aleatórios de um HSM gerenciado.
Exemplos de código
Obtém um número de bytes que contêm valores aleatórios de um HSM Gerenciado. Imprime os Response<T> detalhes e os bytes recuperados no formato base64Url.
int amountOfBytes = 16;
Response<byte[]> response =
keyClient.getRandomBytesWithResponse(amountOfBytes, new Context("key1", "value1"));
System.out.printf("Response received successfully with status code: %d. Retrieved %d random bytes: %s%n",
response.getStatusCode(), amountOfBytes, Arrays.toString(response.getValue()));
Parameters:
Returns:
getVaultUrl
public String getVaultUrl()
Obtenha a URL do ponto de extremidade do cofre para a qual as solicitações de serviço são enviadas.
Returns:
importKey
public KeyVaultKey importKey(ImportKeyOptions importKeyOptions)
Importa um criado JsonWebKey externamente e o armazena no cofre de chaves. A operação de importação de chave pode ser usada para importar qualquer KeyType um para o Azure Key Vault. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Essa operação requer a keys/import permissão .
ImportKeyOptions é necessário e seus campos name e getKey() não podem ser null. Os expires valores e notBefore em keyImportOptions são opcionais. Se não for especificado, nenhum valor será definido para os campos. O enabled campo é definido true como e o isHardwareProtected() campo é definido false como pelo Azure Key Vault, se eles não forem especificados.
Exemplos de código
Importa um novo KeyVaultKey para o cofre de chaves. Imprime os detalhes do KeyVaultKey.
ImportKeyOptions options = new ImportKeyOptions("keyName", jsonWebKeyToImport)
.setHardwareProtected(false);
KeyVaultKey importedKey = keyClient.importKey(options);
System.out.printf("Imported key with name: %s and id: %s%n", importedKey.getName(),
importedKey.getId());
Parameters:
Returns:
importKey
public KeyVaultKey importKey(String name, JsonWebKey keyMaterial)
Importa um criado JsonWebKey externamente e o armazena no cofre de chaves. A operação de importação de chave pode ser usada para importar qualquer KeyType um para o Azure Key Vault. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Essa operação requer a keys/import permissão .
Exemplos de código
Importa um novo KeyVaultKey para o cofre de chaves. Imprime os detalhes do KeyVaultKey.
KeyVaultKey key = keyClient.importKey("keyName", jsonWebKeyToImport);
System.out.printf("Imported key with name: %s and id: %s%n", key.getName(), key.getId());
Parameters:
Returns:
importKeyWithResponse
public Response
Importa um criado JsonWebKey externamente e o armazena no cofre de chaves. A operação de importação de chave pode ser usada para importar qualquer KeyType um para o Azure Key Vault. Se um KeyVaultKey com o nome fornecido já existir, o Azure Key Vault criará uma nova versão do KeyVaultKey. Essa operação requer a keys/import permissão .
ImportKeyOptions é necessário e seus campos name e getKey() não podem ser null. Os expires valores e notBefore em keyImportOptions são opcionais. Se não for especificado, nenhum valor será definido para os campos. O enabled campo é definido true como e o isHardwareProtected() campo é definido false como pelo Azure Key Vault, se eles não forem especificados.
Exemplos de código
Importa um novo KeyVaultKey para o cofre de chaves. Imprime os detalhes do KeyVaultKey.
ImportKeyOptions importKeyOptions = new ImportKeyOptions("keyName", jsonWebKeyToImport)
.setHardwareProtected(false);
Response<KeyVaultKey> response =
keyClient.importKeyWithResponse(importKeyOptions, new Context("key1", "value1"));
System.out.printf("Imported key with name: %s and id: %s%n", response.getValue().getName(),
response.getValue().getId());
Parameters:
Returns:
listDeletedKeys
public PagedIterable
Listas DeletedKey do cofre de chaves. Os DeletedKey são recuperados como JsonWebKey estruturas que contêm a parte pública de um DeletedKey. A operação obter chaves excluídas é aplicável a cofres habilitados para exclusão reversível. Essa operação requer a keys/list permissão .
Exemplos de código
Lista o DeletedKey no cofre de chaves e para cada DeletedKey um id de recuperação.
for (DeletedKey deletedKey : keyClient.listDeletedKeys()) {
System.out.printf("Deleted key's recovery id:%s%n", deletedKey.getRecoveryId());
}
Exemplos de código para iterar sobre chaves excluídas por página
Itera pela DeletedKey página por no cofre de chaves e para cada chave excluída imprime sua ID de recuperação.
keyClient.listDeletedKeys().iterableByPage().forEach(pagedResponse -> {
System.out.printf("Got response details. Url: %s. Status code: %d.%n",
pagedResponse.getRequest().getUrl(), pagedResponse.getStatusCode());
pagedResponse.getElements().forEach(deletedKey ->
System.out.printf("Deleted key's recovery id:%s%n", deletedKey.getRecoveryId()));
});
Returns:
listDeletedKeys
public PagedIterable
Listas DeletedKey do cofre de chaves. Os DeletedKey são recuperados como JsonWebKey estruturas que contêm a parte pública de um DeletedKey. A operação obter chaves excluídas é aplicável a cofres habilitados para exclusão reversível. Essa operação requer a keys/list permissão .
Exemplos de código
Lista o DeletedKey no cofre de chaves e para cada DeletedKey um id de recuperação.
for (DeletedKey deletedKey : keyClient.listDeletedKeys(new Context("key1", "value1"))) {
System.out.printf("Deleted key's recovery id:%s%n", deletedKey.getRecoveryId());
}
Exemplos de código para iterar sobre chaves excluídas por página
Itera pela DeletedKey página por no cofre de chaves e para cada chave excluída imprime sua ID de recuperação.
keyClient.listDeletedKeys().iterableByPage().forEach(pagedResponse -> {
System.out.printf("Got response details. Url: %s. Status code: %d.%n",
pagedResponse.getRequest().getUrl(), pagedResponse.getStatusCode());
pagedResponse.getElements().forEach(deletedKey ->
System.out.printf("Deleted key's recovery id:%s%n", deletedKey.getRecoveryId()));
});
Parameters:
Returns:
listPropertiesOfKeyVersions
public PagedIterable
Liste todas as versões do especificado KeyVaultKey. A resposta de chave individual no fluxo é representada por KeyProperties como apenas o identificador de chave, atributos e marcas são fornecidos na resposta. Os valores de material de chave não são fornecidos na resposta. Essa operação requer a keys/list permissão .
É possível obter KeyVaultKey com material de chave para cada versão dessas informações. Execute um loop sobre o KeyProperties e chame getKey(String name, String version). Isso retornará o KeyVaultKey com material de chave incluído nas versões especificadas.
for (KeyProperties keyProperties : keyClient.listPropertiesOfKeyVersions("keyName")) {
KeyVaultKey key = keyClient.getKey(keyProperties.getName(), keyProperties.getVersion());
System.out.printf("Retrieved key version: %s with name: %s and type: %s%n",
key.getProperties().getVersion(), key.getName(), key.getKeyType());
}
Exemplos de código para iterar em versões de chave por página
É possível obter KeyVaultKey com material de chave para cada versão dessas informações. Itere em toda a KeyProperties página por e chame getKey(String name, String version). Isso retornará o KeyVaultKey com material de chave incluído nas versões especificadas.
keyClient.listPropertiesOfKeyVersions("keyName").iterableByPage().forEach(pagedResponse -> {
System.out.printf("Got response details. Url: %s. Status code: %d.%n",
pagedResponse.getRequest().getUrl(), pagedResponse.getStatusCode());
pagedResponse.getElements().forEach(keyProperties ->
System.out.printf("Key name: %s. Key version: %s.%n", keyProperties.getName(),
keyProperties.getVersion()));
});
Parameters:
Returns:
name não existir no cofre de chaves.listPropertiesOfKeyVersions
public PagedIterable
Liste todas as versões do especificado KeyVaultKey. A resposta de chave individual no fluxo é representada por KeyProperties como apenas o identificador de chave, atributos e marcas são fornecidos na resposta. Os valores de material de chave não são fornecidos na resposta. Essa operação requer a keys/list permissão .
É possível obter KeyVaultKey com material de chave para cada versão dessas informações. Execute um loop sobre o KeyProperties e chame getKey(String name, String version). Isso retornará o KeyVaultKey com material de chave incluído nas versões especificadas.
for (KeyProperties keyProperties : keyClient.listPropertiesOfKeyVersions("keyName", new Context("key1", "value1"))) {
KeyVaultKey key = keyClient.getKey(keyProperties.getName(), keyProperties.getVersion());
System.out.printf("Retrieved key version: %s with name: %s and type: %s%n",
key.getProperties().getVersion(), key.getName(), key.getKeyType());
}
Exemplos de código para iterar em versões de chave por página
É possível obter KeyVaultKey com material de chave para cada versão dessas informações. Iterar em toda a KeyProperties página por página e chamar getKey(String name, String version). Isso retornará o KeyVaultKey com material de chave incluído nas versões especificadas.
keyClient.listPropertiesOfKeyVersions("keyName").iterableByPage().forEach(pagedResponse -> {
System.out.printf("Got response details. Url: %s. Status code: %d.%n",
pagedResponse.getRequest().getUrl(), pagedResponse.getStatusCode());
pagedResponse.getElements().forEach(keyProperties ->
System.out.printf("Key name: %s. Key version: %s.%n", keyProperties.getName(),
keyProperties.getVersion()));
});
Parameters:
Returns:
name não existir no cofre de chaves.listPropertiesOfKeys
public PagedIterable
Listar KeyVaultKey no cofre de chaves. Recupera uma lista do no cofre de KeyVaultKey chaves como JsonWebKey estruturas que contêm a parte pública de um armazenado KeyVaultKey. A operação de lista é aplicável a todos KeyType e a resposta individual KeyVaultKey na lista é representada por KeyProperties como apenas o identificador de chave, atributos e marcas são fornecidos na resposta. O material de chave e as versões de chave individuais não estão listados na resposta. Essa operação requer a keys/list permissão.
Exemplos de código
É possível obter KeyVaultKey com o material chave dessas informações. Faça um loop sobre o KeyProperties e chame getKey(String name, String version). Isso retornará o KeyVaultKey com material de chave incluído a partir de sua versão mais recente.
for (KeyProperties keyProperties : keyClient.listPropertiesOfKeys()) {
KeyVaultKey key = keyClient.getKey(keyProperties.getName(), keyProperties.getVersion());
System.out.printf("Retrieved key with name: %s and type: %s%n", key.getName(), key.getKeyType());
}
Iterar chaves por página
É possível obter KeyVaultKey com o material chave dessas informações. Iterar em toda a KeyProperties página por página e chamar getKey(String name, String version). Isso retornará o KeyVaultKey com material de chave incluído a partir de sua versão mais recente.
keyClient.listPropertiesOfKeys().iterableByPage().forEach(pagedResponse -> {
System.out.printf("Got response details. Url: %s. Status code: %d.%n",
pagedResponse.getRequest().getUrl(), pagedResponse.getStatusCode());
pagedResponse.getElements().forEach(keyProperties -> {
KeyVaultKey key = keyClient.getKey(keyProperties.getName(), keyProperties.getVersion());
System.out.printf("Retrieved key with name: %s and type: %s%n", key.getName(),
key.getKeyType());
});
});
Returns:
listPropertiesOfKeys
public PagedIterable
Listar KeyVaultKey no cofre de chaves. Recupera uma lista do no cofre de KeyVaultKey chaves como JsonWebKey estruturas que contêm a parte pública de um armazenado KeyVaultKey. A operação de lista é aplicável a todos KeyType e a resposta individual KeyVaultKey na lista é representada por KeyProperties como apenas o identificador de chave, atributos e marcas são fornecidos na resposta. O material de chave e as versões de chave individuais não estão listados na resposta. Essa operação requer a keys/list permissão.
Exemplos de código
É possível obter KeyVaultKey com o material chave dessas informações. Faça um loop sobre o KeyProperties e chame getKey(String name, String version). Isso retornará o KeyVaultKey com material de chave incluído a partir de sua versão mais recente.
for (KeyProperties keyProperties : keyClient.listPropertiesOfKeys(new Context("key1", "value1"))) {
KeyVaultKey key = keyClient.getKey(keyProperties.getName(), keyProperties.getVersion());
System.out.printf("Retrieved key with name: %s and type: %s%n", key.getName(),
key.getKeyType());
}
Iterar por página
É possível obter KeyVaultKey com o material chave dessas informações. Iterar em toda a KeyProperties página por página e chamar getKey(String name, String version). Isso retornará o KeyVaultKey com material de chave incluído a partir de sua versão mais recente.
keyClient.listPropertiesOfKeys().iterableByPage().forEach(pagedResponse -> {
System.out.printf("Got response details. Url: %s. Status code: %d.%n",
pagedResponse.getRequest().getUrl(), pagedResponse.getStatusCode());
pagedResponse.getElements().forEach(keyProperties -> {
KeyVaultKey key = keyClient.getKey(keyProperties.getName(), keyProperties.getVersion());
System.out.printf("Retrieved key with name: %s and type: %s%n", key.getName(),
key.getKeyType());
});
});
Parameters:
Returns:
purgeDeletedKey
public void purgeDeletedKey(String name)
Exclui permanentemente o especificado KeyVaultKey sem a possibilidade de recuperação. A operação de limpeza de chave excluída é aplicável a cofres habilitados para exclusão reversível. Essa operação requer a keys/purge permissão.
Exemplos de código
Limpa o KeyVaultKey do cofre de chaves habilitado para exclusão reversível.
keyClient.purgeDeletedKey("deletedKeyName");
Parameters:
purgeDeletedKeyWithResponse
public Response
Exclui permanentemente o especificado KeyVaultKey sem a possibilidade de recuperação. A operação de limpeza de chave excluída é aplicável a cofres habilitados para exclusão reversível. Essa operação requer a keys/purge permissão.
Exemplos de código
Limpa o KeyVaultKey do cofre de chaves habilitado para exclusão reversível.
Response<Void> purgeDeletedKeyResponse = keyClient.purgeDeletedKeyWithResponse("deletedKeyName",
new Context("key1", "value1"));
System.out.printf("Purge response status code: %d%n", purgeDeletedKeyResponse.getStatusCode());
Parameters:
Returns:
releaseKey
public ReleaseKeyResult releaseKey(String name, String targetAttestationToken)
Libera a versão mais recente de um KeyVaultKey.
O KeyVaultKey deve ser exportável. Essa operação requer a keys/release permissão.
Exemplos de código
Libera um KeyVaultKey. Imprime o objeto assinado que contém a chave de liberação.
String targetAttestationToken = "someAttestationToken";
ReleaseKeyResult releaseKeyResult = keyClient.releaseKey("keyName", targetAttestationToken);
System.out.printf("Signed object containing released key: %s%n", releaseKeyResult);
Parameters:
Returns:
releaseKey
public ReleaseKeyResult releaseKey(String name, String version, String targetAttestationToken)
Libera uma versão específica de um KeyVaultKey.
O KeyVaultKey deve ser exportável. Essa operação requer a keys/release permissão.
Exemplos de código
Libera um KeyVaultKey. Imprime o objeto assinado que contém a chave de liberação.
String myKeyVersion = "6A385B124DEF4096AF1361A85B16C204";
String myTargetAttestationToken = "someAttestationToken";
ReleaseKeyResult releaseKeyVersionResult =
keyClient.releaseKey("keyName", myKeyVersion, myTargetAttestationToken);
System.out.printf("Signed object containing released key: %s%n", releaseKeyVersionResult);
Parameters:
null, essa chamada será equivalente a chamar releaseKey(String name, String targetAttestationToken), com a versão mais recente da chave sendo lançada.
Returns:
releaseKeyWithResponse
public Response
Libera um KeyVaultKey.
A chave deve ser exportável. Essa operação requer a keys/release permissão.
Exemplos de código
Libera um KeyVaultKey. Imprime os Response<T> detalhes e o objeto assinado que contém a chave de liberação.
String releaseKeyVersion = "6A385B124DEF4096AF1361A85B16C204";
String someTargetAttestationToken = "someAttestationToken";
ReleaseKeyOptions releaseKeyOptions = new ReleaseKeyOptions()
.setAlgorithm(KeyExportEncryptionAlgorithm.RSA_AES_KEY_WRAP_256)
.setNonce("someNonce");
Response<ReleaseKeyResult> releaseKeyResultResponse =
keyClient.releaseKeyWithResponse("keyName", releaseKeyVersion, someTargetAttestationToken,
releaseKeyOptions, new Context("key1", "value1"));
System.out.printf("Response received successfully with status code: %d. Signed object containing"
+ "released key: %s%n", releaseKeyResultResponse.getStatusCode(),
releaseKeyResultResponse.getValue().getValue());
Parameters:
null, essa chamada será equivalente a chamar releaseKey(String name, String targetAttestationToken), com a versão mais recente da chave sendo lançada.
Returns:
restoreKeyBackup
public KeyVaultKey restoreKeyBackup(byte[] backup)
Restaura um backup em KeyVaultKey um cofre. Importa um backup KeyVaultKey anterior no Azure Key Vault, restaurando o , seu KeyVaultKeyidentificador de chave, atributos e políticas de controle de acesso. A operação de restauração pode ser usada para importar um backup KeyVaultKeyanterior. Versões individuais de um KeyVaultKey não podem ser restauradas. O KeyVaultKey é restaurado em sua totalidade com o mesmo nome de chave que tinha quando foi feito backup. Se o nome da chave não estiver disponível no cofre de chaves de destino, a operação de restauração será rejeitada. Embora o nome da chave seja retido durante a restauração, o identificador de chave final será alterado se o KeyVaultKey for restaurado para um cofre diferente. A restauração irá restaurar todas as versões e preservar os identificadores de versão. A operação de restauração está sujeita a restrições de segurança: o cofre de chaves de destino deve pertencer à mesma Assinatura do Microsoft Azure que o cofre de chaves de origem. O usuário deve ter a restore permissão no cofre de chaves de destino. Essa operação requer a keys/restore permissão .
Exemplos de código
Restaura o KeyVaultKey no cofre de chaves de seu backup.
Passe a matriz de bytes de backup de chave para a operação de restauração.
byte[] keyBackupByteArray = {};
KeyVaultKey keyResponse = keyClient.restoreKeyBackup(keyBackupByteArray);
System.out.printf("Restored key with name: %s and: id %s%n", keyResponse.getName(), keyResponse.getId());
Parameters:
Returns:
restoreKeyBackupWithResponse
public Response
Restaura um backup KeyVaultKey em um cofre. Importa um backup KeyVaultKey anteriormente no Azure Key Vault, restaurando o , seu KeyVaultKeyidentificador de chave, atributos e políticas de controle de acesso. A operação de restauração pode ser usada para importar um backup KeyVaultKeyanterior. Versões individuais de um KeyVaultKey não podem ser restauradas. O KeyVaultKey é restaurado em sua totalidade com o mesmo nome de chave que tinha quando foi copiado em backup. Se o nome da chave não estiver disponível no cofre de chaves de destino, a operação de restauração será rejeitada. Embora o nome da chave seja mantido durante a restauração, o identificador de chave final será alterado se o KeyVaultKey for restaurado para um cofre diferente. A restauração irá restaurar todas as versões e preservar os identificadores de versão. A operação de restauração está sujeita a restrições de segurança: o cofre de chaves de destino deve pertencer à mesma Assinatura do Microsoft Azure que o cofre de chaves de origem. O usuário deve ter a restore permissão no cofre de chaves de destino. Essa operação requer a keys/restore permissão .
Exemplos de código
Restaura o KeyVaultKey no cofre de chaves de seu backup. Imprime os detalhes do KeyVaultKey retornado no Response<T>.
Passe a matriz de bytes de backup de chave para a operação de restauração.
Response<KeyVaultKey> keyResponse = keyClient.restoreKeyBackupWithResponse(keyBackupByteArray,
new Context("key1", "value1"));
System.out.printf("Restored key with name: %s and: id %s%n",
keyResponse.getValue().getName(), keyResponse.getValue().getId());
Parameters:
Returns:
rotateKey
public KeyVaultKey rotateKey(String name)
Gira um KeyVaultKey. A operação de rotação de chave fará isso com base em KeyRotationPolicy. Essa operação requer a keys/rotate permissão .
Exemplos de código
Gira um KeyVaultKey. Imprime KeyVaultKey detalhes.
KeyVaultKey key = keyClient.rotateKey("keyName");
System.out.printf("Rotated key with name: %s and version:%s%n", key.getName(),
key.getProperties().getVersion());
Parameters:
Returns:
rotateKeyWithResponse
public Response
Gira um KeyVaultKey. A operação de rotação de chave fará isso com base em KeyRotationPolicy. Essa operação requer a keys/rotate permissão .
Exemplos de código
Gira um KeyVaultKey. Imprime os Response<T> detalhes e KeyVaultKey .
Response<KeyVaultKey> keyResponse = keyClient.rotateKeyWithResponse("keyName", new Context("key1", "value1"));
System.out.printf("Response received successfully with status code: %d. Rotated key with name: %s and"
+ "version: %s%n", keyResponse.getStatusCode(), keyResponse.getValue().getName(),
keyResponse.getValue().getProperties().getVersion());
Parameters:
Returns:
updateKeyProperties
public KeyVaultKey updateKeyProperties(KeyProperties keyProperties, KeyOperation[] keyOperations)
Atualizações e KeyPropertiesKeyOperation associado ao especificadoKeyVaultKey, mas não ao material de chave criptográfica do especificado KeyVaultKey no cofre de chaves. As alterações de operação de atualização especificadas KeyProperties de um armazenado KeyVaultKey existente e KeyProperties que não são especificadas na solicitação são deixadas inalteradas. O material de chave criptográfica de um KeyVaultKey próprio não pode ser alterado. Essa operação requer a keys/set permissão .
Exemplos de código
Obtém a versão mais recente do KeyVaultKey, altera o tempo de expiração e KeyOperation o atualiza no KeyVaultKey cofre de chaves.
KeyVaultKey key = keyClient.getKey("keyName");
key.getProperties().setExpiresOn(OffsetDateTime.now().plusDays(60));
KeyVaultKey updatedKey = keyClient.updateKeyProperties(key.getProperties(), KeyOperation.ENCRYPT,
KeyOperation.DECRYPT);
System.out.printf("Key is updated with name %s and id %s %n", updatedKey.getName(), updatedKey.getId());
Parameters:
Returns:
updateKeyPropertiesWithResponse
public Response
Atualizações e KeyPropertiesKeyOperation associado ao especificadoKeyVaultKey, mas não ao material de chave criptográfica do especificado KeyVaultKey no cofre de chaves. As alterações de operação de atualização especificadas KeyProperties de um armazenado KeyVaultKey existente e KeyProperties que não são especificadas na solicitação são deixadas inalteradas. O material de chave criptográfica de um KeyVaultKey próprio não pode ser alterado. Essa operação requer a keys/set permissão .
Exemplos de código
Obtém a versão mais recente do KeyVaultKey, altera o tempo de expiração e KeyOperation o atualiza no KeyVaultKey cofre de chaves.
KeyVaultKey key = keyClient.getKey("keyName");
key.getProperties().setExpiresOn(OffsetDateTime.now().plusDays(60));
Response<KeyVaultKey> updateKeyResponse =
keyClient.updateKeyPropertiesWithResponse(key.getProperties(), new Context("key1", "value1"),
KeyOperation.ENCRYPT, KeyOperation.DECRYPT);
System.out.printf("Updated key with name: %s and id: %s%n", updateKeyResponse.getValue().getName(),
updateKeyResponse.getValue().getId());
Parameters:
Returns:
updateKeyRotationPolicy
public KeyRotationPolicy updateKeyRotationPolicy(String keyName, KeyRotationPolicy keyRotationPolicy)
Atualizações o KeyRotationPolicyKeyVaultKey do com o nome fornecido. Essa operação requer a keys/update permissão .
Exemplos de código
Atualizações o KeyRotationPolicy de um determinado KeyVaultKey. Imprime os KeyRotationPolicy detalhes.
List<KeyRotationLifetimeAction> lifetimeActions = new ArrayList<>();
KeyRotationLifetimeAction rotateLifetimeAction = new KeyRotationLifetimeAction(KeyRotationPolicyAction.ROTATE)
.setTimeAfterCreate("P90D");
KeyRotationLifetimeAction notifyLifetimeAction = new KeyRotationLifetimeAction(KeyRotationPolicyAction.NOTIFY)
.setTimeBeforeExpiry("P45D");
lifetimeActions.add(rotateLifetimeAction);
lifetimeActions.add(notifyLifetimeAction);
KeyRotationPolicy keyRotationPolicy = new KeyRotationPolicy()
.setLifetimeActions(lifetimeActions)
.setExpiresIn("P6M");
KeyRotationPolicy updatedPolicy =
keyClient.updateKeyRotationPolicy("keyName", keyRotationPolicy);
System.out.printf("Updated key rotation policy with id: %s%n", updatedPolicy.getId());
Parameters:
Returns:
updateKeyRotationPolicyWithResponse
public Response
Atualizações o KeyRotationPolicy da chave com o nome fornecido. Essa operação requer a keys/update permissão .
Exemplos de código
Atualizações o KeyRotationPolicy de um determinado KeyVaultKey. Imprime os Response<T> detalhes e KeyRotationPolicy .
List<KeyRotationLifetimeAction> myLifetimeActions = new ArrayList<>();
KeyRotationLifetimeAction myRotateLifetimeAction = new KeyRotationLifetimeAction(KeyRotationPolicyAction.ROTATE)
.setTimeAfterCreate("P90D");
KeyRotationLifetimeAction myNotifyLifetimeAction = new KeyRotationLifetimeAction(KeyRotationPolicyAction.NOTIFY)
.setTimeBeforeExpiry("P45D");
myLifetimeActions.add(myRotateLifetimeAction);
myLifetimeActions.add(myNotifyLifetimeAction);
KeyRotationPolicy myKeyRotationPolicy = new KeyRotationPolicy()
.setLifetimeActions(myLifetimeActions)
.setExpiresIn("P6M");
Response<KeyRotationPolicy> keyRotationPolicyResponse = keyClient.updateKeyRotationPolicyWithResponse(
"keyName", myKeyRotationPolicy, new Context("key1", "value1"));
System.out.printf("Response received successfully with status code: %d. Updated key rotation policy"
+ "with id: %s%n", keyRotationPolicyResponse.getStatusCode(), keyRotationPolicyResponse.getValue().getId());
Parameters:
Returns:
Aplica-se a
Azure SDK for Java