SecretClient Classe

Référence

Paquet:: com.azure.security.keyvault.secrets

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

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

public final class SecretClient

SecretClient fournit des méthodes synchrones à 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 SecretClient 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 synchrone

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

Créer un secret

Peut SecretClient ê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 de manière synchrone un secret dans le coffre de clés, à l’aide de l’API setSecret(String name, String value) .

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

Note: Pour l’exemple asynchrone, reportez-vous à SecretAsyncClient.

Obtenir un secret

Peut SecretClient ê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 d’Azure KeyVault, à l’aide de l’API getSecret(String name) .

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

Note: Pour l’exemple asynchrone, reportez-vous à SecretAsyncClient.

Supprimer un secret

Peut SecretClient ê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) .

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

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

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

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

Note: Pour l’exemple asynchrone, reportez-vous à SecretAsyncClient.

Résumé de la méthode

Modificateur et type	Méthode et description
byte[]	backupSecret(String name) Demande qu’une sauvegarde du secret soit téléchargée sur le client.
Response<byte[]>	backupSecretWithResponse(String name, Context context) Demande qu’une sauvegarde du secret soit téléchargée sur le client.
SyncPoller<DeletedSecret,Void>	beginDeleteSecret(String name) Supprime un secret du coffre de clés.
SyncPoller<KeyVaultSecret,Void>	beginRecoverDeletedSecret(String name) Récupère le secret supprimé dans le coffre de clés dans sa dernière version.
DeletedSecret	getDeletedSecret(String name) Obtient un secret qui a été supprimé pour un coffre de clés avec suppression réversible.
Response<DeletedSecret>	getDeletedSecretWithResponse(String name, Context context) Obtient un secret qui a été supprimé pour un coffre de clés avec suppression réversible.
KeyVaultSecret	getSecret(String name) Obtient la dernière version du secret spécifié à partir du coffre de clés.
KeyVaultSecret	getSecret(String name, String version) Obtient le secret spécifié avec la version spécifiée à partir du coffre de clés.
Response<KeyVaultSecret>	getSecretWithResponse(String name, String version, Context context) 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.
PagedIterable<DeletedSecret>	listDeletedSecrets() Répertorie DeletedSecret le coffre de clés s’il a activé la suppression réversible.
PagedIterable<DeletedSecret>	listDeletedSecrets(Context context) Répertorie DeletedSecret le coffre de clés s’il a activé la suppression réversible.
PagedIterable<SecretProperties>	listPropertiesOfSecretVersions(String name) Répertorie toutes les versions du secret spécifié.
PagedIterable<SecretProperties>	listPropertiesOfSecretVersions(String name, Context context) Répertorie toutes les versions du secret spécifié.
PagedIterable<SecretProperties>	listPropertiesOfSecrets() Répertorie les secrets dans le coffre de clés.
PagedIterable<SecretProperties>	listPropertiesOfSecrets(Context context) Répertorie les secrets dans le coffre de clés.
void	purgeDeletedSecret(String name) Supprime définitivement un secret supprimé, sans possibilité de récupération.
Response<Void>	purgeDeletedSecretWithResponse(String name, Context context) Supprime définitivement un secret supprimé, sans possibilité de récupération.
KeyVaultSecret	restoreSecretBackup(byte[] backup) Restaure un secret sauvegardé et toutes ses versions dans un coffre.
Response<KeyVaultSecret>	restoreSecretBackupWithResponse(byte[] backup, Context context) Restaure un secret sauvegardé et toutes ses versions dans un coffre.
KeyVaultSecret	setSecret(KeyVaultSecret secret) Ajoute un secret au coffre de clés s’il n’existe pas.
KeyVaultSecret	setSecret(String name, String value) Ajoute un secret au coffre de clés s’il n’existe pas.
Response<KeyVaultSecret>	setSecretWithResponse(KeyVaultSecret secret, Context context) Ajoute un secret au coffre de clés s’il n’existe pas.
SecretProperties	updateSecretProperties(SecretProperties secretProperties) Mises à jour les attributs associés au secret.
Response<SecretProperties>	updateSecretPropertiesWithResponse(SecretProperties secretProperties, Context context) Mises à jour les attributs associés au secret.

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails de la méthode

backupSecret

public byte[] backupSecret(String name)

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 et imprime la longueur du tableau d’octets de sauvegarde du secret retourné dans la réponse

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

Parameters:

name - Nom du secret.

Returns:

Response<T> dont value contient l’objet blob de secrets sauvegardé.

backupSecretWithResponse

public Response backupSecretWithResponse(String name, Context context)

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 et imprime la longueur du tableau d’octets de sauvegarde du secret retourné dans la réponse

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

Parameters:

name - Nom du secret.

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

Response<T> dont value contient l’objet blob de secrets sauvegardé.

beginDeleteSecret

public SyncPoller beginDeleteSecret(String name)

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 d’un coffre de clés activé pour la suppression réversible. Imprime l’ID de récupération du secret supprimé retourné dans la réponse.

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

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

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

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

Parameters:

name - Nom du secret à supprimer.

Returns:

pour SyncPoller<T,U> interroger et récupérer le DeletedSecret.

beginRecoverDeletedSecret

public SyncPoller beginRecoverDeletedSecret(String name)

Récupère le secret supprimé dans le coffre de clés dans sa dernière version. Peut être effectué uniquement sur un coffre activé pour la suppression réversible . Cette opération nécessite l’autorisation secrets/recover .

Code sample

Récupère le secret supprimé à partir du coffre de clés activé pour la suppression réversible. Imprime les détails du secret récupéré retourné dans la réponse.

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

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

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

Parameters:

name - Nom du secret supprimé à récupérer.

Returns:

pour SyncPoller<T,U> interroger et récupérer le KeyVaultSecret.

getDeletedSecret

public DeletedSecret getDeletedSecret(String name)

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. Imprime les détails du secret supprimé retourné dans la réponse.

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

Parameters:

name - Nom du secret supprimé.

Returns:

Le DeletedSecret.

getDeletedSecretWithResponse

public Response getDeletedSecretWithResponse(String name, Context context)

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. Imprime les détails du secret supprimé retourné dans la réponse.

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

Parameters:

name - Nom du secret supprimé.

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

Response<T> dont value contient le deleted secret.

getSecret

public KeyVaultSecret getSecret(String name)

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. Imprime les détails du secret retourné.

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

Parameters:

name - Nom du secret.

Returns:

Objet KeyVaultSecret demandé.

getSecret

public KeyVaultSecret getSecret(String name, String version)

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. Imprime les détails du secret retourné.

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

Parameters:

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

version - Version du secret à récupérer. S’il s’agit d’une chaîne vide ou null, cet appel équivaut à appeler getSecret(String name), avec la dernière version récupérée.

Returns:

Objet KeyVaultSecret demandé.

getSecretWithResponse

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

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. Imprime les détails du secret retourné.

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

Parameters:

name - Le nom du secret ne peut pas être null

version - Version du secret à récupérer. S’il s’agit d’une chaîne vide ou null, cet appel équivaut à appeler getSecret(String name), avec la dernière version récupérée.

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

Response<T> dont value contient le demandéKeyVaultSecret.

getVaultUrl

public String getVaultUrl()

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

Returns:

URL du point de terminaison du coffre.

listDeletedSecrets

public PagedIterable listDeletedSecrets()

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 .

Itérer sur les secrets

Répertorie les secrets supprimés dans le coffre de clés et, pour chaque secret supprimé, imprime son ID de récupération.

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

Itérer sur les secrets par page

Itérer sur Répertorie les secrets supprimés par page dans le coffre de clés et, pour chaque secret supprimé, imprime son ID de récupération.

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

Returns:

PagedIterable<T> de tous les DeletedSecret dans le coffre.

listDeletedSecrets

public PagedIterable listDeletedSecrets(Context context)

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 et, pour chaque secret supprimé, imprime son ID de récupération.

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

Parameters:

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

PagedIterable<T> de tous les DeletedSecret dans le coffre.

listPropertiesOfSecretVersions

public PagedIterable listPropertiesOfSecretVersions(String name)

Répertorie toutes les versions du secret spécifié. Chaque SecretProperties retourné a uniquement son identificateur et ses attributs renseignés. Les valeurs de secret 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 secrète récupérée, effectue un appel à getSecret(String name, String version) pour obtenir la valeur de la version, puis l’imprime.

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

Parameters:

name - Nom du secret.

Returns:

PagedIterable<T> de SecretProperties toutes les versions du secret spécifié dans le coffre. La liste est vide si le secret avec name n’existe pas dans le coffre de clés

listPropertiesOfSecretVersions

public PagedIterable listPropertiesOfSecretVersions(String name, Context context)

Code sample

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

Itérer sur les versions de secrets par page

L’exemple ci-dessous itère sur chaque SecretProperties page et appelle getSecret(String name, String version). Cette opération retourne le KeyVaultSecret avec la valeur de la version correspondante.

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

Parameters:

name - Nom du secret.

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

PagedIterable<T> de SecretProperties toutes les versions du secret spécifié dans le coffre. La liste est vide si le secret avec name n’existe pas dans le coffre de clés

listPropertiesOfSecrets

public PagedIterable listPropertiesOfSecrets()

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 .

Itérer à travers les secrets et récupérer leur dernière valeur

L’extrait de code ci-dessous effectue des boucles sur chacun d’eux SecretProperties et appelle getSecret(String name, String version). Cela obtient la KeyVaultSecret valeur et de sa dernière version.

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

Itérer sur les secrets par page

L’extrait de code ci-dessous effectue des boucles sur chaque SecretProperties page et appelle getSecret(String name, String version). Cela obtient la KeyVaultSecret valeur et de sa dernière version.

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

Returns:

PagedIterable<T> de SecretProperties tous les secrets du coffre. contient SecretProperties toutes les informations sur le secret, à l’exception de sa valeur.

listPropertiesOfSecrets

public PagedIterable listPropertiesOfSecrets(Context context)

Itérer sur les secrets et récupérer leur valeur la plus récente

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

Parameters:

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

PagedIterable<T> de SecretProperties tous les secrets du coffre. SecretProperties contient toutes les informations sur le secret, à l’exception de sa valeur.

purgeDeletedSecret

public void purgeDeletedSecret(String name)

Supprime définitivement un secret supprimé, sans possibilité de récupération. Cette opération ne peut être effectué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. Imprime le code status à partir de la réponse du serveur.

secretClient.purgeDeletedSecret("secretName");

Parameters:

name - Nom du secret.

purgeDeletedSecretWithResponse

public Response purgeDeletedSecretWithResponse(String name, Context context)

Code sample

Vide le secret supprimé du coffre de clés activé pour la suppression réversible. Imprime le code status à partir de la réponse du serveur.

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

Parameters:

name - Nom du secret.

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

Réponse contenant du code status et des en-têtes HTTP.

restoreSecretBackup

public KeyVaultSecret restoreSecretBackup(byte[] backup)

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 son tableau d’octets de sauvegarde. Imprime les détails du secret restauré retourné dans la réponse.

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

Parameters:

backup - Objet blob de sauvegarde associé au secret.

Returns:

Response<T> dont value contient .KeyVaultSecret

restoreSecretBackupWithResponse

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

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 son tableau d’octets de sauvegarde. Imprime les détails du secret restauré retourné dans la réponse.

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

Parameters:

backup - Objet blob de sauvegarde associé au secret.

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

Response<T> dont value contient .KeyVaultSecret

setSecret

public KeyVaultSecret setSecret(KeyVaultSecret secret)

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 nouveau secret dans le coffre de clés. Imprime les détails du secret nouvellement créé retourné dans la réponse.

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

Parameters:

secret - Objet Secret contenant des informations sur le secret et ses propriétés. Les propriétés getName() et getValue() ne peuvent pas être null.

Returns:

Le KeyVaultSecret.

setSecret

public KeyVaultSecret setSecret(String name, String value)

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 nouveau secret dans le coffre de clés. Imprime les détails du secret nouvellement créé retourné dans la réponse.

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

Parameters:

name - Nom du secret. Elle est obligatoire et ne peut pas être null.

value - Valeur de la clé secrète. Elle est obligatoire et ne peut pas être null.

Returns:

Le KeyVaultSecret.

setSecretWithResponse

public Response setSecretWithResponse(KeyVaultSecret secret, Context context)

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 nouveau secret dans le coffre de clés. Imprime les détails du secret nouvellement créé retourné dans la réponse.

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

Parameters:

secret - Objet Secret contenant des informations sur le secret et ses propriétés. Les propriétés secret.name et secret.value doivent être non null.

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

Response<T> dont value contient .KeyVaultSecret

updateSecretProperties

public SecretProperties updateSecretProperties(SecretProperties secretProperties)

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 heure d’expiration et met à jour le secret dans le coffre de clés.

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

Parameters:

secretProperties - Objet SecretProperties avec des propriétés mises à jour.

Returns:

Le SecretProperties.

updateSecretPropertiesWithResponse

public Response updateSecretPropertiesWithResponse(SecretProperties secretProperties, Context context)

est secret obligatoire et ses champs getName() ne getVersion() peuvent pas être null.

Code sample

Obtient la dernière version du secret, modifie son heure d’expiration et met à jour le secret dans le coffre de clés.

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

Parameters:

secretProperties - Objet SecretProperties avec des propriétés mises à jour.

context - Contexte supplémentaire transmis via le pipeline HTTP pendant l’appel de service.

Returns:

Response<T> dont value contient le SecretProperties.

Partager via

SecretClient Classe

Mise en route

Créer un secret

Obtenir un secret

Supprimer un secret

Résumé de la méthode

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

Détails de la méthode

backupSecret

backupSecretWithResponse

beginDeleteSecret

beginRecoverDeletedSecret

getDeletedSecret

getDeletedSecretWithResponse

getSecret

getSecret

getSecretWithResponse

getVaultUrl

listDeletedSecrets

listDeletedSecrets

listPropertiesOfSecretVersions

listPropertiesOfSecretVersions

listPropertiesOfSecrets

listPropertiesOfSecrets

purgeDeletedSecret

purgeDeletedSecretWithResponse

restoreSecretBackup

restoreSecretBackupWithResponse

setSecret

setSecret

setSecretWithResponse

updateSecretProperties

updateSecretPropertiesWithResponse

S’applique à

Ressources supplémentaires