KeyAsyncClient (Azure SDK for Java Reference Documentation)

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

```
public final class KeyAsyncClient
extends Object
```
The KeyAsyncClient provides asynchronous methods to manage keys in the Azure Key Vault. The client supports creating, retrieving, updating, deleting, purging, backing up, restoring and listing the keys. The client also supports listing deleted keys for a soft-delete enabled Azure Key Vault.
Samples to construct the async client
```
 KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
     .vaultUrl("https://myvault.azure.net/")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();
 
```
See Also:

KeyClientBuilder, PagedFlux

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mono<byte[]>`	`backupKey(String name)` Requests a backup of the specified key be downloaded to the client.
`Mono<com.azure.core.http.rest.Response<byte[]>>`	`backupKeyWithResponse(String name)` Requests a backup of the specified key be downloaded to the client.
`com.azure.core.util.polling.PollerFlux<DeletedKey,Void>`	`beginDeleteKey(String name)` Deletes a key of any type from the key vault.
`com.azure.core.util.polling.PollerFlux<KeyVaultKey,Void>`	`beginRecoverDeletedKey(String name)` Recovers the deleted key in the key vault to its latest version and can only be performed on a soft-delete enabled vault.
`Mono<KeyVaultKey>`	`createEcKey(CreateEcKeyOptions createEcKeyOptions)` Creates a new Ec key and stores it in the key vault.
`Mono<com.azure.core.http.rest.Response<KeyVaultKey>>`	`createEcKeyWithResponse(CreateEcKeyOptions createEcKeyOptions)` Creates a new Ec key and stores it in the key vault.
`Mono<KeyVaultKey>`	`createKey(CreateKeyOptions createKeyOptions)` Creates a new key and stores it in the key vault.
`Mono<KeyVaultKey>`	`createKey(String name, KeyType keyType)` Creates a new key and stores it in the key vault.
`Mono<com.azure.core.http.rest.Response<KeyVaultKey>>`	`createKeyWithResponse(CreateKeyOptions createKeyOptions)` Creates a new key and stores it in the key vault.
`Mono<KeyVaultKey>`	`createRsaKey(CreateRsaKeyOptions createRsaKeyOptions)` Creates a new Rsa key and stores it in the key vault.
`Mono<com.azure.core.http.rest.Response<KeyVaultKey>>`	`createRsaKeyWithResponse(CreateRsaKeyOptions createRsaKeyOptions)` Creates a new Rsa key and stores it in the key vault.
`Mono<DeletedKey>`	`getDeletedKey(String name)` Gets the public part of a deleted key.
`Mono<com.azure.core.http.rest.Response<DeletedKey>>`	`getDeletedKeyWithResponse(String name)` Gets the public part of a deleted key.
`Mono<KeyVaultKey>`	`getKey(String name)` Get the public part of the latest version of the specified key from the key vault.
`Mono<KeyVaultKey>`	`getKey(String name, String version)` Gets the public part of the specified key and key version.
`Mono<com.azure.core.http.rest.Response<KeyVaultKey>>`	`getKeyWithResponse(String name, String version)` Gets the public part of the specified key and key version.
`String`	`getVaultUrl()` Get the vault endpoint url to which service requests are sent to.
`Mono<KeyVaultKey>`	`importKey(ImportKeyOptions importKeyOptions)` Imports an externally created key and stores it in key vault.
`Mono<KeyVaultKey>`	`importKey(String name, JsonWebKey keyMaterial)` Imports an externally created key and stores it in key vault.
`Mono<com.azure.core.http.rest.Response<KeyVaultKey>>`	`importKeyWithResponse(ImportKeyOptions importKeyOptions)` Imports an externally created key and stores it in key vault.
`com.azure.core.http.rest.PagedFlux<DeletedKey>`	`listDeletedKeys()` Lists `deleted keys` of the key vault.
`com.azure.core.http.rest.PagedFlux<KeyProperties>`	`listPropertiesOfKeys()` List keys in the key vault.
`com.azure.core.http.rest.PagedFlux<KeyProperties>`	`listPropertiesOfKeyVersions(String name)` List all versions of the specified key.
`Mono<Void>`	`purgeDeletedKey(String name)` Permanently deletes the specified key without the possibility of recovery.
`Mono<com.azure.core.http.rest.Response<Void>>`	`purgeDeletedKeyWithResponse(String name)` Permanently deletes the specified key without the possibility of recovery.
`Mono<KeyVaultKey>`	`restoreKeyBackup(byte[] backup)` Restores a backed up key to a vault.
`Mono<com.azure.core.http.rest.Response<KeyVaultKey>>`	`restoreKeyBackupWithResponse(byte[] backup)` Restores a backed up key to a vault.
`Mono<KeyVaultKey>`	`updateKeyProperties(KeyProperties keyProperties, KeyOperation... keyOperations)` Updates the attributes and key operations associated with the specified key, but not the cryptographic key material of the specified key in the key vault.
`Mono<com.azure.core.http.rest.Response<KeyVaultKey>>`	`updateKeyPropertiesWithResponse(KeyProperties keyProperties, KeyOperation... keyOperations)` Updates the attributes and key operations associated with the specified key, but not the cryptographic key material of the specified key in the key vault.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getVaultUrl
```
public String getVaultUrl()
```
    Get the vault endpoint url to which service requests are sent to.
    
    Returns:
    
    the vault endpoint url
  - createKey
```
public Mono<KeyVaultKey> createKey(String name,
                                   KeyType keyType)
```
    Creates a new key and stores it in the key vault. The create key operation can be used to create any key type in key vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.
    The keyType indicates the type of key to create. Possible values include: EC, EC-HSM, RSA, RSA-HSM and OCT.
    
    Code Samples
    
    Creates a new EC key. Subscribes to the call asynchronously and prints out the newly created key details when a response has been received.
```
 keyAsyncClient.createKey("keyName", KeyType.EC)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getName(),
             keyResponse.getId()));
 
```
    Parameters:
    
    name - The name of the key being created.
    
    keyType - The type of key to create. For valid values, see KeyType.
    
    Returns:
    
    A Mono containing the created key.
    
    Throws:
    
    com.azure.core.exception.ResourceModifiedException - if name or keyType is null.
    
    com.azure.core.exception.HttpResponseException - if name is empty string.
  - createKeyWithResponse
```
public Mono<com.azure.core.http.rest.Response<KeyVaultKey>> createKeyWithResponse(CreateKeyOptions createKeyOptions)
```
    Creates a new key and stores it in the key vault. The create key operation can be used to create any key type in key vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.
    The keyType indicates the type of key to create. Possible values include: EC, EC-HSM, RSA, RSA-HSM and OCT.
    
    Code Samples
    
    Creates a new EC key. Subscribes to the call asynchronously and prints out the newly created key details when a response has been received.
```
 CreateKeyOptions createKeyOptions = new CreateKeyOptions("keyName", KeyType.RSA)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));
 keyAsyncClient.createKeyWithResponse(createKeyOptions)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getValue().getName(),
             keyResponse.getValue().getId()));
 
```
    Parameters:
    
    createKeyOptions - The key configuration object containing information about the key being created.
    
    Returns:
    
    A Mono containing a Response whose value contains the created key.
    
    Throws:
    
    com.azure.core.exception.ResourceModifiedException - if name or keyType is null.
    
    com.azure.core.exception.HttpResponseException - if name is empty string.
  - createKey
```
public Mono<KeyVaultKey> createKey(CreateKeyOptions createKeyOptions)
```
    Creates a new key and stores it in the key vault. The create key operation can be used to create any key type in key vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.
    The CreateKeyOptions is required. The expires and notBefore values are optional. The enabled field is set to true by Azure Key Vault, if not specified.
    
    The keyType indicates the type of key to create. Possible values include: EC, EC-HSM, RSA, RSA-HSM and OCT.
    
    Code Samples
    
    Creates a new Rsa key which activates in one day and expires in one year. Subscribes to the call asynchronously and prints out the newly created key details when a response has been received.
```
 CreateKeyOptions createKeyOptions = new CreateKeyOptions("keyName", KeyType.RSA)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));
 keyAsyncClient.createKey(createKeyOptions)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getName(),
             keyResponse.getId()));
 
```
    Parameters:
    
    createKeyOptions - The key configuration object containing information about the key being created.
    
    Returns:
    
    A Mono containing the created key.
    
    Throws:
    
    NullPointerException - if keyCreateOptions is null.
    
    com.azure.core.exception.ResourceModifiedException - if keyCreateOptions is malformed.
  - createRsaKey
```
public Mono<KeyVaultKey> createRsaKey(CreateRsaKeyOptions createRsaKeyOptions)
```
    Creates a new Rsa key and stores it in the key vault. The create Rsa key operation can be used to create any Rsa key type in key vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.
    The CreateRsaKeyOptions is required. The keySize can be optionally specified. The expires and notBefore values are optional. The enabled field is set to true by Azure Key Vault, if not specified.
    
    The keyType indicates the type of key to create. Possible values include: RSA and RSA-HSM.
    
    Code Samples
    
    Creates a new RSA key with size 2048 which activates in one day and expires in one year. Subscribes to the call asynchronously and prints out the newly created key details when a response has been received.
```
 CreateRsaKeyOptions createRsaKeyOptions = new CreateRsaKeyOptions("keyName")
     .setKeySize(2048)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));
 keyAsyncClient.createRsaKey(createRsaKeyOptions)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getName(),
             keyResponse.getId()));
 
```
    Parameters:
    
    createRsaKeyOptions - The key configuration object containing information about the rsa key being created.
    
    Returns:
    
    A Mono containing the created key.
    
    Throws:
    
    NullPointerException - if rsaKeyCreateOptions is null.
    
    com.azure.core.exception.ResourceModifiedException - if rsaKeyCreateOptions is malformed.
  - createRsaKeyWithResponse
```
public Mono<com.azure.core.http.rest.Response<KeyVaultKey>> createRsaKeyWithResponse(CreateRsaKeyOptions createRsaKeyOptions)
```
    Creates a new Rsa key and stores it in the key vault. The create Rsa key operation can be used to create any Rsa key type in key vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.
    The CreateRsaKeyOptions is required. The keySize can be optionally specified. The expires and notBefore values are optional. The enabled field is set to true by Azure Key Vault, if not specified.
    
    The keyType indicates the type of key to create. Possible values include: RSA and RSA-HSM.
```
 CreateRsaKeyOptions createRsaKeyOptions = new CreateRsaKeyOptions("keyName")
     .setKeySize(2048)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));
 keyAsyncClient.createRsaKeyWithResponse(createRsaKeyOptions)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getValue().getName(),
             keyResponse.getValue().getId()));
 
```
    Parameters:
    
    createRsaKeyOptions - The key configuration object containing information about the rsa key being created.
    
    Returns:
    
    A Mono containing a Response whose value contains the created key.
    
    Throws:
    
    NullPointerException - if rsaKeyCreateOptions is null.
    
    com.azure.core.exception.ResourceModifiedException - if rsaKeyCreateOptions is malformed.
  - createEcKey
```
public Mono<KeyVaultKey> createEcKey(CreateEcKeyOptions createEcKeyOptions)
```
    Creates a new Ec key and stores it in the key vault. The create Ec key operation can be used to create any Ec key type in key vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.
    The CreateEcKeyOptions parameter is required. The key curve can be optionally specified. If not specified, default value of P-256 is used by Azure Key Vault. The expires and notBefore values are optional. The enabled field is set to true by Azure Key Vault, if not specified.
    
    The keyType indicates the type of key to create. Possible values include: EC and EC-HSM.
    
    Code Samples
    
    Creates a new EC key with P-384 web key curve. The key activates in one day and expires in one year. Subscribes to the call asynchronously and prints out the newly created ec key details when a response has been received.
```
 CreateEcKeyOptions createEcKeyOptions = new CreateEcKeyOptions("keyName")
     .setCurveName(KeyCurveName.P_384)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));
 keyAsyncClient.createEcKey(createEcKeyOptions)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getName(),
             keyResponse.getId()));
 
```
    Parameters:
    
    createEcKeyOptions - The key options object containing information about the ec key being created.
    
    Returns:
    
    A Mono containing the created key.
    
    Throws:
    
    NullPointerException - if ecKeyCreateOptions is null.
    
    com.azure.core.exception.ResourceModifiedException - if ecKeyCreateOptions is malformed.
  - createEcKeyWithResponse
```
public Mono<com.azure.core.http.rest.Response<KeyVaultKey>> createEcKeyWithResponse(CreateEcKeyOptions createEcKeyOptions)
```
    Creates a new Ec key and stores it in the key vault. The create Ec key operation can be used to create any Ec key type in key vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.
    The CreateEcKeyOptions parameter is required. The key curve can be optionally specified. If not specified, default value of P-256 is used by Azure Key Vault. The expires and notBefore values are optional. The enabled field is set to true by Azure Key Vault, if not specified.
    
    The keyType indicates the type of key to create. Possible values include: EC and EC-HSM.
    
    Code Samples
    
    Creates a new EC key with P-384 web key curve. The key activates in one day and expires in one year. Subscribes to the call asynchronously and prints out the newly created ec key details when a response has been received.
```
 CreateEcKeyOptions createEcKeyOptions = new CreateEcKeyOptions("keyName")
     .setCurveName(KeyCurveName.P_384)
     .setNotBefore(OffsetDateTime.now().plusDays(1))
     .setExpiresOn(OffsetDateTime.now().plusYears(1));
 keyAsyncClient.createEcKeyWithResponse(createEcKeyOptions)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getValue().getName(),
             keyResponse.getValue().getId()));
 
```
    Parameters:
    
    createEcKeyOptions - The key options object containing information about the ec key being created.
    
    Returns:
    
    A Mono containing a Response whose value contains the created key.
    
    Throws:
    
    NullPointerException - if ecKeyCreateOptions is null.
    
    com.azure.core.exception.ResourceModifiedException - if ecKeyCreateOptions is malformed.
  - importKey
```
public Mono<KeyVaultKey> importKey(String name,
                                   JsonWebKey keyMaterial)
```
    Imports an externally created key and stores it in key vault. The import key operation may be used to import any key type into the Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.
    Code Samples
    
    Imports a new key into key vault. Subscribes to the call asynchronously and prints out the newly imported key details when a response has been received.
```
 keyAsyncClient.importKey("keyName", jsonWebKeyToImport).subscribe(keyResponse ->
     System.out.printf("Key is imported with name %s and id %s \n", keyResponse.getName(), keyResponse.getId()));
 
```
    Parameters:
    
    name - The name for the imported key.
    
    keyMaterial - The Json web key being imported.
    
    Returns:
    
    A Mono containing a Response whose value contains the imported key.
    
    Throws:
    
    com.azure.core.exception.HttpResponseException - if name is empty string.
  - importKey
```
public Mono<KeyVaultKey> importKey(ImportKeyOptions importKeyOptions)
```
    Imports an externally created key and stores it in key vault. The import key operation may be used to import any key type into the Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.
    The keyImportOptions is required and its fields name and key material cannot be null. The expires and notBefore values in keyImportOptions are optional. If not specified, no values are set for the fields. The enabled field is set to true and the hsm field is set to false by Azure Key Vault, if they are not specified.
    
    Code Samples
    
    Imports a new key into key vault. Subscribes to the call asynchronously and prints out the newly imported key details when a response has been received.
```
 ImportKeyOptions options = new ImportKeyOptions("keyName", jsonWebKeyToImport)
     .setHardwareProtected(false);
 keyAsyncClient.importKey(options).subscribe(keyResponse ->
     System.out.printf("Key is imported with name %s and id %s \n", keyResponse.getName(), keyResponse.getId()));
 
```
    Parameters:
    
    importKeyOptions - The key import configuration object containing information about the json web key being imported.
    
    Returns:
    
    A Mono containing the imported key.
    
    Throws:
    
    NullPointerException - if keyImportOptions is null.
  - importKeyWithResponse
```
public Mono<com.azure.core.http.rest.Response<KeyVaultKey>> importKeyWithResponse(ImportKeyOptions importKeyOptions)
```
    Imports an externally created key and stores it in key vault. The import key operation may be used to import any key type into the Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.
    The keyImportOptions is required and its fields name and key material cannot be null. The expires and notBefore values in keyImportOptions are optional. If not specified, no values are set for the fields. The enabled field is set to true and the hsm field is set to false by Azure Key Vault, if they are not specified.
    
    Code Samples
    
    Imports a new key into key vault. Subscribes to the call asynchronously and prints out the newly imported key details when a response has been received.
```
 ImportKeyOptions importKeyOptions = new ImportKeyOptions("keyName", jsonWebKeyToImport)
     .setHardwareProtected(false);
 keyAsyncClient.importKeyWithResponse(importKeyOptions).subscribe(keyResponse ->
     System.out.printf("Key is imported with name %s and id %s \n", keyResponse.getValue().getName(),
         keyResponse.getValue().getId()));
 
```
    Parameters:
    
    importKeyOptions - The key import configuration object containing information about the json web key being imported.
    
    Returns:
    
    A Mono containing a Response whose value contains the imported key.
    
    Throws:
    
    NullPointerException - if keyImportOptions is null.
  - getKey
```
public Mono<KeyVaultKey> getKey(String name,
                                String version)
```
    Gets the public part of the specified key and key version. The get key operation is applicable to all key types and it requires the keys/get permission.
    Code Samples
    
    Gets a specific version of the key in the key vault. Subscribes to the call asynchronously and prints out the returned key details when a response has been received.
```
 String keyVersion = "6A385B124DEF4096AF1361A85B16C204";
 keyAsyncClient.getKey("keyName", keyVersion)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getName(),
             keyResponse.getId()));
 
```
    Parameters:
    
    name - The name of the key, cannot be null
    
    version - The version of the key to retrieve. If this is an empty String or null, this call is equivalent to calling KeyAsyncClient.getKey(String), with the latest version being retrieved.
    
    Returns:
    
    A Mono containing the requested key. The content of the key is null if both name and version are null or empty.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault or an empty/null name and a non null/empty version is provided.
    
    com.azure.core.exception.HttpResponseException - if a valid name and a non null/empty version is specified.
  - getKeyWithResponse
```
public Mono<com.azure.core.http.rest.Response<KeyVaultKey>> getKeyWithResponse(String name,
                                                                               String version)
```
    Gets the public part of the specified key and key version. The get key operation is applicable to all key types and it requires the keys/get permission.
    Code Samples
    
    Gets a specific version of the key in the key vault. Subscribes to the call asynchronously and prints out the returned key details when a response has been received.
```
 String keyVersion = "6A385B124DEF4096AF1361A85B16C204";
 keyAsyncClient.getKeyWithResponse("keyName", keyVersion)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n",
             keyResponse.getValue().getName(), keyResponse.getValue().getId()));
 
```
    Parameters:
    
    name - The name of the key, cannot be null
    
    version - The version of the key to retrieve. If this is an empty String or null, this call is equivalent to calling KeyAsyncClient.getKey(String), with the latest version being retrieved.
    
    Returns:
    
    A Mono containing a Response whose value contains the requested key. The content of the key is null if both name and version are null or empty.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault or an empty/null name and a non null/empty version is provided.
    
    com.azure.core.exception.HttpResponseException - if a valid name and a non null/empty version is specified.
  - getKey
```
public Mono<KeyVaultKey> getKey(String name)
```
    Get the public part of the latest version of the specified key from the key vault. The get key operation is applicable to all key types and it requires the keys/get permission.
    Code Samples
    
    Gets latest version of the key in the key vault. Subscribes to the call asynchronously and prints out the returned key details when a response has been received.
```
 keyAsyncClient.getKey("keyName")
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Key is created with name %s and id %s %n", keyResponse.getName(),
             keyResponse.getId()));
 
```
    Parameters:
    
    name - The name of the key.
    
    Returns:
    
    A Mono containing the requested key. The content of the key is null if name is null or empty.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with non null/empty name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - if a non null/empty and an invalid name is specified.
  - updateKeyPropertiesWithResponse
```
public Mono<com.azure.core.http.rest.Response<KeyVaultKey>> updateKeyPropertiesWithResponse(KeyProperties keyProperties,
                                                                                            KeyOperation... keyOperations)
```
    Updates the attributes and key operations associated with the specified key, but not the cryptographic key material of the specified key in the key vault. The update operation changes specified attributes of an existing stored key and attributes that are not specified in the request are left unchanged. The cryptographic key material of a key itself cannot be changed. This operation requires the keys/set permission.
    Code Samples
    
    Gets latest version of the key, changes its notBefore time and then updates it in the Azure Key Vault. Subscribes to the call asynchronously and prints out the returned key details when a response has been received.
```
 keyAsyncClient.getKey("keyName")
     .subscribe(keyResponse  -> {
         //Update the not before time of the key.
         keyResponse.getProperties().setNotBefore(OffsetDateTime.now().plusDays(50));
         keyAsyncClient.updateKeyPropertiesWithResponse(keyResponse.getProperties(), KeyOperation.ENCRYPT,
             KeyOperation.DECRYPT)
             .subscriberContext(Context.of(key1, value1, key2, value2))
             .subscribe(updatedKeyResponse  ->
                 System.out.printf("Key's updated not before time %s %n",
                     updatedKeyResponse.getValue().getProperties().getNotBefore().toString()));
     });
 
```
    Parameters:
    
    keyProperties - The key properties object with updated properties.
    
    keyOperations - The updated key operations to associate with the key.
    
    Returns:
    
    A Mono containing a Response whose value contains the updated key.
    
    Throws:
    
    NullPointerException - if key is null.
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name and version doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - if name or version is empty string.
  - updateKeyProperties
```
public Mono<KeyVaultKey> updateKeyProperties(KeyProperties keyProperties,
                                             KeyOperation... keyOperations)
```
    Updates the attributes and key operations associated with the specified key, but not the cryptographic key material of the specified key in the key vault. The update operation changes specified attributes of an existing stored key and attributes that are not specified in the request are left unchanged. The cryptographic key material of a key itself cannot be changed. This operation requires the keys/set permission.
    Code Samples
    
    Gets latest version of the key, changes its notBefore time and then updates it in the Azure Key Vault. Subscribes to the call asynchronously and prints out the returned key details when a response has been received.
```
 keyAsyncClient.getKey("keyName")
      .subscribe(keyResponse  -> {
          //Update the not before time of the key.
          keyResponse.getProperties().setNotBefore(OffsetDateTime.now().plusDays(50));
          keyAsyncClient.updateKeyProperties(keyResponse.getProperties(), KeyOperation.ENCRYPT,
              KeyOperation.DECRYPT)
              .subscriberContext(Context.of(key1, value1, key2, value2))
              .subscribe(updatedKeyResponse  ->
                  System.out.printf("Key's updated not before time %s %n",
                      updatedKeyResponse.getProperties().getNotBefore().toString()));
      });
 
```
    Parameters:
    
    keyProperties - The key properties object with updated properties.
    
    keyOperations - The updated key operations to associate with the key.
    
    Returns:
    
    A Mono containing the updated key.
    
    Throws:
    
    NullPointerException - if key is null.
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name and version doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - if name or version is empty string.
  - beginDeleteKey
```
public com.azure.core.util.polling.PollerFlux<DeletedKey,Void> beginDeleteKey(String name)
```
    Deletes a key of any type from the key vault. If soft-delete is enabled on the key vault then the key is placed in the deleted state and requires to be purged for permanent deletion else the key is permanently deleted. The delete operation applies to any key stored in Azure Key Vault but it cannot be applied to an individual version of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the keys/delete permission.
    Code Samples
    
    Deletes the key in the Azure Key Vault. Subscribes to the call asynchronously and prints out the deleted key details when a response has been received.
```
 keyAsyncClient.beginDeleteKey("keyName")
     .subscribe(pollResponse -> {
         System.out.println("Delete Status: " + pollResponse.getStatus().toString());
         System.out.println("Delete Key Name: " + pollResponse.getValue().getName());
         System.out.println("Key Delete Date: " + pollResponse.getValue().getDeletedOn().toString());
     });
 
```
    Parameters:
    
    name - The name of the key to be deleted.
    
    Returns:
    
    A PollerFlux to poll on the deleted key status.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - when a key with name is empty string.
  - getDeletedKey
```
public Mono<DeletedKey> getDeletedKey(String name)
```
    Gets the public part of a deleted key. The Get Deleted Key operation is applicable for soft-delete enabled vaults. This operation requires the keys/get permission.
    Code Samples
    
    Gets the deleted key from the key vault enabled for soft-delete. Subscribes to the call asynchronously and prints out the deleted key details when a response has been received.
    //Assuming key is deleted on a soft-delete enabled vault.
```
 keyAsyncClient.getDeletedKey("keyName")
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse ->
         System.out.printf("Deleted Key's Recovery Id %s", keyResponse.getRecoveryId()));
 
```
    Parameters:
    
    name - The name of the deleted key.
    
    Returns:
    
    A Mono containing the deleted key.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - when a key with name is empty string.
  - getDeletedKeyWithResponse
```
public Mono<com.azure.core.http.rest.Response<DeletedKey>> getDeletedKeyWithResponse(String name)
```
    Gets the public part of a deleted key. The Get Deleted Key operation is applicable for soft-delete enabled vaults. This operation requires the keys/get permission.
    Code Samples
    
    Gets the deleted key from the key vault enabled for soft-delete. Subscribes to the call asynchronously and prints out the deleted key details when a response has been received.
    //Assuming key is deleted on a soft-delete enabled vault.
```
 keyAsyncClient.getDeletedKeyWithResponse("keyName")
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(deletedKeyResponse ->
         System.out.printf("Deleted Key's Recovery Id %s", deletedKeyResponse.getValue().getRecoveryId()));
 
```
    Parameters:
    
    name - The name of the deleted key.
    
    Returns:
    
    A Mono containing a Response whose value contains the deleted key.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - when a key with name is empty string.
  - purgeDeletedKey
```
public Mono<Void> purgeDeletedKey(String name)
```
    Permanently deletes the specified key without the possibility of recovery. The Purge Deleted Key operation is applicable for soft-delete enabled vaults. This operation requires the keys/purge permission.
    Code Samples
    
    Purges the deleted key 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 has been received.
    //Assuming key is deleted on a soft-delete enabled vault.
```
 keyAsyncClient.purgeDeletedKey("deletedKeyName")
     .subscribe(purgeResponse ->
         System.out.println("Successfully Purged deleted Key"));
 
```
    Parameters:
    
    name - The name of the deleted key.
    
    Returns:
    
    An empty Mono.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - when a key with name is empty string.
  - purgeDeletedKeyWithResponse
```
public Mono<com.azure.core.http.rest.Response<Void>> purgeDeletedKeyWithResponse(String name)
```
    Permanently deletes the specified key without the possibility of recovery. The Purge Deleted Key operation is applicable for soft-delete enabled vaults. This operation requires the keys/purge permission.
    Code Samples
    
    Purges the deleted key 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 has been received.
    //Assuming key is deleted on a soft-delete enabled vault.
```
 keyAsyncClient.purgeDeletedKeyWithResponse("deletedKeyName")
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(purgeResponse ->
         System.out.printf("Purge Status response %d %n", purgeResponse.getStatusCode()));
 
```
    Parameters:
    
    name - The name of the deleted key.
    
    Returns:
    
    A Mono containing a Response containing status code and HTTP headers.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - when a key with name is empty string.
  - beginRecoverDeletedKey
```
public com.azure.core.util.polling.PollerFlux<KeyVaultKey,Void> beginRecoverDeletedKey(String name)
```
    Recovers the deleted key in the key vault to its latest version and can only be performed on a soft-delete enabled vault. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.
    Code Samples
    
    Recovers the deleted key from the key vault enabled for soft-delete. Subscribes to the call asynchronously and prints out the recovered key details when a response has been received.
    //Assuming key is deleted on a soft-delete enabled vault.
```
 keyAsyncClient.beginRecoverDeletedKey("deletedKeyName")
     .subscribe(pollResponse -> {
         System.out.println("Recovery Status: " + pollResponse.getStatus().toString());
         System.out.println("Recover Key Name: " + pollResponse.getValue().getName());
         System.out.println("Recover Key Type: " + pollResponse.getValue().getKeyType());
     });
 
```
    Parameters:
    
    name - The name of the deleted key to be recovered.
    
    Returns:
    
    A PollerFlux to poll on the recovered key status.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - when a key with name is empty string.
  - backupKey
```
public Mono<byte[]> backupKey(String name)
```
    Requests a backup of the specified key be downloaded to the client. The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does not return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to generate a key in one Azure Key Vault instance, backup the key, and then restore it into another Azure Key Vault instance. The backup operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. Backup / Restore can be performed within geographical boundaries only; meaning that a backup from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission.
    Code Samples
    
    Backs up the key from the key vault. Subscribes to the call asynchronously and prints out the length of the key's backup byte array returned in the response.
```
 keyAsyncClient.backupKey("keyName")
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyBackupResponse ->
         System.out.printf("Key's Backup Byte array's length %s %n", keyBackupResponse.length));
 
```
    Parameters:
    
    name - The name of the key.
    
    Returns:
    
    A Mono containing the backed up key blob.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - when a key with name is empty string.
  - backupKeyWithResponse
```
public Mono<com.azure.core.http.rest.Response<byte[]>> backupKeyWithResponse(String name)
```
    Requests a backup of the specified key be downloaded to the client. The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does not return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to generate a key in one Azure Key Vault instance, backup the key, and then restore it into another Azure Key Vault instance. The backup operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. Backup / Restore can be performed within geographical boundaries only; meaning that a backup from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission.
    Code Samples
    
    Backs up the key from the key vault. Subscribes to the call asynchronously and prints out the length of the key's backup byte array returned in the response.
```
 keyAsyncClient.backupKeyWithResponse("keyName")
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyBackupResponse ->
         System.out.printf("Key's Backup Byte array's length %s %n", keyBackupResponse.getValue().length));
 
```
    Parameters:
    
    name - The name of the key.
    
    Returns:
    
    A Mono containing a Response whose value contains the backed up key blob.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a key with name doesn't exist in the key vault.
    
    com.azure.core.exception.HttpResponseException - when a key with name is empty string.
  - restoreKeyBackup
```
public Mono<KeyVaultKey> restoreKeyBackup(byte[] backup)
```
    Restores a backed up key to a vault. Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The restore operation may be used to import a previously backed up key. The individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the restore operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The restore operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have restore permission in the target Key Vault. This operation requires the keys/restore permission.
    Code Samples
    
    Restores the key in the key vault from its backup. Subscribes to the call asynchronously and prints out the restored key details when a response has been received.
    //Pass the Key Backup Byte array to the restore operation.
```
 byte[] keyBackupByteArray = {};
 keyAsyncClient.restoreKeyBackup(keyBackupByteArray)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse  ->
         System.out.printf("Restored Key with name %s and id %s %n", keyResponse.getName(),
             keyResponse.getId()));
 
```
    Parameters:
    
    backup - The backup blob associated with the key.
    
    Returns:
    
    A Mono containing the restored key.
    
    Throws:
    
    com.azure.core.exception.ResourceModifiedException - when backup blob is malformed.
  - restoreKeyBackupWithResponse
```
public Mono<com.azure.core.http.rest.Response<KeyVaultKey>> restoreKeyBackupWithResponse(byte[] backup)
```
    Restores a backed up key to a vault. Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The restore operation may be used to import a previously backed up key. The individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the restore operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The restore operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have restore permission in the target Key Vault. This operation requires the keys/restore permission.
    Code Samples
    
    Restores the key in the key vault from its backup. Subscribes to the call asynchronously and prints out the restored key details when a response has been received.
    //Pass the Key Backup Byte array to the restore operation.
```
 byte[] keyBackupByteArray = {};
 keyAsyncClient.restoreKeyBackupWithResponse(keyBackupByteArray)
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyResponse  ->
         System.out.printf("Restored Key with name %s and id %s %n", keyResponse.getValue().getName(),
             keyResponse.getValue().getId()));
 
```
    Parameters:
    
    backup - The backup blob associated with the key.
    
    Returns:
    
    A Mono containing a Response whose value contains the restored key.
    
    Throws:
    
    com.azure.core.exception.ResourceModifiedException - when backup blob is malformed.
  - listPropertiesOfKeys
```
public com.azure.core.http.rest.PagedFlux<KeyProperties> listPropertiesOfKeys()
```
    List keys in the key vault. Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The List operation is applicable to all key types and the individual key response in the flux is represented by KeyProperties as only the key identifier, attributes and tags are provided in the response. The key material and individual key versions are not listed in the response. This operation requires the keys/list permission.
    It is possible to get full keys with key material from this information. Convert the Flux containing key properties to Flux containing key using KeyAsyncClient.getKey(String, String) within Flux.flatMap(Function).
```
 keyAsyncClient.listPropertiesOfKeys()
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyProperties -> keyAsyncClient.getKey(keyProperties.getName(), keyProperties.getVersion())
         .subscribe(keyResponse -> System.out.printf("Received key with name %s and type %s",
             keyResponse.getName(),
              keyResponse.getKeyType())));
 
```
    Returns:
    
    A PagedFlux containing key of all the keys in the vault.
  - listDeletedKeys
```
public com.azure.core.http.rest.PagedFlux<DeletedKey> listDeletedKeys()
```
    Lists deleted keys of the key vault. The deleted keys are retrieved as JSON Web Key structures that contain the public part of a deleted key. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. This operation requires the keys/list permission.
    Code Samples
    
    Lists the deleted keys in the key vault. Subscribes to the call asynchronously and prints out the recovery id of each deleted key when a response has been received.
```
 keyAsyncClient.listDeletedKeys()
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(deletedKey  -> System.out.printf("Deleted key's recovery Id %s", deletedKey.getRecoveryId()));
 
```
    Returns:
    
    A PagedFlux containing all of the deleted keys in the vault.
  - listPropertiesOfKeyVersions
```
public com.azure.core.http.rest.PagedFlux<KeyProperties> listPropertiesOfKeyVersions(String name)
```
    List all versions of the specified key. The individual key response in the flux is represented by KeyProperties as only the key identifier, attributes and tags are provided in the response. The key material values are not provided in the response. This operation requires the keys/list permission.
    It is possible to get the keys with key material of all the versions from this information. Convert the Flux containing key properties to Flux containing key using KeyAsyncClient.getKey(String, String) within Flux.flatMap(Function).
```
 keyAsyncClient.listPropertiesOfKeyVersions("keyName")
     .subscriberContext(Context.of(key1, value1, key2, value2))
     .subscribe(keyProperties -> keyAsyncClient.getKey(keyProperties.getName(), keyProperties.getVersion())
         .subscribe(keyResponse ->
             System.out.printf("Received key's version with name %s, type %s and version %s",
                 keyResponse.getName(),
                 keyResponse.getKeyType(), keyResponse.getProperties().getVersion())));
 
```
    Parameters:
    
    name - The name of the key.
    
    Returns:
    
    A PagedFlux containing key of all the versions of the specified key in the vault. Flux is empty if key with name does not exist in key vault.
    
    Throws:
    
    com.azure.core.exception.ResourceNotFoundException - when a given key name is null or an empty string.

Class KeyAsyncClient

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getVaultUrl

createKey

createKeyWithResponse

createKey

createRsaKey

createRsaKeyWithResponse

createEcKey

createEcKeyWithResponse

importKey

importKey

importKeyWithResponse

getKey

getKeyWithResponse

getKey

updateKeyPropertiesWithResponse

updateKeyProperties

beginDeleteKey

getDeletedKey

getDeletedKeyWithResponse

purgeDeletedKey

purgeDeletedKeyWithResponse

beginRecoverDeletedKey

backupKey

backupKeyWithResponse

restoreKeyBackup

restoreKeyBackupWithResponse

listPropertiesOfKeys

listDeletedKeys

listPropertiesOfKeyVersions