SecretAsyncClient Classe
- java.
lang. Object - com.
azure. security. keyvault. secrets. SecretAsyncClient
- com.
public final class SecretAsyncClient
SecretAsyncClient fournit des méthodes asynchrones à gérer KeyVaultSecret dans le Key Vault Azure. Le client prend en charge la création, la récupération, la mise à jour, la suppression, le vidage, la sauvegarde, la restauration et la liste des KeyVaultSecret. Le client prend également en charge la liste DeletedSecret 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 SecretAsyncClient 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 secret asynchrone
SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
.credential(new DefaultAzureCredentialBuilder().build())
.vaultUrl("<your-key-vault-url>")
.buildAsyncClient();
Créer un secret
Peut SecretAsyncClient être utilisé pour créer un secret dans le coffre de clés.
Exemple de code :
L’exemple de code suivant montre comment créer et stocker un secret dans le coffre de clés à l’aide de l’API setSecret(String name, String value) .
secretAsyncClient.setSecret("secretName", "secretValue")
.subscribe(secretResponse ->
System.out.printf("Secret is created with name %s and value %s%n",
secretResponse.getName(), secretResponse.getValue()));
Note: Pour l’exemple synchrone, reportez-vous à SecretClient.
Obtenir un secret
Peut SecretAsyncClient être utilisé pour récupérer un secret à partir du coffre de clés.
Exemple de code :
L’exemple de code suivant montre comment récupérer de manière synchrone un secret précédemment stocké à partir du coffre de clés, à l’aide de l’API getSecret(String name) .
secretAsyncClient.getSecret("secretName")
.subscribe(secretWithVersion ->
System.out.printf("Secret is returned with name %s and value %s %n",
secretWithVersion.getName(), secretWithVersion.getValue()));
Note: Pour l’exemple synchrone, reportez-vous à SecretClient.
Supprimer un secret
Peut SecretAsyncClient être utilisé pour supprimer un secret du coffre de clés.
Exemple de code :
L’exemple de code suivant montre comment supprimer un secret du coffre de clés à l’aide de l’API beginDeleteSecret(String name) .
secretAsyncClient.beginDeleteSecret("secretName")
.subscribe(pollResponse -> {
System.out.println("Delete Status: " + pollResponse.getStatus().toString());
System.out.println("Deleted Secret Name: " + pollResponse.getValue().getName());
System.out.println("Deleted Secret Value: " + pollResponse.getValue().getValue());
});
Note: Pour l’exemple synchrone, reportez-vous à SecretClient.
Résumé de la méthode
Modificateur et type | Méthode et description |
---|---|
Mono<byte[]> |
backupSecret(String name)
Demande qu’une sauvegarde du secret soit téléchargée sur le client. |
Mono<Response<byte[]>> |
backupSecretWithResponse(String name)
Demande qu’une sauvegarde du secret soit téléchargée sur le client. |
Poller |
beginDeleteSecret(String name)
Supprime un secret du coffre de clés. |
Poller |
beginRecoverDeletedSecret(String name)
Récupère le secret supprimé dans le coffre de clés dans sa dernière version. |
Mono<Deleted |
getDeletedSecret(String name)
Obtient un secret qui a été supprimé pour un coffre de clés avec suppression réversible. |
Mono<Response<Deleted |
getDeletedSecretWithResponse(String name)
Obtient un secret qui a été supprimé pour un coffre de clés avec suppression réversible. |
Mono<Key |
getSecret(String name)
Obtient la dernière version du secret spécifié à partir du coffre de clés. |
Mono<Key |
getSecret(String name, String version)
Obtient le secret spécifié avec la version spécifiée à partir du coffre de clés. |
Mono<Response<Key |
getSecretWithResponse(String name, String version)
Obtient le secret spécifié avec la version spécifiée à partir du coffre de clés. |
String |
getVaultUrl()
Obtient l’URL du point de terminaison du coffre à laquelle les demandes de service sont envoyées. |
Paged |
listDeletedSecrets()
Répertorie DeletedSecret le coffre de clés s’il a activé la suppression réversible. |
Paged |
listPropertiesOfSecretVersions(String name)
Répertorie toutes les versions du secret spécifié. |
Paged |
listPropertiesOfSecrets()
Répertorie les secrets dans le coffre de clés. |
Mono<Void> |
purgeDeletedSecret(String name)
Supprime définitivement un secret supprimé, sans possibilité de récupération. |
Mono<Response<Void>> |
purgeDeletedSecretWithResponse(String name)
Supprime définitivement un secret supprimé, sans possibilité de récupération. |
Mono<Key |
restoreSecretBackup(byte[] backup)
Restaure un secret sauvegardé et toutes ses versions dans un coffre. |
Mono<Response<Key |
restoreSecretBackupWithResponse(byte[] backup)
Restaure un secret sauvegardé et toutes ses versions dans un coffre. |
Mono<Key |
setSecret(KeyVaultSecret secret)
Ajoute un secret au coffre de clés s’il n’existe pas. |
Mono<Key |
setSecret(String name, String value)
Ajoute un secret au coffre de clés s’il n’existe pas. |
Mono<Response<Key |
setSecretWithResponse(KeyVaultSecret secret)
Ajoute un secret au coffre de clés s’il n’existe pas. |
Mono<Secret |
updateSecretProperties(SecretProperties secretProperties)
Mises à jour les attributs associés au secret. |
Mono<Response<Secret |
updateSecretPropertiesWithResponse(SecretProperties secretProperties)
Mises à jour les attributs associés au secret. |
Méthodes héritées de java.lang.Object
Détails de la méthode
backupSecret
public Mono
Demande qu’une sauvegarde du secret soit téléchargée sur le client. Toutes les versions du secret seront téléchargées. Cette opération nécessite l’autorisation secrets/backup
.
Code sample
Sauvegarde le secret à partir du coffre de clés. S’abonne à l’appel de façon asynchrone et imprime la longueur du tableau d’octets de sauvegarde du secret retourné dans la réponse.
secretAsyncClient.backupSecret("secretName")
.subscribe(secretBackupResponse ->
System.out.printf("Secret's Backup Byte array's length %s%n", secretBackupResponse.length));
Parameters:
Returns:
backupSecretWithResponse
public Mono
Demande qu’une sauvegarde du secret soit téléchargée sur le client. Toutes les versions du secret seront téléchargées. Cette opération nécessite l’autorisation secrets/backup
.
Code sample
Sauvegarde le secret à partir du coffre de clés. S’abonne à l’appel de façon asynchrone et imprime la longueur du tableau d’octets de sauvegarde du secret retourné dans la réponse.
secretAsyncClient.backupSecretWithResponse("secretName")
.subscribe(secretBackupResponse ->
System.out.printf("Secret's Backup Byte array's length %s%n", secretBackupResponse.getValue().length));
Parameters:
Returns:
beginDeleteSecret
public PollerFlux
Supprime un secret du coffre de clés. Si la suppression réversible est activée sur le coffre de clés, le secret est placé dans l’état supprimé et, pour une suppression définitive, doit être vidé. Sinon, le secret est définitivement supprimé. Toutes les versions d’un secret sont supprimées. Cela ne peut pas être appliqué à des versions individuelles d’un secret. Cette opération nécessite l’autorisation secrets/delete
.
Code sample
Supprime le secret dans le Key Vault Azure. S’abonne à l’appel de façon asynchrone et imprime les détails du secret supprimé lorsqu’une réponse est reçue.
secretAsyncClient.beginDeleteSecret("secretName")
.subscribe(pollResponse -> {
System.out.println("Delete Status: " + pollResponse.getStatus().toString());
System.out.println("Deleted Secret Name: " + pollResponse.getValue().getName());
System.out.println("Deleted Secret Value: " + pollResponse.getValue().getValue());
});
Parameters:
Returns:
beginRecoverDeletedSecret
public PollerFlux
Récupère le secret supprimé dans le coffre de clés dans sa dernière version. Ne peut être effectué que sur un coffre avec suppression réversible . Cette opération nécessite l’autorisation secrets/recover
.
Code sample
Récupère le secret supprimé du coffre de clés activé pour la suppression réversible. S’abonne à l’appel de manière asynchrone et imprime les détails du secret récupéré lors de la réception d’une réponse.
secretAsyncClient.beginRecoverDeletedSecret("deletedSecretName")
.subscribe(pollResponse -> {
System.out.println("Recovery Status: " + pollResponse.getStatus().toString());
System.out.println("Recovered Secret Name: " + pollResponse.getValue().getName());
System.out.println("Recovered Secret Value: " + pollResponse.getValue().getValue());
});
Parameters:
Returns:
getDeletedSecret
public Mono
Obtient un secret qui a été supprimé pour un coffre de clés avec suppression réversible. Cette opération nécessite l’autorisation secrets/list
.
Code sample
Obtient le secret supprimé du coffre de clés activé pour la suppression réversible. S’abonne à l’appel de manière asynchrone et imprime les détails du secret supprimé lors de la réception d’une réponse.
secretAsyncClient.getDeletedSecret("secretName")
.subscribe(deletedSecretResponse ->
System.out.printf("Deleted Secret's Recovery Id %s %n", deletedSecretResponse.getRecoveryId()));
Parameters:
Returns:
getDeletedSecretWithResponse
public Mono
Obtient un secret qui a été supprimé pour un coffre de clés avec suppression réversible. Cette opération nécessite l’autorisation secrets/list
.
Code sample
Obtient le secret supprimé du coffre de clés activé pour la suppression réversible. S’abonne à l’appel de manière asynchrone et imprime les détails du secret supprimé lors de la réception d’une réponse.
secretAsyncClient.getDeletedSecretWithResponse("secretName")
.subscribe(deletedSecretResponse ->
System.out.printf("Deleted Secret's Recovery Id %s %n",
deletedSecretResponse.getValue().getRecoveryId()));
Parameters:
Returns:
getSecret
public Mono
Obtient la dernière version du secret spécifié à partir du coffre de clés. Cette opération nécessite l’autorisation secrets/get
.
Code sample
Obtient la dernière version du secret dans le coffre de clés. S’abonne à l’appel de manière asynchrone et imprime les détails du secret retourné lors de la réception d’une réponse.
secretAsyncClient.getSecret("secretName")
.subscribe(secretWithVersion ->
System.out.printf("Secret is returned with name %s and value %s %n",
secretWithVersion.getName(), secretWithVersion.getValue()));
Parameters:
Returns:
getSecret
public Mono
Obtient le secret spécifié avec la version spécifiée à partir du coffre de clés. Cette opération nécessite l’autorisation secrets/get
.
Code sample
Obtient une version spécifique du secret dans le coffre de clés. S’abonne à l’appel de manière asynchrone et imprime les détails du secret retourné lors de la réception d’une réponse.
String secretVersion = "6A385B124DEF4096AF1361A85B16C204";
secretAsyncClient.getSecret("secretName", secretVersion)
// Passing a Context is optional and useful if you want a set of data to flow through the request.
// Otherwise, the line below can be removed.
.contextWrite(Context.of(key1, value1, key2, value2))
.subscribe(secretWithVersion ->
System.out.printf("Secret is returned with name %s and value %s %n",
secretWithVersion.getName(), secretWithVersion.getValue()));
Parameters:
Returns:
getSecretWithResponse
public Mono
Obtient le secret spécifié avec la version spécifiée à partir du coffre de clés. Cette opération nécessite l’autorisation secrets/get
.
Code sample
Obtient une version spécifique du secret dans le coffre de clés. S’abonne à l’appel de manière asynchrone et imprime les détails du secret retourné lors de la réception d’une réponse.
String secretVersion = "6A385B124DEF4096AF1361A85B16C204";
secretAsyncClient.getSecretWithResponse("secretName", secretVersion)
// Passing a Context is optional and useful if you want a set of data to flow through the request.
// Otherwise, the line below can be removed.
.contextWrite(Context.of(key1, value1, key2, value2))
.subscribe(secretWithVersion ->
System.out.printf("Secret is returned with name %s and value %s %n",
secretWithVersion.getValue().getName(), secretWithVersion.getValue().getValue()));
Parameters:
Returns:
getVaultUrl
public String getVaultUrl()
Obtient l’URL du point de terminaison du coffre à laquelle les demandes de service sont envoyées.
Returns:
listDeletedSecrets
public PagedFlux
Répertorie DeletedSecret le coffre de clés s’il a activé la suppression réversible. Cette opération nécessite l’autorisation secrets/list
.
Code sample
Répertorie les secrets supprimés dans le coffre de clés. S’abonne à l’appel de manière asynchrone et imprime l’ID de récupération de chaque secret supprimé lors de la réception d’une réponse.
secretAsyncClient.listDeletedSecrets()
.subscribe(deletedSecretResponse -> System.out.printf("Deleted Secret's Recovery Id %s %n",
deletedSecretResponse.getRecoveryId()));
Returns:
listPropertiesOfSecretVersions
public PagedFlux
Répertorie toutes les versions du secret spécifié. Chaque SecretProperties retourné a uniquement son identificateur et ses attributs renseignés. Les valeurs secrètes et les versions de secret ne sont pas répertoriées dans la réponse. Cette opération nécessite l’autorisation secrets/list
.
Code sample
L’exemple ci-dessous extrait toutes les versions du secret donné. Pour chaque version récupérée, effectue un appel à getSecret(String name, String version) pour obtenir la valeur de la version, puis l’imprime.
secretAsyncClient.listPropertiesOfSecretVersions("secretName")
.flatMap(secretProperties -> {
System.out.println("Get secret value for version: " + secretProperties.getVersion());
return secretAsyncClient.getSecret(secretProperties.getName(), secretProperties.getVersion());
})
.subscribe(secret -> System.out.printf("Received secret with name %s and type %s%n",
secret.getName(), secret.getValue()));
Parameters:
Returns:
name
n’existe pas dans le coffre de cléslistPropertiesOfSecrets
public PagedFlux
Répertorie les secrets dans le coffre de clés. Chaque SecretProperties retourné a uniquement son identificateur et ses attributs renseignés. Les valeurs secrètes et leurs versions ne sont pas répertoriées dans la réponse. Cette opération nécessite l’autorisation secrets/list
.
Code sample
L’exemple ci-dessous extrait toutes les propriétés secrètes dans le coffre. Pour chaque secret récupéré, effectue un appel à getSecret(String name, String version) pour obtenir sa valeur, puis l’imprime.
secretAsyncClient.listPropertiesOfSecrets()
.flatMap(secretProperties -> {
String name = secretProperties.getName();
String version = secretProperties.getVersion();
System.out.printf("Getting secret name: '%s', version: %s%n", name, version);
return secretAsyncClient.getSecret(name, version);
})
.subscribe(secretResponse -> System.out.printf("Received secret with name %s and type %s",
secretResponse.getName(), secretResponse.getValue()));
Returns:
purgeDeletedSecret
public Mono
Supprime définitivement un secret supprimé, sans possibilité de récupération. Cette opération ne peut être effectuée que sur une suppression réversible activée. Cette opération nécessite l’autorisation secrets/purge
.
Code sample
Vide le secret supprimé 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 est reçue.
secretAsyncClient.purgeDeletedSecret("deletedSecretName")
.doOnSuccess(purgeResponse ->
System.out.println("Successfully Purged deleted Secret"))
.subscribe();
Parameters:
Returns:
purgeDeletedSecretWithResponse
public Mono
Supprime définitivement un secret supprimé, sans possibilité de récupération. Cette opération ne peut être activée que sur un coffre avec suppression réversible. Cette opération nécessite l’autorisation secrets/purge
.
Code sample
Vide le secret supprimé 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 est reçue.
secretAsyncClient.purgeDeletedSecretWithResponse("deletedSecretName")
.subscribe(purgeResponse ->
System.out.printf("Purge Status response %d %n", purgeResponse.getStatusCode()));
Parameters:
Returns:
restoreSecretBackup
public Mono
Restaure un secret sauvegardé et toutes ses versions dans un coffre. Cette opération nécessite l’autorisation secrets/restore
.
Code sample
Restaure le secret dans le coffre de clés à partir de sa sauvegarde. S’abonne à l’appel de façon asynchrone et imprime les détails du secret restauré lors de la réception d’une réponse.
// Pass the secret backup byte array to the restore operation.
byte[] secretBackupByteArray = {};
secretAsyncClient.restoreSecretBackup(secretBackupByteArray)
.subscribe(secretResponse -> System.out.printf("Restored Secret with name %s and value %s %n",
secretResponse.getName(), secretResponse.getValue()));
Parameters:
Returns:
restoreSecretBackupWithResponse
public Mono
Restaure un secret sauvegardé et toutes ses versions dans un coffre. Cette opération nécessite l’autorisation secrets/restore
.
Code sample
Restaure le secret dans le coffre de clés à partir de sa sauvegarde. S’abonne à l’appel de façon asynchrone et imprime les détails du secret restauré lors de la réception d’une réponse.
// Pass the secret backup byte array to the restore operation.
byte[] secretBackupByteArray = {};
secretAsyncClient.restoreSecretBackupWithResponse(secretBackupByteArray)
.subscribe(secretResponse -> System.out.printf("Restored Secret with name %s and value %s %n",
secretResponse.getValue().getName(), secretResponse.getValue().getValue()));
Parameters:
Returns:
setSecret
public Mono
Ajoute un secret au coffre de clés s’il n’existe pas. Si le secret nommé existe, une nouvelle version du secret est créée. Cette opération nécessite l’autorisation secrets/set
.
Les getExpiresOn()valeurs , getContentType()et getNotBefore() dans secret
sont facultatives. S’il n’est pas spécifié, isEnabled() est défini sur true par le coffre de clés.
Code sample
Crée un secret qui s’active en un jour et expire dans un an. S’abonne à l’appel de façon asynchrone et imprime les détails du secret nouvellement créé lors de la réception d’une réponse.
SecretProperties properties = new SecretProperties()
.setExpiresOn(OffsetDateTime.now().plusDays(60));
KeyVaultSecret newSecret = new KeyVaultSecret("secretName", "secretValue")
.setProperties(properties);
secretAsyncClient.setSecret(newSecret)
.subscribe(secretResponse ->
System.out.printf("Secret is created with name %s and value %s %n",
secretResponse.getName(), secretResponse.getValue()));
Parameters:
Returns:
setSecret
public Mono
Ajoute un secret au coffre de clés s’il n’existe pas. Si le secret nommé existe, une nouvelle version du secret est créée. Cette opération nécessite l’autorisation secrets/set
.
Code sample
Crée un secret dans le coffre de clés. S’abonne à l’appel de façon asynchrone et imprime les détails du secret nouvellement créé lors de la réception d’une réponse.
secretAsyncClient.setSecret("secretName", "secretValue")
.subscribe(secretResponse ->
System.out.printf("Secret is created with name %s and value %s%n",
secretResponse.getName(), secretResponse.getValue()));
Parameters:
Returns:
setSecretWithResponse
public Mono
Ajoute un secret au coffre de clés s’il n’existe pas. Si le secret nommé existe, une nouvelle version du secret est créée. Cette opération nécessite l’autorisation secrets/set
.
Les getExpiresOn()valeurs , getContentType()et getNotBefore() dans secret
sont facultatives. S’il n’est pas spécifié, isEnabled() est défini sur true par le coffre de clés.
Code sample
Crée un secret qui s’active en un jour et expire dans un an. S’abonne à l’appel de façon asynchrone et imprime les détails du secret nouvellement créé lors de la réception d’une réponse.
KeyVaultSecret newSecret = new KeyVaultSecret("secretName", "secretValue").
setProperties(new SecretProperties().setExpiresOn(OffsetDateTime.now().plusDays(60)));
secretAsyncClient.setSecretWithResponse(newSecret)
.subscribe(secretResponse ->
System.out.printf("Secret is created with name %s and value %s %n",
secretResponse.getValue().getName(), secretResponse.getValue().getValue()));
Parameters:
Returns:
updateSecretProperties
public Mono
Mises à jour les attributs associés au secret. La valeur du secret dans le coffre de clés ne peut pas être modifiée. Seuls les attributs renseignés dans secretProperties
sont modifiés. Les attributs non spécifiés dans la requête ne sont pas modifiés. Cette opération nécessite l’autorisation secrets/set
.
est secret
obligatoire et ses champs getName() ne getVersion() peuvent pas être null.
Code sample
Obtient la dernière version du secret, modifie son setNotBefore(OffsetDateTime notBefore) heure, puis la met à jour dans le Key Vault Azure. S’abonne à l’appel de façon asynchrone et imprime les détails du secret retourné lors de la réception d’une réponse.
secretAsyncClient.getSecret("secretName")
.subscribe(secretResponseValue -> {
SecretProperties secretProperties = secretResponseValue.getProperties();
//Update the not before time of the secret.
secretProperties.setNotBefore(OffsetDateTime.now().plusDays(50));
secretAsyncClient.updateSecretProperties(secretProperties)
.subscribe(secretResponse ->
System.out.printf("Secret's updated not before time %s %n",
secretResponse.getNotBefore().toString()));
});
Parameters:
Returns:
updateSecretPropertiesWithResponse
public Mono
Mises à jour les attributs associés au secret. La valeur du secret dans le coffre de clés ne peut pas être modifiée. Seuls les attributs renseignés dans secretProperties
sont modifiés. Les attributs non spécifiés dans la requête ne sont pas modifiés. Cette opération nécessite l’autorisation secrets/set
.
Code sample
Obtient la dernière version du secret, modifie son setNotBefore(OffsetDateTime notBefore) heure, puis la met à jour dans le Key Vault Azure. S’abonne à l’appel de façon asynchrone et imprime les détails du secret retourné lors de la réception d’une réponse.
secretAsyncClient.getSecret("secretName")
.subscribe(secretResponseValue -> {
SecretProperties secretProperties = secretResponseValue.getProperties();
//Update the not before time of the secret.
secretProperties.setNotBefore(OffsetDateTime.now().plusDays(50));
secretAsyncClient.updateSecretPropertiesWithResponse(secretProperties)
.subscribe(secretResponse ->
System.out.printf("Secret's updated not before time %s %n",
secretResponse.getValue().getNotBefore().toString()));
});
est secret
obligatoire et ses champs getName() ne getVersion() peuvent pas être null.
Parameters:
Returns:
S’applique à
Azure SDK for Java