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.
-
Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.
-
Select the CLOUDKEYS icon on the toolbar.
-
Select the Key Sets tab.
-
Select Actions > Create Key Set.
The Choose the type of keys… dialog appears. -
Choose Azure Key.
The Create Key Set dialog appears. -
In the Details tab, enter a Name and Description.
-
From the Admin Group drop-down menu, select Cloud Admin Group.
For example:
-
Select Continue.
-
In the CSP Account tab, select the CSP account created in Create a CSP account for Azure in Key Management Vault.
For example:
-
Select Continue.
-
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. -
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:
-
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:
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.
-
Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.
-
Select the CLOUDKEYS icon on the toolbar.
-
Select the CloudKeys tab.
-
In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.
-
In the Type menu, select Key Vault.
For example:
-
Select Actions > Create CloudKey. The Create CloudKey dialog appears.
-
In the Key Vault menu, select your Azure Key Vault.
For this integration test, select the vault created in Create an Azure key vault. -
In the Details tab, enter a Name and Description. Then select Continue.
For example:
-
In the Settings tab, select the required Cipher and then select Continue.
For example:
-
In the Schedule tab, select the Rotation Schedule, Activation Date, and Expiration, and then select Continue.
For example:
-
In the Alerts tab, configure the alerts as required then select Apply.
The cloud key is created.
-
Verify that the cloud key created in Key Management Vault is available in Azure Key Vault.
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.
-
Navigate to Home > Key vaults > <key-vault> > Keys > Generate/Import.
The Create a key dialog appears. -
Enter a Name and configure the required key properties, then select Create.
For example:
-
Verify the newly created key.
For example:
To import the cloud key created in Azure into Key Management Vault:
-
Sign in to the Key Management Vault URL you created a bookmark for in Create a vault for cloud keys in Key Management Vault.
-
Select the CLOUDKEYS icon on the toolbar.
-
Select the Key Sets tab.
-
Select the key set created in Create a key set in Key Management Vault.
-
Select Actions > Import CloudKey.
The Import Cloud Keys dialog appears. -
In the Type menu, select Key Vault.
-
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:
-
Verify that the cloud key created in Azure Key Vault is available in Key Management Vault.
Rotate a cloud key in Key Management Vault
-
Sign in to the Key Management Vault URL you created a bookmark for in Create a vault for cloud keys in Key Management Vault.
-
Select the CLOUDKEYS icon on the toolbar.
-
Select the CloudKeys tab.
-
In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.
-
In the Type menu, select Key Vault.
-
Select the key to rotate and then scroll down until you see the Rotate Now control. Make a note of the Last Rotation date.
-
Select Rotate Now.
Verify that the Last Rotation date has been updated.
For example:
…
-
In Azure, navigate to Home > Key vaults > <key-vault> > Keys.
-
Select the key that you rotated in Key Management Vault.
-
Compare the OLDER VERSIONS with the CURRENT VERSION to verify that the key has been rotated.
For example:
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.
-
Sign in to the Key Management Vault URL you created a bookmark for in Create a vault for cloud keys in Key Management Vault.
-
Select the CLOUDKEYS icon on the toolbar.
-
Select the CloudKeys tab.
-
In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.
-
In the Type menu, select Key Vault.
-
Select the key to be removed.
-
Select Actions > Remove from Cloud.
The Remove from Cloud dialog appears. -
Enter the name of the cloud key in Type CloudKey Name, then select Remove.
For example:
-
Verify the status change in Key Management Vault.
For example:
-
Verify that the key is no longer available in Azure.
For example:
For additional information, see Removing a CloudKey.
Upload a removed cloud key to Azure
-
Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.
-
Select the CLOUDKEYS icon on the toolbar.
-
Select the CloudKeys tab.
-
In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.
-
In the Type menu, select Key Vault.
-
Select the key to be uploaded.
-
Select Actions > Upload to Cloud.
-
In the Upload to Cloud dialog, select Upload.
For example:
-
Verify the status change in Key Management Vault.
For example:
-
Verify that the key is now available in Azure.
For example:
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.
-
Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.
-
Select the CLOUDKEYS icon on the toolbar.
-
Select the CloudKeys tab.
-
In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.
-
In the Type menu, select Key Vault.
-
Select the key to be deleted.
-
Select Actions > Delete CloudKey.
The Delete CloudKey dialog appears. -
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:
-
Verify that the status has changed to "PENDING DELETE" in Key Management Vault.
For example:
-
Verify that the key is no longer available in Azure.
For example:
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.
-
Sign in to the Key Management Vault you created a bookmark for in Create a vault for cloud keys in Key Management Vault.
-
Select the CLOUDKEYS icon on the toolbar.
-
Select the CloudKeys tab.
-
In the Key Set menu, select the Key Set created in Create a key set in Key Management Vault.
-
In the Type menu, select Key Vault.
-
Select the key that you no longer want to delete.
-
Select Actions > Cancel Deletion.
-
In the Cancel Deletion dialog, select Yes, Cancel Deletion.
For example:
-
Verify that the status has changed back to "AVAILABLE" in Key Management Vault.
For example:
-
Verify the key is now available in Azure.
For example:
For additional information, see Canceling a CloudKey Deletion.