Partager via


KeyAsyncClient Classe

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

public final class KeyAsyncClient

Fournit KeyAsyncClient des méthodes asynchrones à gérer KeyVaultKey dans azure Key Vault. Le client prend en charge la création, la récupération, la mise à jour, la suppression, le vidage, la sauvegarde, la restauration, la liste, la publication et la rotation du KeyVaultKey. Le client prend également en charge la liste DeletedKey d’un coffre de clés avec suppression réversible.

Mise en route

Pour interagir avec le service Azure Key Vault, vous devez créer un instance de la KeyAsyncClient 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é asynchrone

L’exemple de code suivant illustre la création d’un KeyAsyncClient, à l’aide de pour le KeyClientBuilder configurer.

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

Créer une clé de chiffrement

Peut KeyAsyncClient ê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 asynchrone une clé de chiffrement dans le coffre de clés, à l’aide de l’API createKey(String name, KeyType keyType) .

keyAsyncClient.createKey("keyName", KeyType.EC)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(key ->
         System.out.printf("Created key with name: %s and id: %s %n", key.getName(),
             key.getId()));

Note: Pour l’exemple synchrone, reportez-vous à KeyClient.


Obtenir une clé de chiffrement

Peut KeyAsyncClient ê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 asynchrone une clé à partir du coffre de clés, à l’aide de l’API getKey(String name) .

keyAsyncClient.getKey("keyName")
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(key ->
         System.out.printf("Created key with name: %s and: id %s%n", key.getName(),
             key.getId()));

Note: Pour l’exemple synchrone, reportez-vous à KeyClient.


Supprimer une clé de chiffrement

Peut KeyAsyncClient ê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 asynchrone une clé du coffre de clés à l’aide de l’API beginDeleteKey(String name) .

keyAsyncClient.beginDeleteKey("keyName")
     .subscribe(pollResponse -> {
         System.out.printf("Deletion status: %s%n", pollResponse.getStatus());
         System.out.printf("Key name: %s%n", pollResponse.getValue().getName());
         System.out.printf("Key delete date: %s%n", pollResponse.getValue().getDeletedOn());
     });

Note: Pour l’exemple synchrone, reportez-vous à KeyClient.

Résumé de la méthode

Modificateur et type Méthode et description
Mono<byte[]> backupKey(String name)

Demande qu’une sauvegarde du spécifié KeyVaultKey soit téléchargée sur le client.

Mono<Response<byte[]>> backupKeyWithResponse(String name)

Demande qu’une sauvegarde du spécifié KeyVaultKey soit téléchargée sur le client.

PollerFlux<DeletedKey,Void> beginDeleteKey(String name)

Supprime un KeyVaultKey de n’importe quel type du coffre de clés.

PollerFlux<KeyVaultKey,Void> beginRecoverDeletedKey(String name)

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.

Mono<KeyVaultKey> createEcKey(CreateEcKeyOptions createEcKeyOptions)

Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés.

Mono<Response<KeyVaultKey>> createEcKeyWithResponse(CreateEcKeyOptions createEcKeyOptions)

Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés.

Mono<KeyVaultKey> createKey(CreateKeyOptions createKeyOptions)

Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés.

Mono<KeyVaultKey> createKey(String name, KeyType keyType)

Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés.

Mono<Response<KeyVaultKey>> createKeyWithResponse(CreateKeyOptions createKeyOptions)

Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés.

Mono<KeyVaultKey> createOctKey(CreateOctKeyOptions createOctKeyOptions)

Crée et stocke un nouveau KeyVaultKey dans le coffre de clés.

Mono<Response<KeyVaultKey>> createOctKeyWithResponse(CreateOctKeyOptions createOctKeyOptions)

Crée et stocke un nouveau KeyVaultKey dans le coffre de clés.

Mono<KeyVaultKey> createRsaKey(CreateRsaKeyOptions createRsaKeyOptions)

/** Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés.

Mono<Response<KeyVaultKey>> createRsaKeyWithResponse(CreateRsaKeyOptions createRsaKeyOptions)

Crée un nouveau KeyVaultKey et le stocke dans le coffre de clés.

CryptographyAsyncClient getCryptographyAsyncClient(String keyName)

Crée un CryptographyAsyncClient pour la dernière version d’une clé donnée.

CryptographyAsyncClient getCryptographyAsyncClient(String keyName, String keyVersion)

Crée un CryptographyAsyncClient pour une version de clé donnée.

Mono<DeletedKey> getDeletedKey(String name)

Obtient la partie publique d’un KeyVaultKey.

Mono<Response<DeletedKey>> getDeletedKeyWithResponse(String name)

Obtient la partie publique d’un KeyVaultKey.

Mono<KeyVaultKey> getKey(String name)

Obtient la partie publique de la version et de la clé spécifiées KeyVaultKey .

Mono<KeyVaultKey> getKey(String name, String version)

Obtient la partie publique de la version et de la clé spécifiées KeyVaultKey .

Mono<KeyRotationPolicy> getKeyRotationPolicy(String keyName)

Obtient le KeyRotationPolicy pour le KeyVaultKey avec le nom fourni.

Mono<Response<KeyRotationPolicy>> getKeyRotationPolicyWithResponse(String keyName)

Obtient le KeyRotationPolicy pour le KeyVaultKey avec le nom fourni.

Mono<Response<KeyVaultKey>> getKeyWithResponse(String name, String version)

Obtient la partie publique de la version et de la clé spécifiées KeyVaultKey .

Mono<byte[]> getRandomBytes(int count)

Obtenez le nombre d’octets demandé contenant des valeurs aléatoires à partir d’un HSM managé.

Mono<Response<byte[]>> getRandomBytesWithResponse(int count)

Obtenez le nombre d’octets demandé contenant des valeurs aléatoires à partir d’un HSM managé.

String getVaultUrl()

Obtenez l’URL du point de terminaison de coffre à laquelle les demandes de service sont envoyées.

Mono<KeyVaultKey> importKey(ImportKeyOptions importKeyOptions)

Importe un créé JsonWebKey en externe et le stocke dans le coffre de clés.

Mono<KeyVaultKey> importKey(String name, JsonWebKey keyMaterial)

Importe un créé JsonWebKey en externe et le stocke dans le coffre de clés.

Mono<Response<KeyVaultKey>> importKeyWithResponse(ImportKeyOptions importKeyOptions)

Importe un créé JsonWebKey en externe et le stocke dans le coffre de clés.

PagedFlux<DeletedKey> listDeletedKeys()

Listes DeletedKey du coffre de clés.

PagedFlux<KeyProperties> listPropertiesOfKeyVersions(String name)

Répertoriez toutes les versions du spécifié KeyVaultKey.

PagedFlux<KeyProperties> listPropertiesOfKeys()

Liste KeyVaultKey dans le coffre de clés.

Mono<Void> purgeDeletedKey(String name)

Supprime définitivement le spécifié KeyVaultKey sans possibilité de récupération.

Mono<Response<Void>> purgeDeletedKeyWithResponse(String name)

Supprime définitivement le spécifié KeyVaultKey sans possibilité de récupération.

Mono<ReleaseKeyResult> releaseKey(String name, String targetAttestationToken)

Publie la dernière version d’un KeyVaultKey.

Mono<ReleaseKeyResult> releaseKey(String name, String version, String targetAttestationToken)

Libère une clé.

Mono<Response<ReleaseKeyResult>> releaseKeyWithResponse(String name, String version, String targetAttestationToken, ReleaseKeyOptions releaseKeyOptions)

Libère une clé.

Mono<KeyVaultKey> restoreKeyBackup(byte[] backup)

Restaure un sauvegardé dans KeyVaultKey un coffre.

Mono<Response<KeyVaultKey>> restoreKeyBackupWithResponse(byte[] backup)

Restaure un sauvegardé dans KeyVaultKey un coffre.

Mono<KeyVaultKey> rotateKey(String name)

Fait pivoter un KeyVaultKey.

Mono<Response<KeyVaultKey>> rotateKeyWithResponse(String name)

Fait pivoter un KeyVaultKey.

Mono<KeyVaultKey> updateKeyProperties(KeyProperties keyProperties, KeyOperation[] keyOperations)

Mises à jour le KeyProperties et KeyOperation associé au spécifié, KeyVaultKeymais pas le matériel de clé de chiffrement du spécifié KeyVaultKey dans le coffre de clés.

Mono<Response<KeyVaultKey>> updateKeyPropertiesWithResponse(KeyProperties keyProperties, KeyOperation[] keyOperations)

Mises à jour le KeyProperties et KeyOperation associé au spécifié, KeyVaultKeymais pas le matériel de clé de chiffrement du spécifié KeyVaultKey dans le coffre de clés.

Mono<KeyRotationPolicy> updateKeyRotationPolicy(String keyName, KeyRotationPolicy keyRotationPolicy)

Mises à jour le KeyRotationPolicy de la clé avec le nom fourni.

Mono<Response<KeyRotationPolicy>> updateKeyRotationPolicyWithResponse(String keyName, KeyRotationPolicy keyRotationPolicy)

Mises à jour le KeyRotationPolicy de la clé avec le nom fourni.

Méthodes héritées de java.lang.Object

Détails de la méthode

backupKey

public Mono 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. S’abonne à l’appel de façon asynchrone et imprime la longueur du tableau d’octets de sauvegarde de la clé retourné dans la réponse.

keyAsyncClient.backupKey("keyName")
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(bytes ->
         System.out.printf("Key backup byte array length: %s%n", bytes.length));

Parameters:

name - Nom de l'objet KeyVaultKey.

Returns:

Mono contenant l’objet blob de clé sauvegardé.

backupKeyWithResponse

public Mono> backupKeyWithResponse(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. S’abonne à l’appel de façon asynchrone et imprime la longueur du tableau d’octets de sauvegarde de la clé retourné dans la réponse.

keyAsyncClient.backupKeyWithResponse("keyName")
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(backupKeyResponse ->
         System.out.printf("Key backup byte array length: %s%n", backupKeyResponse.getValue().length));

Parameters:

name - Nom de l'objet KeyVaultKey.

Returns:

Mono contenant un Response<T> dont value contient l’objet blob de clé sauvegardé.

beginDeleteKey

public PollerFlux beginDeleteKey(String name)

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 dans le KeyVaultKey Key Vault Azure. S’abonne à l’appel de façon asynchrone et imprime les KeyVaultKey détails lorsqu’une réponse a été reçue.

keyAsyncClient.beginDeleteKey("keyName")
     .subscribe(pollResponse -> {
         System.out.printf("Deletion status: %s%n", pollResponse.getStatus());
         System.out.printf("Key name: %s%n", pollResponse.getValue().getName());
         System.out.printf("Key delete date: %s%n", pollResponse.getValue().getDeletedOn());
     });

Parameters:

name - Nom du KeyVaultKey à supprimer.

Returns:

PollerFlux<T,U> pour sondage sur le DeletedKey status.

beginRecoverDeletedKey

public PollerFlux beginRecoverDeletedKey(String name)

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. S’abonne à l’appel de façon asynchrone et imprime les détails de la clé récupérée lorsqu’une réponse a été reçue.

keyAsyncClient.beginRecoverDeletedKey("deletedKeyName")
     .subscribe(pollResponse -> {
         System.out.printf("Recovery status: %s%n", pollResponse.getStatus());
         System.out.printf("Key name: %s%n", pollResponse.getValue().getName());
         System.out.printf("Key type: %s%n", pollResponse.getValue().getKeyType());
     });

Parameters:

name - Nom du KeyVaultKey à récupérer.

Returns:

PollerFlux<T,U> pour sondage sur le KeyVaultKey status.

createEcKey

public Mono 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. S’abonne à l’appel de façon asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

CreateEcKeyOptions createEcKeyOptions = new CreateEcKeyOptions("keyName")
     .setCurveName(KeyCurveName.P_384)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));

 keyAsyncClient.createEcKey(createEcKeyOptions)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(ecKey ->
         System.out.printf("Created key with name: %s and id: %s %n", ecKey.getName(),
             ecKey.getId()));

Parameters:

createEcKeyOptions - CreateEcKeyOptions contenant des informations sur le KeyVaultKey en cours de création.

Returns:

contenant Mono .KeyVaultKey

createEcKeyWithResponse

public Mono> createEcKeyWithResponse(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. S’abonne à l’appel de façon asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

CreateEcKeyOptions createEcKeyOptions = new CreateEcKeyOptions("keyName")
     .setCurveName(KeyCurveName.P_384)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));

 keyAsyncClient.createEcKeyWithResponse(createEcKeyOptions)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(createEcKeyResponse ->
         System.out.printf("Created key with name: %s and: id %s%n", createEcKeyResponse.getValue().getName(),
             createEcKeyResponse.getValue().getId()));

Parameters:

createEcKeyOptions - CreateEcKeyOptions contenant des informations sur le KeyVaultKey en cours de création.

Returns:

Mono contenant un Response<T> dont value contient .KeyVaultKey

createKey

public Mono 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 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. S’abonne à l’appel de manière asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

CreateKeyOptions createKeyOptions = new CreateKeyOptions("keyName", KeyType.RSA)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));

 keyAsyncClient.createKey(createKeyOptions)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(key ->
         System.out.printf("Created key with name: %s and id: %s %n", key.getName(),
             key.getId()));

Parameters:

createKeyOptions - CreateKeyOptions contenant des informations sur le KeyVaultKey en cours de création.

Returns:

Mono contenant .KeyVaultKey

createKey

public Mono 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. S’abonne à l’appel de manière asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

keyAsyncClient.createKey("keyName", KeyType.EC)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(key ->
         System.out.printf("Created key with name: %s and id: %s %n", key.getName(),
             key.getId()));

Parameters:

name - Nom du KeyVaultKey en cours de création.
keyType - Type de KeyVaultKey à créer. Pour connaître les valeurs valides, consultez KeyType.

Returns:

Mono contenant .KeyVaultKey

createKeyWithResponse

public Mono> createKeyWithResponse(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 .

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. S’abonne à l’appel de manière asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

CreateKeyOptions createKeyOptions = new CreateKeyOptions("keyName", KeyType.RSA)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));

 keyAsyncClient.createKeyWithResponse(createKeyOptions)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(createKeyResponse ->
         System.out.printf("Created key with name: %s and: id %s%n", createKeyResponse.getValue().getName(),
             createKeyResponse.getValue().getId()));

Parameters:

createKeyOptions - CreateKeyOptions contenant des informations sur le KeyVaultKey en cours de création.

Returns:

Mono contenant un Response<T> dont value contient .KeyVaultKey

createOctKey

public Mono 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. S’abonne à l’appel de manière asynchrone et imprime les détails du nouveau KeyVaultKey quand une réponse a été reçue.

CreateOctKeyOptions createOctKeyOptions = new CreateOctKeyOptions("keyName")
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));

 keyAsyncClient.createOctKey(createOctKeyOptions)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(octKey ->
         System.out.printf("Created key with name: %s and id: %s %n", octKey.getName(),
             octKey.getId()));

Parameters:

createOctKeyOptions - CreateOctKeyOptions contenant des informations sur le KeyVaultKey en cours de création.

Returns:

Mono contenant .KeyVaultKey

createOctKeyWithResponse

public Mono> createOctKeyWithResponse(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. S’abonne à l’appel de manière asynchrone et imprime les détails du nouveau KeyVaultKey quand une réponse a été reçue.

CreateOctKeyOptions createOctKeyOptions = new CreateOctKeyOptions("keyName")
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));

 keyAsyncClient.createOctKeyWithResponse(createOctKeyOptions)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(createOctKeyResponse ->
         System.out.printf("Created key with name: %s and: id %s%n", createOctKeyResponse.getValue().getName(),
             createOctKeyResponse.getValue().getId()));

Parameters:

createOctKeyOptions - CreateOctKeyOptions contenant des informations sur le KeyVaultKey en cours de création.

Returns:

Mono contenant un Response<T> dont value contient .KeyVaultKey

createRsaKey

public Mono 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. S’abonne à l’appel de manière asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

CreateRsaKeyOptions createRsaKeyOptions = new CreateRsaKeyOptions("keyName")
     .setKeySize(2048)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));

 keyAsyncClient.createRsaKey(createRsaKeyOptions)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(rsaKey ->
         System.out.printf("Created key with name: %s and id: %s %n", rsaKey.getName(),
             rsaKey.getId()));

Parameters:

createRsaKeyOptions - CreateRsaKeyOptions contenant des informations sur le KeyVaultKey en cours de création.

Returns:

Mono contenant .KeyVaultKey

createRsaKeyWithResponse

public Mono> createRsaKeyWithResponse(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. S’abonne à l’appel de façon asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

CreateRsaKeyOptions createRsaKeyOptions = new CreateRsaKeyOptions("keyName")
     .setKeySize(2048)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));

 keyAsyncClient.createRsaKeyWithResponse(createRsaKeyOptions)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(createRsaKeyResponse ->
         System.out.printf("Created key with name: %s and: id %s%n", createRsaKeyResponse.getValue().getName(),
             createRsaKeyResponse.getValue().getId()));

Parameters:

createRsaKeyOptions - CreateRsaKeyOptions contenant des informations sur le KeyVaultKey en cours de création.

Returns:

Mono contenant un Response<T> dont value contient le KeyVaultKey.

getCryptographyAsyncClient

public CryptographyAsyncClient getCryptographyAsyncClient(String keyName)

Crée un CryptographyAsyncClient 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 CryptographyAsyncClient 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 getCryptographyAsyncClient(String keyName, String keyVersion) ou en vous assurant qu’elle est incluse dans le keyIdentifier passé à keyIdentifier(String keyId) avant de créer un client.

Parameters:

keyName - Nom de la clé.

Returns:

Un instance de CryptographyAsyncClient associé à la dernière version d’une clé avec le nom fourni.

getCryptographyAsyncClient

public CryptographyAsyncClient getCryptographyAsyncClient(String keyName, String keyVersion)

Crée un CryptographyAsyncClient pour une version de clé donnée.

Parameters:

keyName - Nom de la clé.
keyVersion - Version de la clé.

Returns:

Une instance de CryptographyAsyncClient associée à une clé avec le nom et la version fournis. Si keyVersion est null ou vide, le client utilise la dernière version de la clé.

getDeletedKey

public Mono getDeletedKey(String name)

Obtient la partie publique d’un KeyVaultKey. L’opération obtenir la clé supprimée s’applique aux coffres activés pour la 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. S’abonne à l’appel de façon asynchrone et imprime les KeyVaultKey détails lorsqu’une réponse a été reçue.

keyAsyncClient.getDeletedKey("keyName")
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(deletedKey ->
         System.out.printf("Deleted key's recovery id:%s%n", deletedKey.getRecoveryId()));

Parameters:

name - Nom de l’objet supprimé KeyVaultKey.

Returns:

contenant Mono .DeletedKey

getDeletedKeyWithResponse

public Mono> getDeletedKeyWithResponse(String name)

Obtient la partie publique d’un KeyVaultKey. L’opération obtenir la clé supprimée s’applique aux coffres activés pour la 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. S’abonne à l’appel de façon asynchrone et imprime les KeyVaultKey détails lorsqu’une réponse a été reçue.

keyAsyncClient.getDeletedKeyWithResponse("keyName")
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(getDeletedKeyResponse ->
         System.out.printf("Deleted key's recovery id: %s%n", getDeletedKeyResponse.getValue().getRecoveryId()));

Parameters:

name - Nom de l’objet supprimé KeyVaultKey.

Returns:

Mono contenant un Response<T> dont value contient le DeletedKey.

getKey

public Mono getKey(String name)

Obtient la partie publique de la version et de la clé spécifiées KeyVaultKey . L’opération d’obtention de clé s’applique à tous KeyType et nécessite l’autorisation keys/get .

Exemples de code

Obtient une version spécifique du KeyVaultKey dans le coffre de clés. S’abonne à l’appel de façon asynchrone et imprime les KeyVaultKey détails lorsqu’une réponse a été reçue.

keyAsyncClient.getKey("keyName")
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(key ->
         System.out.printf("Created key with name: %s and: id %s%n", key.getName(),
             key.getId()));

Parameters:

name - Le nom du KeyVaultKey, ne peut pas être null.

Returns:

Mono contenant le demandéKeyVaultKey. Le contenu de la clé est null si name est null ou vide.

getKey

public Mono getKey(String name, String version)

Obtient la partie publique de la version et de la clé spécifiées KeyVaultKey . L’opération d’obtention de clé s’applique à tous KeyType et nécessite l’autorisation keys/get .

Exemples de code

Obtient une version spécifique du KeyVaultKey dans le coffre de clés. S’abonne à l’appel de façon asynchrone et imprime les KeyVaultKey détails lorsqu’une réponse a été reçue.

String keyVersion = "6A385B124DEF4096AF1361A85B16C204";

 keyAsyncClient.getKey("keyName", keyVersion)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(key ->
         System.out.printf("Created key with name: %s and: id %s%n", key.getName(),
             key.getId()));

Parameters:

name - Le nom du KeyVaultKey, ne peut pas être null.
version - Version de la clé à récupérer. S’il s’agit d’une chaîne vide ou null, cet appel équivaut à appeler getKey(String name), avec la dernière version récupérée.

Returns:

Mono contenant le demandéKeyVaultKey. Le contenu de la clé est null si et nameversion sont ou vides null .

getKeyRotationPolicy

public Mono getKeyRotationPolicy(String keyName)

Obtient le KeyRotationPolicy pour le KeyVaultKey avec le nom fourni. Cette opération nécessite l’autorisation keys/get .

Exemples de code

Récupère le KeyRotationPolicy d’un donné KeyVaultKey. S’abonne à l’appel de façon asynchrone et imprime les KeyRotationPolicy détails lorsqu’une réponse a été reçue.

keyAsyncClient.getKeyRotationPolicy("keyName")
     .subscribe(keyRotationPolicy ->
         System.out.printf("Retrieved key rotation policy with id: %s%n", keyRotationPolicy.getId()));

Parameters:

keyName - Nom de l'objet KeyVaultKey.

Returns:

Mono contenant le KeyRotationPolicy pour la clé.

getKeyRotationPolicyWithResponse

public Mono> getKeyRotationPolicyWithResponse(String keyName)

Obtient le KeyRotationPolicy pour le KeyVaultKey avec le nom fourni. Cette opération nécessite l’autorisation keys/get .

Exemples de code

Récupère le KeyRotationPolicy d’un donné KeyVaultKey. S’abonne à l’appel de façon asynchrone et imprime les Response<T> détails et KeyRotationPolicy lorsqu’une réponse a été reçue.

keyAsyncClient.getKeyRotationPolicyWithResponse("keyName")
     .subscribe(getKeyRotationPolicyResponse ->
         System.out.printf("Response received successfully with status code: %d. Retrieved key rotation policy"
             + "with id: %s%n", getKeyRotationPolicyResponse.getStatusCode(),
             getKeyRotationPolicyResponse.getValue().getId()));

Parameters:

keyName - Nom de l'objet KeyVaultKey.

Returns:

Mono contenant le Response<T> pour cette opération et le KeyRotationPolicy pour la clé.

getKeyWithResponse

public Mono> getKeyWithResponse(String name, String version)

Obtient la partie publique de la version et de la clé spécifiées KeyVaultKey . L’opération d’obtention de clé s’applique à tous KeyType et nécessite l’autorisation keys/get .

Exemples de code

Obtient une version spécifique du KeyVaultKey dans le coffre de clés. S’abonne à l’appel de façon asynchrone et imprime les KeyVaultKey détails lorsqu’une réponse a été reçue.

String keyVersion = "6A385B124DEF4096AF1361A85B16C204";

 keyAsyncClient.getKeyWithResponse("keyName", keyVersion)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(getKeyResponse ->
         System.out.printf("Created key with name: %s and: id %s%n",
             getKeyResponse.getValue().getName(), getKeyResponse.getValue().getId()));

Parameters:

name - Le nom du KeyVaultKey, ne peut pas être null.
version - Version de la clé à récupérer. S’il s’agit d’une chaîne vide ou null, cet appel équivaut à appeler getKey(String name), avec la dernière version récupérée.

Returns:

Mono contenant un Response<T> dont value contient le demandéKeyVaultKey. Le contenu de la clé est null si et nameversion sont ou vides null .

getRandomBytes

public Mono 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 à partir d’un HSM managé. Imprime les octets récupérés au format base64Url.

int amount = 16;
 keyAsyncClient.getRandomBytes(amount)
     .subscribe(randomBytes ->
         System.out.printf("Retrieved %d random bytes: %s%n", amount, Arrays.toString(randomBytes)));

Parameters:

count - Nombre d’octets aléatoires demandé.

Returns:

Mono contenant le nombre d’octets demandé contenant des valeurs aléatoires d’un HSM managé.

getRandomBytesWithResponse

public Mono> getRandomBytesWithResponse(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 à partir d’un HSM managé. Imprime les Response<T> détails et les octets récupérés au format base64Url.

int amountOfBytes = 16;
 keyAsyncClient.getRandomBytesWithResponse(amountOfBytes).subscribe(response ->
     System.out.printf("Response received successfully with status code: %d. Retrieved %d random bytes: %s%n",
         response.getStatusCode(), amountOfBytes, Arrays.toString(response.getValue())));

Parameters:

count - Nombre d’octets aléatoires demandé.

Returns:

Mono contenant le Response<T> pour cette opération et le nombre d’octets demandé contenant des valeurs aléatoires d’un HSM managé.

getVaultUrl

public String getVaultUrl()

Obtenez l’URL du point de terminaison de coffre à laquelle les demandes de service sont envoyées.

Returns:

URL du point de terminaison du coffre

importKey

public Mono 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. S’abonne à l’appel de manière asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

ImportKeyOptions options = new ImportKeyOptions("keyName", jsonWebKeyToImport)
     .setHardwareProtected(false);

 keyAsyncClient.importKey(options).subscribe(keyVaultKey ->
     System.out.printf("Imported key with name: %s and id: %s%n", keyVaultKey.getName(), keyVaultKey.getId()));

Parameters:

importKeyOptions - ImportKeyOptions contenant des informations sur le JsonWebKey en cours d’importation.

Returns:

Mono contenant .KeyVaultKey

importKey

public Mono 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. S’abonne à l’appel de manière asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

keyAsyncClient.importKey("keyName", jsonWebKeyToImport)
     .subscribe(keyVaultKey ->
         System.out.printf("Imported key with name: %s and id: %s%n", keyVaultKey.getName(),
             keyVaultKey.getId()));

Parameters:

name - Nom de la clé importée.
keyMaterial - Clé web Json importée.

Returns:

Mono contenant un Response<T> dont value contient .KeyVaultKey

importKeyWithResponse

public Mono> importKeyWithResponse(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. S’abonne à l’appel de manière asynchrone et imprime les nouveaux KeyVaultKey détails lorsqu’une réponse a été reçue.

ImportKeyOptions importKeyOptions = new ImportKeyOptions("keyName", jsonWebKeyToImport)
     .setHardwareProtected(false);

 keyAsyncClient.importKeyWithResponse(importKeyOptions).subscribe(response ->
     System.out.printf("Imported key with name: %s and id: %s%n", response.getValue().getName(),
         response.getValue().getId()));

Parameters:

importKeyOptions - ImportKeyOptions contenant des informations sur le JsonWebKey en cours d’importation.

Returns:

Mono contenant un Response<T> dont value contient .KeyVaultKey

listDeletedKeys

public PagedFlux listDeletedKeys()

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. S’abonne à l’appel de manière asynchrone et imprime l’ID de récupération de chaque DeletedKey fois qu’une réponse a été reçue.

keyAsyncClient.listDeletedKeys()
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(deletedKey ->
         System.out.printf("Deleted key's recovery id:%s%n", deletedKey.getRecoveryId()));

Returns:

PagedFlux<T> contenant tous les DeletedKey éléments dans le coffre.

listPropertiesOfKeyVersions

public PagedFlux listPropertiesOfKeyVersions(String name)

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 .

Exemples de code

Il est possible d’obtenir les clés avec le matériel clé de toutes les versions à partir de ces informations. Convertissez le Flux contenant en KeyProperties contenant en FluxKeyVaultKey utilisant getKey(String name, String version) dans Flux#flatMap(Function).

keyAsyncClient.listPropertiesOfKeyVersions("keyName")
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .flatMap(keyProperties -> keyAsyncClient.getKey(keyProperties.getName(), keyProperties.getVersion()))
     .subscribe(key ->
         System.out.printf("Retrieved key version: %s with name: %s and type: %s%n",
             key.getProperties().getVersion(), key.getName(), key.getKeyType()));

Parameters:

name - Nom de l'objet KeyVaultKey.

Returns:

PagedFlux<T> contenant KeyProperties toutes les versions du spécifié KeyVaultKey dans le coffre. Flux est vide si la clé avec name n’existe pas dans le coffre de clés.

listPropertiesOfKeys

public PagedFlux listPropertiesOfKeys()

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. Convertissez le Flux contenant en KeyProperties contenant en FluxKeyVaultKey utilisant getKey(String name, String version) dans Flux#flatMap(Function).

keyAsyncClient.listPropertiesOfKeys()
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .flatMap(keyProperties -> keyAsyncClient.getKey(keyProperties.getName(), keyProperties.getVersion()))
     .subscribe(key -> System.out.printf("Retrieved key with name: %s and type: %s%n",
         key.getName(),
         key.getKeyType()));

Returns:

PagedFlux<T> contenant KeyProperties toutes les clés du coffre.

purgeDeletedKey

public Mono 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. S’abonne à l’appel de manière asynchrone et imprime le code status à partir de la réponse du serveur lorsqu’une réponse a été reçue.

keyAsyncClient.purgeDeletedKey("deletedKeyName")
     .subscribe(ignored ->
         System.out.println("Successfully purged deleted key"));

Parameters:

name - Nom de l'objet KeyVaultKey.

Returns:

Mono vide.

purgeDeletedKeyWithResponse

public Mono> purgeDeletedKeyWithResponse(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. S’abonne à l’appel de manière asynchrone et imprime le code status à partir de la réponse du serveur lorsqu’une réponse a été reçue.

keyAsyncClient.purgeDeletedKeyWithResponse("deletedKeyName")
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(purgeDeletedKeyResponse ->
         System.out.printf("Purge response status code: %d%n", purgeDeletedKeyResponse.getStatusCode()));

Parameters:

name - Nom de l'objet KeyVaultKey.

Returns:

Mono contenant une réponse contenant du code status et des en-têtes HTTP.

releaseKey

public Mono 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. S’abonne à l’appel de manière asynchrone et imprime l’objet signé qui contient le KeyVaultKey lorsqu’une réponse a été reçue.

String targetAttestationToken = "someAttestationToken";
 ReleaseKeyResult releaseKeyResult = keyClient.releaseKey("keyName", targetAttestationToken);

 System.out.printf("Signed object containing released key: %s%n", releaseKeyResult);

Parameters:

name - Nom du KeyVaultKey à libérer.
targetAttestationToken - Assertion d’attestation pour la cible de la KeyVaultKey version.

Returns:

Mono contenant le ReleaseKeyResult contenant la clé libérée.

releaseKey

public Mono releaseKey(String name, String version, String targetAttestationToken)

Libère une clé.

La clé doit être exportable. Cette opération nécessite l’autorisation « keys/release ».

Exemples de code

Libère un KeyVaultKey. S’abonne à l’appel de façon asynchrone et imprime l’objet signé qui contient le KeyVaultKey lorsqu’une réponse a été reçue.

String myKeyVersion = "6A385B124DEF4096AF1361A85B16C204";
 String myTargetAttestationToken = "someAttestationToken";

 keyAsyncClient.releaseKey("keyName", myKeyVersion, myTargetAttestationToken)
     .subscribe(releaseKeyResult ->
         System.out.printf("Signed object containing released key: %s%n", releaseKeyResult.getValue()));

Parameters:

name - Nom du KeyVaultKey à libérer.
version - Version de la clé à récupérer. S’il est vide ou null, cet appel équivaut à appeler releaseKey(String name, String targetAttestationToken), avec la dernière version de clé publiée.
targetAttestationToken - Assertion d’attestation pour la cible de la mise en production de clé.

Returns:

Mono contenant le ReleaseKeyResult contenant la clé libérée.

releaseKeyWithResponse

public Mono> releaseKeyWithResponse(String name, String version, String targetAttestationToken, ReleaseKeyOptions releaseKeyOptions)

Libère une clé.

La clé doit être exportable. Cette opération nécessite l’autorisation « keys/release ».

Exemples de code

Libère un KeyVaultKey. S’abonne à l’appel de façon asynchrone et imprime les Response<T> détails et l’objet signé qui contient le KeyVaultKey quand une réponse a été reçue.

String releaseKeyVersion = "6A385B124DEF4096AF1361A85B16C204";
 String someTargetAttestationToken = "someAttestationToken";
 ReleaseKeyOptions releaseKeyOptions = new ReleaseKeyOptions()
     .setAlgorithm(KeyExportEncryptionAlgorithm.RSA_AES_KEY_WRAP_256)
     .setNonce("someNonce");

 keyAsyncClient.releaseKeyWithResponse("keyName", releaseKeyVersion, someTargetAttestationToken,
         releaseKeyOptions)
     .subscribe(releaseKeyResponse ->
         System.out.printf("Response received successfully with status code: %d. Signed object containing"
                 + "released key: %s%n", releaseKeyResponse.getStatusCode(),
             releaseKeyResponse.getValue().getValue()));

Parameters:

name - Nom de la clé à libérer.
version - Version de la clé à récupérer. S’il est vide ou null, cet appel équivaut à appeler releaseKey(String name, String targetAttestationToken), avec la dernière version de clé publiée.
targetAttestationToken - Assertion d’attestation pour la cible de la mise en production de clé.
releaseKeyOptions - Supplémentaire ReleaseKeyOptions pour la publication d’un KeyVaultKey.

Returns:

Mono contenant le Response<T> pour cette opération et le ReleaseKeyResult contenant la clé libérée.

restoreKeyBackup

public Mono restoreKeyBackup(byte[] backup)

Restaure un sauvegardé dans KeyVaultKey un coffre. Importe un précédemment sauvegardé KeyVaultKey dans Azure Key Vault, en restaurant , KeyVaultKeyson identificateur de clé, ses attributs et ses 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. Alors que le nom de la clé est conservé pendant la restauration, l’identificateur de clé final change 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 dans le KeyVaultKey coffre de clés à partir de sa sauvegarde. S’abonne à l’appel de façon asynchrone et imprime les détails de la clé restaurée lorsqu’une réponse a été reçue.

Passez le tableau d’octets de sauvegarde de clé à l’opération de restauration.

keyAsyncClient.restoreKeyBackup(keyBackupByteArray)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(restoreKeyResponse ->
         System.out.printf("Restored key with name: %s and: id %s%n", restoreKeyResponse.getName(),
             restoreKeyResponse.getId()));

Parameters:

backup - Objet blob de sauvegarde associé à .KeyVaultKey

Returns:

contenant Mono .KeyVaultKey

restoreKeyBackupWithResponse

public Mono> restoreKeyBackupWithResponse(byte[] backup)

Restaure un sauvegardé dans KeyVaultKey un coffre. Importe un précédemment sauvegardé KeyVaultKey dans Azure Key Vault, en restaurant , KeyVaultKeyson identificateur de clé, ses attributs et ses 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. Alors que le nom de la clé est conservé pendant la restauration, l’identificateur de clé final change 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 dans le KeyVaultKey coffre de clés à partir de sa sauvegarde. S’abonne à l’appel de façon asynchrone et imprime les détails de la clé restaurée lorsqu’une réponse a été reçue.

Passez le tableau d’octets de sauvegarde de clé à l’opération de restauration.

keyAsyncClient.restoreKeyBackupWithResponse(keyBackupByteArray)
     .contextWrite(Context.of("key1", "value1", "key2", "value2"))
     .subscribe(restoreKeyBackupResponse ->
         System.out.printf("Restored key with name: %s and: id %s%n",
             restoreKeyBackupResponse.getValue().getName(), restoreKeyBackupResponse.getValue().getId()));

Parameters:

backup - Objet blob de sauvegarde associé à .KeyVaultKey

Returns:

Mono contenant un Response<T> dont value contient le KeyVaultKey.

rotateKey

public Mono 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.

keyAsyncClient.rotateKey("keyName")
     .subscribe(key ->
         System.out.printf("Rotated key with name: %s and version:%s%n", key.getName(),
             key.getProperties().getVersion()));

Parameters:

name - Nom de KeyVaultKey à faire pivoter. Le système génère une nouvelle version dans le spécifié KeyVaultKey.

Returns:

Nouvelle version du pivoté KeyVaultKey.

rotateKeyWithResponse

public Mono> rotateKeyWithResponse(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. S’abonne à l’appel de façon asynchrone et imprime les Response<T> détails et KeyVaultKey lorsqu’une réponse a été reçue.

keyAsyncClient.rotateKeyWithResponse("keyName")
     .subscribe(rotateKeyResponse ->
         System.out.printf("Response received successfully with status code: %d. Rotated key with name: %s and"
                 + "version: %s%n", rotateKeyResponse.getStatusCode(), rotateKeyResponse.getValue().getName(),
             rotateKeyResponse.getValue().getProperties().getVersion()));

Parameters:

name - Nom de KeyVaultKey à faire pivoter. Le système génère une nouvelle version dans le spécifié KeyVaultKey.

Returns:

Mono contenant le Response<T> pour cette opération et la nouvelle version du pivoté KeyVaultKey.

updateKeyProperties

public Mono updateKeyProperties(KeyProperties keyProperties, KeyOperation[] keyOperations)

Mises à jour le KeyProperties et KeyOperation associé au spécifié, KeyVaultKeymais pas le matériel de clé de chiffrement du spécifié KeyVaultKey dans le coffre de clés. L’opération de mise à jour change spécifiée KeyProperties d’un stocké KeyVaultKey existant et KeyProperties qui ne sont pas spécifiés dans la demande sont laissées inchangées. Le matériel de clé de chiffrement d’un KeyVaultKey lui-même ne peut pas être modifié. Cette opération nécessite l’autorisation keys/set .

Exemples de code

Obtient la dernière version de , KeyVaultKeymodifie son heure notBefore, puis la met à jour dans le Key Vault Azure. S’abonne à l’appel de façon asynchrone et imprime les KeyVaultKey détails lorsqu’une réponse a été reçue.

keyAsyncClient.getKey("keyName")
     .subscribe(key -> {
         //Update the not before time of the key.
         key.getProperties().setNotBefore(OffsetDateTime.now().plusDays(50));
         keyAsyncClient.updateKeyProperties(key.getProperties(), KeyOperation.ENCRYPT,
                 KeyOperation.DECRYPT)
             .contextWrite(Context.of("key1", "value1", "key2", "value2"))
             .subscribe(updatedKey ->
                 System.out.printf("Updated key's \"not before time\": %s%n",
                     updatedKey.getProperties().getNotBefore().toString()));
     });

Parameters:

keyProperties - Objet KeyProperties avec des propriétés mises à jour.
keyOperations - mis à jour KeyOperation à associer à la clé.

Returns:

contenant Mono .KeyVaultKey

updateKeyPropertiesWithResponse

public Mono> updateKeyPropertiesWithResponse(KeyProperties keyProperties, KeyOperation[] keyOperations)

Mises à jour le KeyProperties et KeyOperation associé au spécifié, KeyVaultKeymais pas le matériel de clé de chiffrement du spécifié KeyVaultKey dans le coffre de clés. L’opération de mise à jour change spécifiée KeyProperties d’un stocké KeyVaultKey existant et KeyProperties qui ne sont pas spécifiés dans la demande sont laissées inchangées. Le matériel de clé de chiffrement d’un KeyVaultKey lui-même ne peut pas être modifié. Cette opération nécessite l’autorisation keys/set .

Exemples de code

Obtient la dernière version de , KeyVaultKeymodifie son heure notBefore, puis la met à jour dans le Key Vault Azure. S’abonne à l’appel de façon asynchrone et imprime les KeyVaultKey détails lorsqu’une réponse a été reçue.

keyAsyncClient.getKey("keyName")
     .subscribe(getKeyResponse -> {
         //Update the not before time of the key.
         getKeyResponse.getProperties().setNotBefore(OffsetDateTime.now().plusDays(50));
         keyAsyncClient.updateKeyPropertiesWithResponse(getKeyResponse.getProperties(), KeyOperation.ENCRYPT,
                 KeyOperation.DECRYPT)
             .contextWrite(Context.of("key1", "value1", "key2", "value2"))
             .subscribe(updateKeyResponse ->
                 System.out.printf("Updated key's \"not before time\": %s%n",
                     updateKeyResponse.getValue().getProperties().getNotBefore().toString()));
     });

Parameters:

keyProperties - Objet KeyProperties avec des propriétés mises à jour.
keyOperations - mis à jour KeyOperation à associer à la clé.

Returns:

Mono contenant un Response<T> dont value contient le KeyVaultKey.

updateKeyRotationPolicy

public Mono updateKeyRotationPolicy(String keyName, KeyRotationPolicy keyRotationPolicy)

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. S’abonne à l’appel de façon asynchrone et imprime les KeyRotationPolicy détails lorsqu’une réponse a été reçue.

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");

 keyAsyncClient.updateKeyRotationPolicy("keyName", keyRotationPolicy)
     .subscribe(updatedPolicy ->
         System.out.printf("Updated key rotation policy with id: %s%n", updatedPolicy.getId()));

Parameters:

keyName - Nom de l'objet KeyVaultKey.
keyRotationPolicy - KeyRotationPolicy pour la clé.

Returns:

Mono contenant le KeyRotationPolicy pour la clé.

updateKeyRotationPolicyWithResponse

public Mono> updateKeyRotationPolicyWithResponse(String keyName, KeyRotationPolicy keyRotationPolicy)

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. S’abonne à l’appel de façon asynchrone et imprime les Response<T> détails et KeyRotationPolicy lorsqu’une réponse a été reçue.

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");

 keyAsyncClient.updateKeyRotationPolicyWithResponse("keyName", myKeyRotationPolicy)
     .subscribe(myUpdatedPolicyResponse ->
         System.out.printf("Response received successfully with status code: %d. Updated key rotation policy"
             + "with id: %s%n", myUpdatedPolicyResponse.getStatusCode(),
             myUpdatedPolicyResponse.getValue().getId()));

Parameters:

keyName - Nom de l'objet KeyVaultKey.
keyRotationPolicy - KeyRotationPolicy pour la clé.

Returns:

Mono contenant le Response<T> pour cette opération et le KeyRotationPolicy pour la clé.

S’applique à