Merge pull request #101103 from SnehaGunda/master

Updates to customer-managed keys article

Author: GitHubber17

articles/cosmos-db/how-to-setup-cmk.md

@@ -1,98 +1,101 @@
 ---
 title: Configure customer-managed keys for your Azure Cosmos DB account
-description: Learn how to configure customer-managed keys for your Azure Cosmos DB account
+description: Learn how to configure customer-managed keys for your Azure Cosmos DB account with Azure Key Vault
 author: ThomasWeiss
 ms.service: cosmos-db
 ms.topic: conceptual
-ms.date: 01/11/2020
+ms.date: 01/14/2020
 ms.author: thweiss
 ROBOTS: noindex, nofollow
 ---
 
-# Configure customer-managed keys for your Azure Cosmos DB account
+# Configure customer-managed keys for your Azure Cosmos account with Azure Key Vault
 
 > [!NOTE]
 > At this time, you must request access to use this capability. To do so, please contact [[email protected]](mailto:[email protected]).
 
-Data stored in your Azure Cosmos DB account is automatically and seamlessly encrypted. Azure Cosmos DB offers two options for managing the keys used to encrypt your data at rest:
-- **Service-managed keys**. By default, Microsoft manages the keys used to encrypt your Azure Cosmos DB account.
-- **Customer-managed keys (CMK)**. You can optionally choose to add a second layer of encryption with keys you manage.
+Data stored in your Azure Cosmos account is automatically and seamlessly encrypted. Azure Cosmos DB offers two options to manage the keys used to encrypt the data at rest:
 
-Customer-managed keys must be stored in [Azure Key Vault](../key-vault/key-vault-overview.md). A key must be provided for each CMK-enabled account and is used to encrypt all the data stored in that account.
+- **Service-managed keys** - By default, Microsoft manages the keys that are used to encrypt the data in your Azure Cosmos account.
 
-## Setup
+- **Customer-managed keys (CMK)**- You can optionally choose to add a second layer of encryption with your own keys.
 
-Currently, customer-managed keys are only available for new accounts and need to be set up during account creation.
+You must store customer-managed keys in the [Azure Key Vault](../key-vault/key-vault-overview.md) and provide a key for each Azure Cosmos account that is enabled with customer-managed keys. This key is used to encrypt all the data stored in that account.
 
-### 1. Make sure the Azure Cosmos DB resource provider is registered for your Azure subscription
+> [!NOTE]
+> Currently, customer-managed keys are only available for new Azure Cosmos accounts and you should configure them during account creation.
+
+## <a id="register-resource-provider"></a> Register the Azure Cosmos DB resource provider for your Azure subscription
 
-From the Azure portal, go to your Azure subscription and select **Resource providers** from the left menu:
+1. Sign into the [Azure portal](https://portal.azure.com/), go to your Azure subscription and select **Resource providers** under the **Settings** tab:
 
-!["Resource providers" entry from the left menu](./media/how-to-setup-cmk/portal-rp.png)
+   !["Resource providers" entry from the left menu](./media/how-to-setup-cmk/portal-rp.png)
 
-Search for the **Microsoft.DocumentDB** resource provider.
-- If the resource provider is already marked as registered, nothing needs to be done.
-- If not, select it and click on **Register**:
+1. Search for the **Microsoft.DocumentDB** resource provider. Verify if the resource provider is already marked as registered. If not, choose the resource provider and select **Register**:
 
-    ![Registering the Microsoft.DocumentDB resource provider](./media/how-to-setup-cmk/portal-rp-register.png)
+   ![Registering the Microsoft.DocumentDB resource provider](./media/how-to-setup-cmk/portal-rp-register.png)
 
-### 2. Configure your Azure Key Vault instance
+## Configure your Azure Key Vault instance
 
-Using customer-managed keys with Azure Cosmos DB requires two properties to be set on the Azure Key Vault instance you plan to use to host your encryption keys: **Soft Delete** and **Do Not Purge**. These properties aren't enabled by default but can be enabled using either PowerShell or the Azure CLI.
+Using customer-managed keys with Azure Cosmos DB requires you to set two properties on the Azure Key Vault instance that you plan to use to host your encryption keys. These properties include **Soft Delete** and **Do Not Purge**. These properties aren't enabled by default, you can enable them by using either PowerShell or the Azure CLI.
+
+To learn how to enable these properties on an existing Azure Key Vault instance, see the "Enabling soft-delete" and "Enabling Purge Protection" sections in one of the following articles:
 
-To learn how to enable these properties on an existing Azure Key Vault instance, see the sections titled Enabling soft-delete and Enabling Purge Protection in one of the following articles:
 - [How to use soft-delete with PowerShell](../key-vault/key-vault-soft-delete-powershell.md)
 - [How to use soft-delete with Azure CLI](../key-vault/key-vault-soft-delete-cli.md)
 
-### 3. Add an access policy to your Azure Key Vault instance
+## Add an access policy to your Azure Key Vault instance
+
+1. From the Azure portal, go to the Azure Key Vault instance that you plan to use to host your encryption keys. Select **Access Policies** from the left menu:
 
-From the Azure portal, go to the Azure Key Vault instance you plan to use to host your encryption keys. Then, select **Access Policies** from the left menu:
+   !["Access policies" from the left menu](./media/how-to-setup-cmk/portal-akv-ap.png)
 
-!["Access policies" from the left menu](./media/how-to-setup-cmk/portal-akv-ap.png)
+1. Select **+ Add Access Policy**
 
-- Select **+ Add Access Policy**
-- Under the **Key permissions** dropdown menu, select **Get**, **Unwrap Key** and **Wrap Key**:
+1. Under the **Key permissions** dropdown menu, select **Get**, **Unwrap Key** and **Wrap Key** permissions:
 
-    ![Selecting the right permissions](./media/how-to-setup-cmk/portal-akv-add-ap-perm2.png)
+   ![Selecting the right permissions](./media/how-to-setup-cmk/portal-akv-add-ap-perm2.png)
 
-- Under **Select principal**, select **None selected**. Then, search for and select the **Azure Cosmos DB** principal. Finally, click **Select** at the bottom (if the **Azure Cosmos DB** principal can't be found, you may need to re-register the **Microsoft.DocumentDB** resource provider at step 1):
+1. Under **Select principal**, select **None selected**. Then, search for **Azure Cosmos DB** principal and select it. Finally, click **Select** at the bottom (if the **Azure Cosmos DB** principal isn't in the list, you may need to re-register the **Microsoft.DocumentDB** resource provider as described in [register the resource provider](#register-resource-provider) section of this article):
 
-    ![Selecting the Azure Cosmos DB principal](./media/how-to-setup-cmk/portal-akv-add-ap.png)
+   ![Select the Azure Cosmos DB principal](./media/how-to-setup-cmk/portal-akv-add-ap.png)
 
-- Select **Add** to add the new access policy
+1. Select **Add** to add the new access policy
 
-### 4. Generate a key in Azure Key Vault
+## Generate a key in Azure Key Vault
 
-From the Azure portal, go the Azure Key Vault instance you plan to use to host your encryption keys. Then, select **Keys** from the left menu:
+1. From the Azure portal, go the Azure Key Vault instance that you plan to use to host your encryption keys. Then, select **Keys** from the left menu:
 
-!["Keys" entry from the left menu](./media/how-to-setup-cmk/portal-akv-keys.png)
+   !["Keys" entry from the left menu](./media/how-to-setup-cmk/portal-akv-keys.png)
 
-- Select **Generate/Import**
-- Provide a name for the new key, select an RSA key size (a minimum of 3072 is recommended for best security) and select **Create**:
+1. Select **Generate/Import**, provide a name for the new key, select an RSA key size (a minimum of 3072 is recommended for best security), and then select **Create**:
 
-    ![Creating a new key](./media/how-to-setup-cmk/portal-akv-gen.png)
+   ![Create a new key](./media/how-to-setup-cmk/portal-akv-gen.png)
 
-- Once the key is created, click on the newly created key, then on its current version
-- Copy the key’s **Key Identifier** except the part after the last forward slash:
+1. After the key is created, select the newly created key, and then on its current version.
 
-    ![Copying the key's key identifier](./media/how-to-setup-cmk/portal-akv-keyid.png)
+1. Copy the key’s **Key Identifier** except the part after the last forward slash:
 
-### 5. Create a new Azure Cosmos DB account
+   ![Copying the key's key identifier](./media/how-to-setup-cmk/portal-akv-keyid.png)
 
-#### Using the Azure portal
+## Create a new Azure Cosmos account
 
-When creating a new Azure Cosmos DB account from the Azure portal, choose **Customer-managed key** at the **Encryption** step. In the **Key URI** field, pass the URI of the Azure Key Vault key copied from step 4:
+### Using the Azure portal
+
+When creating a new Azure Cosmos DB account from the Azure portal, choose **Customer-managed key** in the **Encryption** step. In the **Key URI** field, paste the URI/key identifier of the Azure Key Vault key that you copied from the previous step:
 
 ![Setting CMK parameters in the Azure portal](./media/how-to-setup-cmk/portal-cosmos-enc.png)
 
-#### Using PowerShell
+### Using Azure PowerShell
 
 When creating a new Azure Cosmos DB account with PowerShell,
-- pass the URI of the Azure Key Vault key copied from step 4 under the **keyVaultKeyUri** property in the **PropertyObject**,
-- make sure to use "2019-12-12" as the API version.
+
+- Pass the URI of the Azure Key Vault key copied from earlier under the **keyVaultKeyUri** property in the **PropertyObject**
+
+- Use **2019-12-12** as the API version.
 
 > [!IMPORTANT]
-> The `Location` parameter has to be set explicitly for the account to be successfully created with CMK.
+> You must set the `Location` parameter explicitly for the account to be successfully created with customer-managed keys.
 
 ```powershell
 $resourceGroupName = "myResourceGroup"
@@ -114,14 +117,16 @@ New-AzResource -ResourceType "Microsoft.DocumentDb/databaseAccounts" `
     -Location $accountLocation -Name $accountName -PropertyObject $CosmosDBProperties
 ```
 
-#### Using Azure Resource Manager templates
+### Using Azure Resource Manager template
 
-When creating a new Azure Cosmos DB account through an Azure Resource Manager template:
-- pass the URI of the Azure Key Vault key copied from step 4 under the **keyVaultKeyUri** property in the **properties** object
-- make sure to use "2019-12-12" as the API version
+When creating a new Azure Cosmos account through an Azure Resource Manager template:
+
+- Pass the URI of the Azure Key Vault key that you copied earlier under the **keyVaultKeyUri** property in the **properties** object.
+
+- Use **2019-12-12** as the API version.
 
 > [!IMPORTANT]
-> The `location` parameter has to be set explicitly for the account to be successfully created with CMK.
+> You must set the `Location` parameter explicitly for the account to be successfully created with customer-managed keys.
 
 ```json
 {
@@ -163,6 +168,8 @@ When creating a new Azure Cosmos DB account through an Azure Resource Manager te
 
 ```
 
+Deploy the template with the following PowerShell script:
+
 ```powershell
 $resourceGroupName = "myResourceGroup"
 $accountName = "mycosmosaccount"
@@ -181,33 +188,37 @@ New-AzResourceGroupDeployment `
 
 ### Is there any additional charge when using customer-managed keys?
 
-Yes. To account for the additional compute load that is required to manage data encryption and decryption with customer-managed keys, all operations executed against the Azure Cosmos DB account get a 25% increase in [Request Units](./request-units.md) consumed.
+Yes. To account for the additional compute load that is required to manage data encryption and decryption with customer-managed keys, all operations executed against the Azure Cosmos account consume a 25% increase in [Request Units](./request-units.md).
+
+### What data gets encrypted with the customer-managed keys?
+
+All the data stored in your Azure Cosmos account is encrypted with the customer-managed keys, except for the following meta-data:
+
+- The names of your Azure Cosmos DB [accounts, databases, and containers](./account-overview.md#elements-in-an-azure-cosmos-account)
+
+- The names of your [stored procedures](./stored-procedures-triggers-udfs.md)
 
-### What data gets encrypted with the CMK?
+- The property paths declared in your [indexing policies](./index-policy.md)
 
-All the data stored in your Azure Cosmos DB account gets encrypted with the CMK, except for the following meta-data:
-- the names of your Azure Cosmos DB [accounts, databases and containers](./account-overview.md#elements-in-an-azure-cosmos-account),
-- the names of your [stored procedures](./stored-procedures-triggers-udfs.md),
-- the property paths declared in your [indexing policies](./index-policy.md),
-- the values of your containers' [partition key](./partitioning-overview.md).
+- The values of your containers' [partition key](./partitioning-overview.md)
 
-### Will customer-managed keys be supported for existing accounts?
+### Are customer-managed keys supported for existing Azure Cosmos accounts?
 
 This feature is currently available for new accounts only.
 
 ### Is there a plan to support finer granularity than account-level keys?
 
 Not currently, however container-level keys are being considered.
 
-### How does customer-managed keys affect backups?
+### How does customer-managed keys affect a backup?
 
-Azure Cosmos DB takes [regular and automatic backups](./online-backup-and-restore.md) of the data stored in your account. This operation backs up the encrypted data. For a restored backup to be usable, the encryption key used at the time of the backup must still be available. This means that no revocation shall have been made and the version of the key that was used at the time of the backup shall still be enabled.
+Azure Cosmos DB takes [regular and automatic backups](./online-backup-and-restore.md) of the data stored in your account. This operation backs up the encrypted data. To use the restored backup, the encryption key that you used at the time of the backup is required. This means that no revocation shall have been made and the version of the key that was used at the time of the backup shall still be enabled.
 
 ### How do I revoke an encryption key?
 
 Key revocation is done by disabling the latest version of the key:
 
-![Disabling a key's version](./media/how-to-setup-cmk/portal-akv-rev2.png)
+![Disable a key's version](./media/how-to-setup-cmk/portal-akv-rev2.png)
 
 Alternatively, to revoke all keys from an Azure Key Vault instance, you can delete the access policy granted to the Azure Cosmos DB principal: