KeyClient Classe
- java.
lang. Object - com.
azure. security. keyvault. keys. KeyClient
- com.
public final class KeyClient
Fournit KeyClient des méthodes synchrones à gérer KeyVaultKey dans azure Key Vault. Le client prend en charge la création, la récupération, la mise à jour, la suppression, la purge, la sauvegarde, la restauration, la liste, la libération et la rotation du KeyVaultKey. Le client prend également en charge la liste DeletedKey d’un Key Vault Azure avec suppression réversible.
Mise en route
Pour interagir avec le service Azure Key Vault, vous devez créer un instance de la KeyClient classe, une URL de coffre et un objet d’informations d’identification.
Les exemples présentés dans ce document utilisent un objet d’informations d’identification nommé DefaultAzureCredential pour l’authentification, qui convient à la plupart des scénarios, notamment aux environnements de développement et de production locaux. En outre, nous vous recommandons d’utiliser une identité managée pour l’authentification dans les environnements de production. Vous trouverez plus d’informations sur les différentes méthodes d’authentification et leurs types d’informations d’identification correspondants dans la documentation Azure Identity.
Exemple : Construire un client de clé synchrone
L’exemple de code suivant illustre la création d’un KeyClient, à l’aide de pour le KeyClientBuilder configurer.
KeyClient keyClient = new KeyClientBuilder()
.vaultUrl("<your-key-vault-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
Créer une clé de chiffrement
Peut KeyClient être utilisé pour créer une clé dans le coffre de clés.
Exemple de code :
L’exemple de code suivant montre comment créer de manière synchrone une clé de chiffrement dans le coffre de clés, à l’aide de l’API createKey(String name, KeyType keyType) .
KeyVaultKey key = keyClient.createKey("keyName", KeyType.EC);
System.out.printf("Created key with name: %s and id: %s%n", key.getName(), key.getId());
Note: Pour l’exemple asynchrone, reportez-vous à KeyAsyncClient.
Obtenir une clé de chiffrement
Peut KeyClient être utilisé pour récupérer une clé à partir du coffre de clés.
Exemple de code :
L’exemple de code suivant montre comment récupérer de manière synchrone une clé à partir du coffre de clés, à l’aide de l’API getKey(String name) .
KeyVaultKey keyWithVersionValue = keyClient.getKey("keyName");
System.out.printf("Retrieved key with name: %s and: id %s%n", keyWithVersionValue.getName(),
keyWithVersionValue.getId());
Note: Pour l’exemple asynchrone, reportez-vous à KeyAsyncClient.
Supprimer une clé de chiffrement
Peut KeyClient être utilisé pour supprimer une clé du coffre de clés.
Exemple de code :
L’exemple de code suivant montre comment supprimer de manière synchrone une clé du coffre de clés à l’aide de l’API beginDeleteKey(String name) .
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
Note: Pour l’exemple asynchrone, reportez-vous à KeyAsyncClient.
Résumé de la méthode
Méthodes héritées de java.lang.Object
Détails de la méthode
backupKey
public byte[] backupKey(String name)
Demande qu’une sauvegarde du spécifié KeyVaultKey soit téléchargée sur le client. L’opération de sauvegarde de clé exporte un KeyVaultKey à partir d’Azure Key Vault sous une forme protégée. Notez que cette opération ne retourne pas le matériel de clé sous une forme qui peut être utilisée en dehors du système de Key Vault Azure, le matériel de clé retourné est protégé par un HSM Azure Key Vault ou par Azure Key Vault lui-même. L’objectif de cette opération est de permettre à un client de générer un KeyVaultKey dans un Key Vault instance Azure, de sauvegarder le , puis de le KeyVaultKeyrestaurer dans un autre Key Vault instance Azure. L’opération de sauvegarde peut être utilisée pour exporter, sous forme protégée, n’importe quel KeyType élément à partir d’Azure Key Vault. Les versions individuelles d’un KeyVaultKey ne peuvent pas être sauvegardées. Backup/Restore ne peut être effectué qu’à l’intérieur des limites géographiques ; Cela signifie qu’une sauvegarde d’une zone géographique ne peut pas être restaurée dans une autre zone géographique. Par exemple, une sauvegarde réalisée dans la zone géographique US ne peut pas être restaurée dans une zone géographique UE. Cette opération nécessite l’autorisation key/backup .
Exemples de code
Sauvegarde le KeyVaultKey à partir du coffre de clés.
byte[] keyBackup = keyClient.backupKey("keyName");
System.out.printf("Key backup byte array length: %s%n", keyBackup.length);
Parameters:
Returns:
backupKeyWithResponse
public Response
Demande qu’une sauvegarde du spécifié KeyVaultKey soit téléchargée sur le client. L’opération de sauvegarde de clé exporte un KeyVaultKey à partir d’Azure Key Vault sous une forme protégée. Notez que cette opération ne retourne pas le matériel de clé sous une forme qui peut être utilisée en dehors du système de Key Vault Azure, le matériel de clé retourné est protégé par un HSM Azure Key Vault ou par Azure Key Vault lui-même. L’objectif de cette opération est de permettre à un client de générer un KeyVaultKey dans un Key Vault instance Azure, de sauvegarder le , puis de le KeyVaultKeyrestaurer dans un autre Key Vault instance Azure. L’opération de sauvegarde peut être utilisée pour exporter, sous forme protégée, n’importe quel KeyType élément à partir d’Azure Key Vault. Les versions individuelles d’un KeyVaultKey ne peuvent pas être sauvegardées. Backup/Restore ne peut être effectué qu’à l’intérieur des limites géographiques ; Cela signifie qu’une sauvegarde d’une zone géographique ne peut pas être restaurée dans une autre zone géographique. Par exemple, une sauvegarde réalisée dans la zone géographique US ne peut pas être restaurée dans une zone géographique UE. Cette opération nécessite l’autorisation key/backup .
Exemples de code
Sauvegarde le KeyVaultKey à partir du coffre de clés et imprime la longueur du tableau d’octets de sauvegarde de la clé retourné dans le 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
Supprime un KeyVaultKey de n’importe quel type du coffre de clés. Si la suppression réversible est activée sur le coffre de clés, le KeyVaultKey est placé dans l’état supprimé et doit être vidé pour la suppression définitive. Sinon, le KeyVaultKey est définitivement supprimé. L’opération de suppression s’applique à n’importe quel KeyVaultKey stocké dans Azure Key Vault, mais elle ne peut pas être appliquée à une version individuelle d’un KeyVaultKey. Cette opération supprime le matériel de chiffrement associé à , KeyVaultKeyce qui signifie que n’est KeyVaultKey pas utilisable pour Sign/Verifyles opérations ou Wrap/UnwrapEncrypt/Decrypt . Cette opération nécessite l’autorisation keys/delete .
Exemples de code
Supprime du KeyVaultKey coffre de clés. Imprime l’ID de récupération de .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
Récupère le KeyVaultKey dans le coffre de clés vers sa dernière version et ne peut être effectué que sur un coffre activé pour la suppression réversible. Une tentative de récupération d’un KeyVaultKey renvoie une erreur. Considérez cela comme l’inverse de l’opération de suppression sur les coffres activés pour la suppression réversible. Cette opération nécessite l’autorisation keys/recover .
Exemples de code
Récupère à partir du KeyVaultKey coffre de clés activé pour la suppression réversible.
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)
Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés. L’opération de création de clé EC peut être utilisée pour créer n’importe quelle EC KeyType dans Azure Key Vault. S’il existe déjà un KeyVaultKey avec le nom fourni, Azure Key Vault crée une nouvelle version de .KeyVaultKey Elle nécessite l’autorisation keys/create .
Le paramètre CreateEcKeyOptions est obligatoire. Peut getCurveName() être spécifié éventuellement. Si elle n’est pas spécifiée, la valeur P_256 par défaut est utilisée par Azure Key Vault. Les expires valeurs et notBefore sont facultatives. Le enabled champ est défini true sur par Azure Key Vault, s’il n’est pas spécifié.
indique keyType le type de KeyVaultKey clé à créer. Les valeurs possibles sont : EC et EC_HSM.
Exemples de code
Crée un avec KeyVaultKey une P_384 courbe de clé web. La clé s’active en un jour et expire dans un an. Imprime les détails de .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
Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés. L’opération de création de clé EC peut être utilisée pour créer n’importe quelle EC KeyType dans Azure Key Vault. S’il existe déjà un KeyVaultKey avec le nom fourni, Azure Key Vault crée une nouvelle version de .KeyVaultKey Elle nécessite l’autorisation keys/create .
Le paramètre CreateEcKeyOptions est obligatoire. Peut getCurveName() être spécifié éventuellement. Si elle n’est pas spécifiée, la valeur P_256 par défaut est utilisée par Azure Key Vault. Les expires valeurs et notBefore sont facultatives. Le enabled champ est défini true sur par Azure Key Vault, s’il n’est pas spécifié.
indique keyType le type de KeyVaultKey clé à créer. Les valeurs possibles sont : EC et EC_HSM.
Exemples de code
Crée un nouveau KeyVaultKey avec une P_384 courbe de clé web. La clé s’active en un jour et expire dans un an. Imprime les détails de .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)
Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés. L’opération de création de clé peut être utilisée pour créer n’importe quelle KeyType clé dans Azure Key Vault. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de .KeyVaultKey Il nécessite l’autorisation keys/create .
Le paramètre CreateKeyOptions est obligatoire. Les getExpiresOn() valeurs et getNotBefore() sont facultatives. Le isEnabled() champ enabled} est défini true sur par Azure Key Vault, s’il n’est pas spécifié.
indique getKeyType() le type de KeyVaultKey à créer. Les valeurs possibles incluent : EC, EC_HSM, RSA_HSMRSA, , OCTet OCT_HSM.
Exemples de code
Crée un nouveau KeyVaultKey qui s’active en un jour et expire dans un an. Imprime les détails de .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)
Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés. L’opération de création de clé peut être utilisée pour créer n’importe quelle KeyType clé dans Azure Key Vault. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de .KeyVaultKey Il nécessite l’autorisation keys/create .
indique KeyType le type de KeyVaultKey à créer. Les valeurs possibles incluent : EC, EC_HSM, RSA_HSMRSA, , OCTet OCT_HSM.
Exemples de code
Crée un KeyVaultKey. Imprime les détails de .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
Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés. L’opération de création de clé peut être utilisée pour créer n’importe quelle KeyType clé dans Azure Key Vault. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de .KeyVaultKey Il nécessite l’autorisation keys/create .
Le paramètre CreateKeyOptions est obligatoire. Les getExpiresOn() valeurs et getNotBefore() sont facultatives. Le isEnabled() champ est défini true sur par Azure Key Vault, s’il n’est pas spécifié.
indique getKeyType() le type de KeyVaultKey à créer. Les valeurs possibles incluent : EC, EC_HSM, RSA_HSMRSA, , OCTet OCT_HSM.
Exemples de code
Crée un nouveau KeyVaultKey qui s’active en un jour et expire dans un an. Imprime les détails de .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)
Crée et stocke un nouveau KeyVaultKey dans le coffre de clés. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de la clé. Cette opération nécessite l’autorisation keys/create .
Le paramètre CreateOctKeyOptions est obligatoire. Les expires valeurs et notBefore sont facultatives. Le enabled champ est défini true sur par Azure Key Vault, s’il n’est pas spécifié.
indique keyType le type de KeyVaultKey clé à créer. Les valeurs possibles sont les suivantes : OCT et OCT_HSM.
Exemples de code
Crée un KeyVaultKey. S’active KeyVaultKey en un jour et expire dans un an. Imprime les détails de la nouvelle 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
Crée et stocke un nouveau KeyVaultKey dans le coffre de clés. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de la clé. Cette opération nécessite l’autorisation keys/create .
Le paramètre CreateOctKeyOptions est obligatoire. Les expires valeurs et notBefore sont facultatives. Le enabled champ est défini true sur par Azure Key Vault, s’il n’est pas spécifié.
indique keyType le type de KeyVaultKey clé à créer. Les valeurs possibles sont les suivantes : OCT et OCT_HSM.
Exemples de code
Crée un KeyVaultKey. S’active KeyVaultKey en un jour et expire dans un an. Imprime les détails de la nouvelle 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)
Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés. L’opération de création de clé RSA peut être utilisée pour créer n’importe quel type de clé RSA dans Azure Key Vault. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de .KeyVaultKey Il nécessite l’autorisation keys/create .
Le paramètre CreateRsaKeyOptions est obligatoire. getKeySize() Peut être spécifié éventuellement. Les expires valeurs et notBefore sont facultatives. Le enabled champ est défini true sur par Azure Key Vault, s’il n’est pas spécifié.
indique keyType le type de KeyVaultKey à créer. Les valeurs possibles sont les suivantes : RSA et RSA_HSM.
Exemples de code
Crée un nouveau KeyVaultKey avec la taille 2048 qui s’active en un jour et expire dans un an. Imprime les détails de .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
Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés. L’opération de création de clé RSA peut être utilisée pour créer n’importe quel type de clé RSA dans Azure Key Vault. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de .KeyVaultKey Il nécessite l’autorisation keys/create .
Le paramètre CreateRsaKeyOptions est obligatoire. getKeySize() Peut être spécifié éventuellement. Les expires valeurs et notBefore sont facultatives. Le enabled champ est défini true sur par Azure Key Vault, s’il n’est pas spécifié.
indique keyType le type de KeyVaultKey à créer. Les valeurs possibles sont les suivantes : RSA et RSA_HSM.
Exemples de code
Crée un nouveau KeyVaultKey avec la taille 2048 qui s’active en un jour et expire dans un an. Imprime les détails de .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)
Crée un CryptographyClient pour la dernière version d’une clé donnée.
Pour garantir un comportement correct lors de l’exécution d’opérations telles que Decrypt, Unwrap et Verify, il est recommandé d’utiliser un CryptographyClient créé pour la version de clé spécifique qui a été utilisée pour l’opération inverse correspondante : Encrypt, Wrapou Sign, respectivement.
Vous pouvez fournir une version de clé via getCryptographyClient(String keyName, String keyVersion) ou en vous assurant qu’elle est incluse dans le passé à keyIdentifier(String keyId) avant de keyIdentifier créer un client.
Parameters:
Returns:
getCryptographyClient
public CryptographyClient getCryptographyClient(String keyName, String keyVersion)
Crée un CryptographyClient pour une version de clé donnée.
Parameters:
Returns:
keyVersion est null ou vide, le client utilise la dernière version de la clé.getDeletedKey
public DeletedKey getDeletedKey(String name)
Obtient la partie publique d’un KeyVaultKey. L’opération obtenir la clé supprimée s’applique aux coffres avec suppression réversible. Cette opération nécessite l’autorisation keys/get .
Exemples de code
Obtient le KeyVaultKey à partir du coffre de clés activé pour la suppression réversible. Imprime les détails de .KeyVaultKey
DeletedKey deletedKey = keyClient.getDeletedKey("keyName");
System.out.printf("Deleted key's recovery id: %s%n", deletedKey.getRecoveryId());
Parameters:
Returns:
getDeletedKeyWithResponse
public Response
Obtient la partie publique d’un KeyVaultKey. L’opération obtenir la clé supprimée s’applique aux coffres avec suppression réversible. Cette opération nécessite l’autorisation keys/get .
Exemples de code
Obtient le KeyVaultKey à partir du coffre de clés activé pour la suppression réversible. Imprime les détails du KeyVaultKey retourné dans .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)
Obtient la partie publique de la version spécifiée KeyVaultKey et de la clé. L’opération obtenir la clé s’applique à tous KeyType et nécessite l’autorisation keys/get .
Exemples de code
Obtient une version spécifique de dans KeyVaultKey le coffre de clés. Imprime les détails de .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)
Obtient la partie publique de la version spécifiée KeyVaultKey et de la clé. L’opération obtenir la clé s’applique à tous KeyType et nécessite l’autorisation keys/get .
Exemples de code
Obtient une version spécifique de dans KeyVaultKey le coffre de clés. Imprime les détails de .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, cet appel équivaut à appeler getKey(String name), la dernière version étant récupérée.
Returns:
name et version sont ou videsnull.nullgetKeyRotationPolicy
public KeyRotationPolicy getKeyRotationPolicy(String keyName)
Obtient le KeyRotationPolicy pour avec KeyVaultKey le nom fourni. Cette opération nécessite l’autorisation keys/get .
Exemples de code
Récupère le KeyRotationPolicy d’un donné KeyVaultKey. Imprime les KeyRotationPolicy détails.
KeyRotationPolicy keyRotationPolicy = keyClient.getKeyRotationPolicy("keyName");
System.out.printf("Retrieved key rotation policy with id: %s%n", keyRotationPolicy.getId());
Parameters:
Returns:
getKeyRotationPolicyWithResponse
public Response
Obtient le KeyRotationPolicy pour avec KeyVaultKey le nom fourni. Cette opération nécessite l’autorisation keys/get .
Exemples de code
Récupère le KeyRotationPolicy d’un donné KeyVaultKey. Imprime les détails et Response<T>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
Obtient la partie publique de la version spécifiée KeyVaultKey et de la clé. L’opération obtenir la clé s’applique à tous KeyType et nécessite l’autorisation keys/get .
Exemples de code
Obtient une version spécifique de dans KeyVaultKey le coffre de clés. Imprime les détails de .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, cet appel équivaut à appeler getKey(String name), la dernière version étant récupérée.
Returns:
name et version sont ou videsnull.nullgetRandomBytes
public byte[] getRandomBytes(int count)
Obtenez le nombre d’octets demandé contenant des valeurs aléatoires à partir d’un HSM managé.
Exemples de code
Obtient un nombre d’octets contenant des valeurs aléatoires d’un HSM managé. Imprime les octets récupérés au format 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
Obtenez le nombre d’octets demandé contenant des valeurs aléatoires à partir d’un HSM managé.
Exemples de code
Obtient un nombre d’octets contenant des valeurs aléatoires d’un HSM managé. Imprime les détails et les Response<T> octets récupérés au format 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()
Obtenez l’URL du point de terminaison du coffre à laquelle les demandes de service sont envoyées.
Returns:
importKey
public KeyVaultKey importKey(ImportKeyOptions importKeyOptions)
Importe un créé JsonWebKey en externe et le stocke dans le coffre de clés. L’opération d’importation de clé peut être utilisée pour importer des KeyType éléments dans Azure Key Vault. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de .KeyVaultKey Cette opération nécessite l’autorisation keys/import .
ImportKeyOptions est obligatoire et ses champs name et getKey() ne peuvent pas être null. Les expires valeurs et notBefore dans keyImportOptions sont facultatives. Si elle n’est pas spécifiée, aucune valeur n’est définie pour les champs. Le enabled champ est défini sur true et le isHardwareProtected() champ est défini false sur par Azure Key Vault, s’ils ne sont pas spécifiés.
Exemples de code
Importe un nouveau KeyVaultKey dans le coffre de clés. Imprime les détails de .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)
Importe un créé JsonWebKey en externe et le stocke dans le coffre de clés. L’opération d’importation de clé peut être utilisée pour importer des KeyType éléments dans Azure Key Vault. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de .KeyVaultKey Cette opération nécessite l’autorisation keys/import .
Exemples de code
Importe un nouveau KeyVaultKey dans le coffre de clés. Imprime les détails de .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
Importe un créé JsonWebKey en externe et le stocke dans le coffre de clés. L’opération d’importation de clé peut être utilisée pour importer des KeyType éléments dans Azure Key Vault. Si un KeyVaultKey avec le nom fourni existe déjà, Azure Key Vault crée une nouvelle version de .KeyVaultKey Cette opération nécessite l’autorisation keys/import .
ImportKeyOptions est obligatoire et ses champs name et getKey() ne peuvent pas être null. Les expires valeurs et notBefore dans keyImportOptions sont facultatives. Si elle n’est pas spécifiée, aucune valeur n’est définie pour les champs. Le enabled champ est défini sur true et le isHardwareProtected() champ est défini false sur par Azure Key Vault, s’ils ne sont pas spécifiés.
Exemples de code
Importe un nouveau KeyVaultKey dans le coffre de clés. Imprime les détails de .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
Listes DeletedKey du coffre de clés. Les DeletedKey sont récupérés en tant JsonWebKey que structures qui contiennent la partie publique d’un DeletedKey. L’opération obtenir les clés supprimées s’applique aux coffres activés pour la suppression réversible. Cette opération nécessite l’autorisation keys/list .
Exemples de code
Répertorie le DeletedKey dans le coffre de clés et pour chacun DeletedKey affiche son ID de récupération.
for (DeletedKey deletedKey : keyClient.listDeletedKeys()) {
System.out.printf("Deleted key's recovery id:%s%n", deletedKey.getRecoveryId());
}
Exemples de code pour itérer sur les clés supprimées par page
Itère sur la DeletedKey page par dans le coffre de clés et, pour chaque clé supprimée, affiche son ID de récupération.
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
Listes DeletedKey du coffre de clés. Les DeletedKey sont récupérés en tant JsonWebKey que structures qui contiennent la partie publique d’un DeletedKey. L’opération obtenir les clés supprimées s’applique aux coffres activés pour la suppression réversible. Cette opération nécessite l’autorisation keys/list .
Exemples de code
Répertorie le DeletedKey dans le coffre de clés et pour chacun DeletedKey affiche son ID de récupération.
for (DeletedKey deletedKey : keyClient.listDeletedKeys(new Context("key1", "value1"))) {
System.out.printf("Deleted key's recovery id:%s%n", deletedKey.getRecoveryId());
}
Exemples de code pour itérer sur les clés supprimées par page
Itère sur la DeletedKey page par dans le coffre de clés et, pour chaque clé supprimée, affiche son ID de récupération.
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
Répertoriez toutes les versions du spécifié KeyVaultKey. La réponse de clé individuelle dans le flux est représentée par KeyProperties , car seuls l’identificateur de clé, les attributs et les balises sont fournis dans la réponse. Les valeurs matérielles clés ne sont pas fournies dans la réponse. Cette opération nécessite l’autorisation keys/list .
Il est possible d’obtenir KeyVaultKey avec le matériel clé pour chaque version à partir de ces informations. Effectuez une boucle sur et KeyProperties appelez getKey(String name, String version). Cela retourne le avec le KeyVaultKey matériel clé inclus des versions spécifiées.
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());
}
Exemples de code pour itérer sur les versions clés par page
Il est possible d’obtenir KeyVaultKey avec le matériel clé pour chaque version à partir de ces informations. Itérer sur l’ensemble de la KeyProperties page par et appeler getKey(String name, String version). Cela retourne le avec le KeyVaultKey matériel clé inclus des versions spécifiées.
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’existe pas dans le coffre de clés.listPropertiesOfKeyVersions
public PagedIterable
Répertoriez toutes les versions du spécifié KeyVaultKey. La réponse de clé individuelle dans le flux est représentée par KeyProperties , car seuls l’identificateur de clé, les attributs et les balises sont fournis dans la réponse. Les valeurs matérielles clés ne sont pas fournies dans la réponse. Cette opération nécessite l’autorisation keys/list .
Il est possible d’obtenir KeyVaultKey avec le matériel clé pour chaque version à partir de ces informations. Effectuez une boucle sur et KeyProperties appelez getKey(String name, String version). Cela retourne le avec le KeyVaultKey matériel clé inclus des versions spécifiées.
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());
}
Exemples de code pour itérer sur les versions clés par page
Il est possible d’obtenir KeyVaultKey avec le matériel clé pour chaque version à partir de ces informations. Itérer sur l’ensemble de la KeyProperties page par et appeler getKey(String name, String version). Cela retourne le avec le KeyVaultKey matériel clé inclus des versions spécifiées.
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’existe pas dans le coffre de clés.listPropertiesOfKeys
public PagedIterable
Liste KeyVaultKey dans le coffre de clés. Récupère une liste de dans le coffre de KeyVaultKey clés en tant JsonWebKey que structures qui contiennent la partie publique d’un stocké KeyVaultKey. L’opération de liste s’applique à tous KeyType et la réponse individuelle KeyVaultKey dans la liste est représentée par KeyProperties , car seuls l’identificateur de clé, les attributs et les balises sont fournis dans la réponse. Le matériel de clé et les versions de clé individuelles ne sont pas répertoriés dans la réponse. Cette opération nécessite l’autorisation keys/list .
Exemples de code
Il est possible d’obtenir KeyVaultKey des informations clés à partir de ces informations. Effectuez une boucle sur et KeyProperties appelez getKey(String name, String version). Cela retourne le avec le KeyVaultKey matériel de clé inclus à partir de sa dernière version.
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());
}
Itérer les clés par page
Il est possible d’obtenir KeyVaultKey des informations clés à partir de ces informations. Itérer sur l’ensemble de la KeyProperties page par et appeler getKey(String name, String version). Cela retourne le avec le KeyVaultKey matériel de clé inclus à partir de sa dernière version.
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
Liste KeyVaultKey dans le coffre de clés. Récupère une liste de dans le coffre de KeyVaultKey clés en tant JsonWebKey que structures qui contiennent la partie publique d’un stocké KeyVaultKey. L’opération de liste s’applique à tous KeyType et la réponse individuelle KeyVaultKey dans la liste est représentée par KeyProperties , car seuls l’identificateur de clé, les attributs et les balises sont fournis dans la réponse. Le matériel de clé et les versions de clé individuelles ne sont pas répertoriés dans la réponse. Cette opération nécessite l’autorisation keys/list .
Exemples de code
Il est possible d’obtenir KeyVaultKey des informations clés à partir de ces informations. Effectuez une boucle sur et KeyProperties appelez getKey(String name, String version). Cela retourne le avec le KeyVaultKey matériel de clé inclus à partir de sa dernière version.
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());
}
Itérer par page
Il est possible d’obtenir KeyVaultKey des informations clés à partir de ces informations. Itérer sur l’ensemble de la KeyProperties page par et appeler getKey(String name, String version). Cela retourne le avec le KeyVaultKey matériel de clé inclus à partir de sa dernière version.
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)
Supprime définitivement le spécifié KeyVaultKey sans possibilité de récupération. L’opération d’vidage de clé supprimée s’applique aux coffres avec suppression réversible. Cette opération nécessite l’autorisation keys/purge .
Exemples de code
Purge le KeyVaultKey du coffre de clés activé pour la suppression réversible.
keyClient.purgeDeletedKey("deletedKeyName");
Parameters:
purgeDeletedKeyWithResponse
public Response
Supprime définitivement le spécifié KeyVaultKey sans possibilité de récupération. L’opération d’vidage de clé supprimée s’applique aux coffres avec suppression réversible. Cette opération nécessite l’autorisation keys/purge .
Exemples de code
Purge le KeyVaultKey du coffre de clés activé pour la suppression réversible.
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)
Publie la dernière version d’un KeyVaultKey.
Doit KeyVaultKey être exportable. Cette opération nécessite l’autorisation keys/release .
Exemples de code
Libère un KeyVaultKey. Imprime l’objet signé qui contient la clé de mise en production.
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)
Libère une version spécifique d’un KeyVaultKey.
Doit KeyVaultKey être exportable. Cette opération nécessite l’autorisation keys/release .
Exemples de code
Libère un KeyVaultKey. Imprime l’objet signé qui contient la clé de mise en production.
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, cet appel équivaut à appeler releaseKey(String name, String targetAttestationToken), la dernière version de clé étant publiée.
Returns:
releaseKeyWithResponse
public Response
Libère un KeyVaultKey.
La clé doit être exportable. Cette opération nécessite l’autorisation keys/release .
Exemples de code
Libère un KeyVaultKey. Imprime les détails et l’objet Response<T> signé qui contient la clé de publication.
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, cet appel équivaut à appeler releaseKey(String name, String targetAttestationToken), la dernière version de clé étant publiée.
Returns:
restoreKeyBackup
public KeyVaultKey restoreKeyBackup(byte[] backup)
Restaure un sauvegardé dans KeyVaultKey un coffre. Importe un précédemment sauvegardé KeyVaultKey dans Azure Key Vault, en restaurant l’identificateur KeyVaultKeyde clé, les attributs et les stratégies de contrôle d’accès. L’opération de restauration peut être utilisée pour importer un précédemment sauvegardé KeyVaultKey. Les versions individuelles d’un KeyVaultKey ne peuvent pas être restaurées. le KeyVaultKey est restauré dans son intégralité avec le même nom de clé que lors de sa sauvegarde. Si le nom de la clé n’est pas disponible dans le coffre de clés cible, l’opération de restauration est rejetée. Tant que le nom de la clé est conservé pendant la restauration, l’identificateur de clé final est modifié si le KeyVaultKey est restauré dans un autre coffre. La restauration restaure toutes les versions et conserve les identificateurs de version. L’opération de restauration est soumise à des contraintes de sécurité : le coffre de clés cible doit appartenir au même abonnement Microsoft Azure que le coffre de clés source. L’utilisateur doit disposer de l’autorisation restore dans le coffre de clés cible. Cette opération nécessite l’autorisation keys/restore .
Exemples de code
Restaure le KeyVaultKey dans le coffre de clés à partir de sa sauvegarde.
Passez le tableau d’octets de sauvegarde de clé à l’opération de restauration.
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
Restaure un sauvegardé dans KeyVaultKey un coffre. Importe un précédemment sauvegardé KeyVaultKey dans Azure Key Vault, en restaurant l’identificateur KeyVaultKeyde clé, les attributs et les stratégies de contrôle d’accès. L’opération de restauration peut être utilisée pour importer un précédemment sauvegardé KeyVaultKey. Les versions individuelles d’un KeyVaultKey ne peuvent pas être restaurées. le KeyVaultKey est restauré dans son intégralité avec le même nom de clé que lors de sa sauvegarde. Si le nom de la clé n’est pas disponible dans le coffre de clés cible, l’opération de restauration est rejetée. Tant que le nom de la clé est conservé pendant la restauration, l’identificateur de clé final est modifié si le KeyVaultKey est restauré dans un autre coffre. La restauration restaure toutes les versions et conserve les identificateurs de version. L’opération de restauration est soumise à des contraintes de sécurité : le coffre de clés cible doit appartenir au même abonnement Microsoft Azure que le coffre de clés source. L’utilisateur doit disposer de l’autorisation restore dans le coffre de clés cible. Cette opération nécessite l’autorisation keys/restore .
Exemples de code
Restaure le KeyVaultKey dans le coffre de clés à partir de sa sauvegarde. Imprime les détails du KeyVaultKey retourné dans .Response<T>
Passez le tableau d’octets de sauvegarde de clé à l’opération de restauration.
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)
Fait pivoter un KeyVaultKey. L’opération de rotation de la clé le fait en fonction de KeyRotationPolicy. Cette opération nécessite l’autorisation keys/rotate .
Exemples de code
Fait pivoter un KeyVaultKey. Imprime les KeyVaultKey détails.
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
Fait pivoter un KeyVaultKey. L’opération de rotation de la clé le fait en fonction de KeyRotationPolicy. Cette opération nécessite l’autorisation keys/rotate .
Exemples de code
Fait pivoter un KeyVaultKey. Imprime les détails et Response<T>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)
Mises à jour le KeyProperties et KeyOperation associé au spécifié KeyVaultKey, mais pas le matériel de clé de chiffrement du spécifié KeyVaultKey dans le coffre de clés. Les modifications de l’opération de mise à jour spécifiées KeyProperties d’un stockage KeyVaultKey existant et KeyProperties qui ne sont pas spécifiées dans la requête restent inchangées. La clé de chiffrement d’un KeyVaultKey lui-même ne peut pas être modifiée. Cette opération nécessite l’autorisation keys/set .
Exemples de code
Obtient la dernière version du KeyVaultKey, modifie son heure d’expiration et KeyOperation les mises à jour dans KeyVaultKey le coffre de clés.
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
Mises à jour le KeyProperties et KeyOperation associé au spécifié KeyVaultKey, mais pas le matériel de clé de chiffrement du spécifié KeyVaultKey dans le coffre de clés. Les modifications de l’opération de mise à jour spécifiées KeyProperties d’un stockage KeyVaultKey existant et KeyProperties qui ne sont pas spécifiées dans la requête restent inchangées. La clé de chiffrement d’un KeyVaultKey lui-même ne peut pas être modifiée. Cette opération nécessite l’autorisation keys/set .
Exemples de code
Obtient la dernière version du KeyVaultKey, modifie son heure d’expiration et KeyOperation les mises à jour dans KeyVaultKey le coffre de clés.
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)
Mises à jour le KeyRotationPolicy du KeyVaultKey avec le nom fourni. Cette opération nécessite l’autorisation keys/update .
Exemples de code
Mises à jour le KeyRotationPolicy d’un donné KeyVaultKey. Imprime les KeyRotationPolicy détails.
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
Mises à jour le KeyRotationPolicy de la clé avec le nom fourni. Cette opération nécessite l’autorisation keys/update .
Exemples de code
Mises à jour le KeyRotationPolicy d’un donné KeyVaultKey. Imprime les détails et Response<T>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:
S’applique à
Azure SDK for Java