Test the integration

Create a key set in Key Management Vault

This key set is used to create a cloud key in Key Management Vault.

  1. Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.

  2. Select the CLOUDKEYS icon on the toolbar.

  3. Select the Key Sets tab.

  4. Select Actions > Create Key Set.
    The Choose the type of keys…​ dialog appears.

  5. Choose Azure Key.
    The Create Key Set dialog appears.

  6. In the Details tab, enter a Name and Description.

  7. From the Admin Group drop-down menu, select Cloud Admin Group.

    For example:

    kmv create key set 1
  8. Select Continue.

  9. In the CSP Account tab, select the CSP account created in Create a CSP account for Azure in Key Management Vault.

    For example:

    kmv create key set 2
  10. Select Continue.

  11. If you are using an HSM, in the HSM tab, select Enable HSM, then select Continue.

    You must have configured the HSM before performing this step.
  12. In the Schedule tab, select a Rotation Schedule matching the selection made during Create an Azure client secret then select Apply.

    The key set is added.

    For example:

    kmv create key set 3
  13. Verify that the Azure Key Vault created in Create an Azure key vault is listed in the Key Vault tab with the setting Accessible set to Yes.

    For example:

    kmv create key set 4

For more information, see Creating a Key Set.

Create a cloud key in Key Management Vault

The following steps create a cloud key in Key Management Vault and verify that it is available in Azure Key Vault.

  1. Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.

  2. Select the CLOUDKEYS icon on the toolbar.

  3. Select the CloudKeys tab.

  4. In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.

  5. In the Type menu, select Key Vault.

    For example:

    kmv create cloudkey 1
  6. Select Actions > Create CloudKey. The Create CloudKey dialog appears.

  7. In the Key Vault menu, select your Azure Key Vault.
    For this integration test, select the vault created in Create an Azure key vault.

  8. In the Details tab, enter a Name and Description. Then select Continue.

    For example:

    kmv create cloudkey 2
  9. In the Settings tab, select the required Cipher and then select Continue.

    For example:

    kmv create cloudkey 3
  10. In the Schedule tab, select the Rotation Schedule, Activation Date, and Expiration, and then select Continue.

    For example:

    kmv create cloudkey 4
  11. In the Alerts tab, configure the alerts as required then select Apply.

    The cloud key is created.

    kmv create cloudkey 5
  12. Verify that the cloud key created in Key Management Vault is available in Azure Key Vault.

    kmv create cloudkey 6

For additional information, see Creating a CloudKey.

Create a cloud key in Azure Key Vault

The following steps create a cloud key in Azure Key Vault and import it into Key Management Vault.

  1. Navigate to Home > Key vaults > <key-vault> > Keys > Generate/Import.
    The Create a key dialog appears.

  2. Enter a Name and configure the required key properties, then select Create.

    For example:

    azure create cloudkey 1
  3. Verify the newly created key.

    For example:

    azure create cloudkey 2

To import the cloud key created in Azure into Key Management Vault:

  1. Sign in to the Key Management Vault URL you created a bookmark for in Create a vault for cloud keys in Key Management Vault.

  2. Select the CLOUDKEYS icon on the toolbar.

  3. Select the Key Sets tab.

  4. Select the key set created in Create a key set in Key Management Vault.

  5. Select Actions > Import CloudKey.
    The Import Cloud Keys dialog appears.

  6. In the Type menu, select Key Vault.

  7. In the Key Vault menu, select your Azure Key Vault then select Import.
    For this integration test, select the vault created in Create an Azure key vault.

    For example:

    azure create cloudkey 3
  8. Verify that the cloud key created in Azure Key Vault is available in Key Management Vault.

    azure create cloudkey 4

Rotate a cloud key in Key Management Vault

  1. Sign in to the Key Management Vault URL you created a bookmark for in Create a vault for cloud keys in Key Management Vault.

  2. Select the CLOUDKEYS icon on the toolbar.

  3. Select the CloudKeys tab.

  4. In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.

  5. In the Type menu, select Key Vault.

  6. Select the key to rotate and then scroll down until you see the Rotate Now control. Make a note of the Last Rotation date.

  7. Select Rotate Now.

    Verify that the Last Rotation date has been updated.

    For example:

    kmv key rotation 1

    …​

    kmv key rotation 2
  8. In Azure, navigate to Home > Key vaults > <key-vault> > Keys.

  9. Select the key that you rotated in Key Management Vault.

  10. Compare the OLDER VERSIONS with the CURRENT VERSION to verify that the key has been rotated.

    For example:

    kmv key rotation 3

For additional information, see Rotating keys.

Remove a cloud key in Key Management Vault

A removed cloud key is no longer be available for use in Azure. However, Key Management Vault keeps a copy of the removed cloud key, which can be reloaded to Azure and will be available for use again.

  1. Sign in to the Key Management Vault URL you created a bookmark for in Create a vault for cloud keys in Key Management Vault.

  2. Select the CLOUDKEYS icon on the toolbar.

  3. Select the CloudKeys tab.

  4. In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.

  5. In the Type menu, select Key Vault.

  6. Select the key to be removed.

  7. Select Actions > Remove from Cloud.
    The Remove from Cloud dialog appears.

  8. Enter the name of the cloud key in Type CloudKey Name, then select Remove.

    For example:

    kmv remove cloudkey 1
  9. Verify the status change in Key Management Vault.

    For example:

    kmv remove cloudkey 2
  10. Verify that the key is no longer available in Azure.

    For example:

    kmv remove cloudkey 3

For additional information, see Removing a CloudKey.

Upload a removed cloud key to Azure

  1. Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.

  2. Select the CLOUDKEYS icon on the toolbar.

  3. Select the CloudKeys tab.

  4. In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.

  5. In the Type menu, select Key Vault.

  6. Select the key to be uploaded.

  7. Select Actions > Upload to Cloud.

  8. In the Upload to Cloud dialog, select Upload.

    For example:

    kmv upload removed cloudkey 1
  9. Verify the status change in Key Management Vault.

    For example:

    kmv upload removed cloudkey 2
  10. Verify that the key is now available in Azure.

    For example:

    kmv upload removed cloudkey 3

Delete a cloud key in Key Management Vault

The deletion of a cloud key does not take effect immediately. When deleting a key, you specify the period after which the key will be permanently deleted.

  1. Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.

  2. Select the CLOUDKEYS icon on the toolbar.

  3. Select the CloudKeys tab.

  4. In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.

  5. In the Type menu, select Key Vault.

  6. Select the key to be deleted.

  7. Select Actions > Delete CloudKey.
    The Delete CloudKey dialog appears.

  8. Select a period of time after which the key will be permanently deleted in Define when the CloudKey should be permanently deleted, then select Delete.

    For example:

    kmv delete cloudkey 1
  9. Verify that the status has changed to "PENDING DELETE" in Key Management Vault.

    For example:

    kmv delete cloudkey 2
  10. Verify that the key is no longer available in Azure.

    For example:

    kmv delete cloudkey 3

For additional information, see Deleting a CloudKey.

Cancel a cloud key deletion in Key Management Vault

You can cancel key deletion before the period specified in Define when the CloudKey should be permanently deleted expires.

  1. Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.

  2. Select the CLOUDKEYS icon on the toolbar.

  3. Select the CloudKeys tab.

  4. In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.

  5. In the Type menu, select Key Vault.

  6. Select the key that you no longer want to delete.

  7. Select Actions > Cancel Deletion.

  8. In the Cancel Deletion dialog, select Yes, Cancel Deletion.

    For example:

    kmv cancel deletion cloudkey 1
  9. Verify that the status has changed back to "AVAILABLE" in Key Management Vault.

    For example:

    kmv cancel deletion cloudkey 2
  10. Verify the key is now available in Azure.

    For example:

    kmv cancel deletion cloudkey 3

For additional information, see Canceling a CloudKey Deletion.