SecretAsyncClient Class

public Mono backupSecret(String name)

Requests a backup of the secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.

Code sample

Backs up the secret from the key vault. Subscribes to the call asynchronously and prints out the length of the secret's backup byte array returned in the response.

secretAsyncClient.backupSecret("secretName")
     .subscribe(secretBackupResponse ->
         System.out.printf("Secret's Backup Byte array's length %s%n", secretBackupResponse.length));

Parameters:

Returns:

public Mono> backupSecretWithResponse(String name)

Requests a backup of the secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.

Code sample

Backs up the secret from the key vault. Subscribes to the call asynchronously and prints out the length of the secret's backup byte array returned in the response.

secretAsyncClient.backupSecretWithResponse("secretName")
     .subscribe(secretBackupResponse ->
         System.out.printf("Secret's Backup Byte array's length %s%n", secretBackupResponse.getValue().length));

Parameters:

Returns:

public PollerFlux beginDeleteSecret(String name)

Deletes a secret from the key vault. If soft-delete is enabled on the key vault then the secret is placed in the deleted state and for permanent deletion, needs to be purged. Otherwise, the secret is permanently deleted. All versions of a secret are deleted. This cannot be applied to individual versions of a secret. This operation requires the secrets/delete permission.

Code sample

Deletes the secret in the Azure Key Vault. Subscribes to the call asynchronously and prints out the deleted secret details when a response is received.

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:

public PollerFlux beginRecoverDeletedSecret(String name)

Recovers the deleted secret in the key vault to its latest version. Can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.

Code sample

Recovers the deleted secret from the key vault enabled for soft-delete. Subscribes to the call asynchronously and prints out the recovered secret details when a response is received.

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:

public Mono getDeletedSecret(String name)

Gets a secret that has been deleted for a soft-delete enabled key vault. This operation requires the secrets/list permission.

Code sample

Gets the deleted secret from the key vault enabled for soft-delete. Subscribes to the call asynchronously and prints out the deleted secret details when a response is received.

secretAsyncClient.getDeletedSecret("secretName")
     .subscribe(deletedSecretResponse ->
         System.out.printf("Deleted Secret's Recovery Id %s %n", deletedSecretResponse.getRecoveryId()));

Parameters:

Returns:

public Mono> getDeletedSecretWithResponse(String name)

Gets a secret that has been deleted for a soft-delete enabled key vault. This operation requires the secrets/list permission.

Code sample

Gets the deleted secret from the key vault enabled for soft-delete. Subscribes to the call asynchronously and prints out the deleted secret details when a response is received.

secretAsyncClient.getDeletedSecretWithResponse("secretName")
     .subscribe(deletedSecretResponse ->
         System.out.printf("Deleted Secret's Recovery Id %s %n",
             deletedSecretResponse.getValue().getRecoveryId()));

Parameters:

Returns:

public Mono getSecret(String name)

Gets the latest version of the specified secret from the key vault. This operation requires the secrets/get permission.

Code sample

Gets latest version of the secret in the key vault. Subscribes to the call asynchronously and prints out the returned secret details when a response is received.

secretAsyncClient.getSecret("secretName")
     .subscribe(secretWithVersion ->
         System.out.printf("Secret is returned with name %s and value %s %n",
             secretWithVersion.getName(), secretWithVersion.getValue()));

Parameters:

Returns:

public Mono getSecret(String name, String version)

Gets the specified secret with specified version from the key vault. This operation requires the secrets/get permission.

Code sample

Gets a specific version of the secret in the key vault. Subscribes to the call asynchronously and prints out the returned secret details when a response is received.

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:

public Mono> getSecretWithResponse(String name, String version)

Gets the specified secret with specified version from the key vault. This operation requires the secrets/get permission.

Code sample

Gets a specific version of the secret in the key vault. Subscribes to the call asynchronously and prints out the returned secret details when a response is received.

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:

public String getVaultUrl()

Gets the vault endpoint url to which service requests are sent to.

Returns:

public PagedFlux listDeletedSecrets()

Lists DeletedSecret of the key vault if it has enabled soft-delete. This operation requires the secrets/list permission.

Code sample

Lists the deleted secrets in the key vault. Subscribes to the call asynchronously and prints out the recovery id of each deleted secret when a response is received.

secretAsyncClient.listDeletedSecrets()
     .subscribe(deletedSecretResponse -> System.out.printf("Deleted Secret's Recovery Id %s %n",
         deletedSecretResponse.getRecoveryId()));

Returns:

public PagedFlux listPropertiesOfSecretVersions(String name)

Lists all versions of the specified secret. Each SecretProperties returned only has its identifier and attributes populated. The secret values and secret versions are not listed in the response. This operation requires the secrets/list permission.

Code sample

The sample below fetches the all the versions of the given secret. For each version retrieved, makes a call to getSecret(String name, String version) to get the version's value, and then prints it out.

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:

public PagedFlux listPropertiesOfSecrets()

Lists secrets in the key vault. Each SecretProperties returned only has its identifier and attributes populated. The secret values and their versions are not listed in the response. This operation requires the secrets/list permission.

Code sample

The sample below fetches the all the secret properties in the vault. For each secret retrieved, makes a call to getSecret(String name, String version) to get its value, and then prints it out.

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:

public Mono purgeDeletedSecret(String name)

Permanently removes a deleted secret, without the possibility of recovery. This operation can only be performed on a soft-delete enabled. This operation requires the secrets/purge permission.

Code sample

Purges the deleted secret from the key vault enabled for soft-delete. Subscribes to the call asynchronously and prints out the status code from the server response when a response is received.

secretAsyncClient.purgeDeletedSecret("deletedSecretName")
     .doOnSuccess(purgeResponse ->
         System.out.println("Successfully Purged deleted Secret"))
     .subscribe();

Parameters:

Returns:

public Mono> purgeDeletedSecretWithResponse(String name)

Permanently removes a deleted secret, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.

Code sample

Purges the deleted secret from the key vault enabled for soft-delete. Subscribes to the call asynchronously and prints out the status code from the server response when a response is received.

secretAsyncClient.purgeDeletedSecretWithResponse("deletedSecretName")
     .subscribe(purgeResponse ->
         System.out.printf("Purge Status response %d %n", purgeResponse.getStatusCode()));

Parameters:

Returns:

public Mono restoreSecretBackup(byte[] backup)

Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.

Code sample

Restores the secret in the key vault from its backup. Subscribes to the call asynchronously and prints out the restored secret details when a response is received.

// 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:

public Mono> restoreSecretBackupWithResponse(byte[] backup)

Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.

Code sample

Restores the secret in the key vault from its backup. Subscribes to the call asynchronously and prints out the restored secret details when a response is received.

// 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:

public Mono setSecret(KeyVaultSecret secret)

Adds a secret to the key vault if it does not exist. If the named secret exists, a new version of the secret is created. This operation requires the secrets/set permission.

The getExpiresOn(), getContentType(), and getNotBefore() values in secret are optional. If not specified, isEnabled() is set to true by key vault.

Code sample

Creates a new secret which activates in one day and expires in one year. Subscribes to the call asynchronously and prints out the newly created secret details when a response is received.

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:

public Mono setSecret(String name, String value)

Adds a secret to the key vault if it does not exist. If the named secret exists, a new version of the secret is created. This operation requires the secrets/set permission.

Code sample

Creates a new secret in the key vault. Subscribes to the call asynchronously and prints out the newly created secret details when a response is received.

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:

public Mono> setSecretWithResponse(KeyVaultSecret secret)

Adds a secret to the key vault if it does not exist. If the named secret exists, a new version of the secret is created. This operation requires the secrets/set permission.

The getExpiresOn(), getContentType(), and getNotBefore() values in secret are optional. If not specified, isEnabled() is set to true by key vault.

Code sample

Creates a new secret which activates in one day and expires in one year. Subscribes to the call asynchronously and prints out the newly created secret details when a response is received.

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:

public Mono updateSecretProperties(SecretProperties secretProperties)

Updates the attributes associated with the secret. The value of the secret in the key vault cannot be changed. Only attributes populated in secretProperties are changed. Attributes not specified in the request are not changed. This operation requires the secrets/set permission.

The secret is required and its fields getName() and getVersion() cannot be null.

Code sample

Gets latest version of the secret, changes its setNotBefore(OffsetDateTime notBefore) time, and then updates it in the Azure Key Vault. Subscribes to the call asynchronously and prints out the returned secret details when a response is received.

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:

public Mono> updateSecretPropertiesWithResponse(SecretProperties secretProperties)

Updates the attributes associated with the secret. The value of the secret in the key vault cannot be changed. Only attributes populated in secretProperties are changed. Attributes not specified in the request are not changed. This operation requires the secrets/set permission.

Code sample

Gets latest version of the secret, changes its setNotBefore(OffsetDateTime notBefore) time, and then updates it in the Azure Key Vault. Subscribes to the call asynchronously and prints out the returned secret details when a response is received.

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()));
     });

The secret is required and its fields getName() and getVersion() cannot be null.

Parameters:

Returns: