You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/cosmos-db/how-to-setup-cmk.md
+28-28Lines changed: 28 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,18 +16,18 @@ ROBOTS: noindex, nofollow
16
16
17
17
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:
18
18
19
-
-**Service-managed keys** - By default, Microsoft manages the keys that are used to encrypt the data in your Azure Cosmos account.
19
+
-**Service-managed keys**: By default, Microsoft manages the keys that are used to encrypt the data in your Azure Cosmos account.
20
20
21
-
-**Customer-managed keys (CMK)**- You can optionally choose to add a second layer of encryption with your own keys.
21
+
-**Customer-managed keys (CMK)**: You can optionally choose to add a second layer of encryption with your own keys.
22
22
23
-
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.
23
+
You must store customer-managed keys in [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.
24
24
25
25
> [!NOTE]
26
-
> Currently, customer-managed keys are only available for new Azure Cosmos accounts and you should configure them during account creation.
26
+
> Currently, customer-managed keys are available only for new Azure Cosmos accounts. You should configure them during account creation.
27
27
28
28
## <aid="register-resource-provider"></a> Register the Azure Cosmos DB resource provider for your Azure subscription
29
29
30
-
1. Sign into the [Azure portal](https://portal.azure.com/), go to your Azure subscription and select **Resource providers** under the **Settings** tab:
30
+
1. Sign in to the [Azure portal](https://portal.azure.com/), go to your Azure subscription, and select **Resource providers** under the **Settings** tab:
31
31
32
32

33
33
@@ -37,7 +37,7 @@ You must store customer-managed keys in the [Azure Key Vault](../key-vault/key-v
37
37
38
38
## Configure your Azure Key Vault instance
39
39
40
-
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.
40
+
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.
41
41
42
42
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:
43
43
@@ -50,47 +50,47 @@ To learn how to enable these properties on an existing Azure Key Vault instance,
50
50
51
51

52
52
53
-
1. Select **+ Add Access Policy**
53
+
1. Select **+ Add Access Policy**.
54
54
55
-
1. Under the **Key permissions**dropdown menu, select **Get**, **Unwrap Key** and **Wrap Key** permissions:
55
+
1. Under the **Key permissions**drop-down menu, select **Get**, **Unwrap Key**, and **Wrap Key** permissions:
56
56
57
57

58
58
59
-
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):
59
+
1. Under **Select principal**, select **None selected**. Then, search for **Azure Cosmos DB** principal and select it. Finally, choose**Select** at the bottom. If the **Azure Cosmos DB** principal isn't in the list, you might need to re-register the **Microsoft.DocumentDB** resource provider as described in the [Register the resource provider](#register-resource-provider) section of this article.
60
60
61
61

62
62
63
-
1. Select **Add** to add the new access policy
63
+
1. Select **Add** to add the new access policy.
64
64
65
65
## Generate a key in Azure Key Vault
66
66
67
67
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:
68
68
69
69

70
70
71
-
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**:
71
+
1. Select **Generate/Import**, provide a name for the new key, and select an RSA key size. A minimum of 3072 is recommended for best security. Then select **Create**:
72
72
73
73

74
74
75
-
1. After the key is created, select the newly created key, and then on its current version.
75
+
1. After the key is created, select the newly created key and then its current version.
76
76
77
-
1. Copy the key’s **Key Identifier** except the part after the last forward slash:
77
+
1. Copy the key's **Key Identifier**, except the part after the last forward slash:
78
78
79
79

80
80
81
81
## Create a new Azure Cosmos account
82
82
83
83
### Using the Azure portal
84
84
85
-
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:
85
+
When you create 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:
86
86
87
87

88
88
89
89
### Using Azure PowerShell
90
90
91
-
When creating a new Azure Cosmos DB account with PowerShell,
91
+
When you create a new Azure Cosmos DB account with PowerShell:
92
92
93
-
- Pass the URI of the Azure Key Vault key copied from earlier under the **keyVaultKeyUri** property in the **PropertyObject**
93
+
- Pass the URI of the Azure Key Vault key copied earlier under the **keyVaultKeyUri** property in **PropertyObject**.
### Is there any additional charge when using customer-managed keys?
189
+
### Is there any additional charge for using customer-managed keys?
190
190
191
-
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).
191
+
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 percent increase in [Request Units](./request-units.md).
192
192
193
193
### What data gets encrypted with the customer-managed keys?
194
194
195
-
All the data stored in your Azure Cosmos account is encrypted with the customer-managed keys, except for the following meta-data:
195
+
All the data stored in your Azure Cosmos account is encrypted with the customer-managed keys, except for the following metadata:
196
196
197
197
- The names of your Azure Cosmos DB [accounts, databases, and containers](./account-overview.md#elements-in-an-azure-cosmos-account)
198
198
199
199
- The names of your [stored procedures](./stored-procedures-triggers-udfs.md)
200
200
201
201
- The property paths declared in your [indexing policies](./index-policy.md)
202
202
203
-
- The values of your containers' [partition key](./partitioning-overview.md)
203
+
- The values of your containers' [partition keys](./partitioning-overview.md)
204
204
205
205
### Are customer-managed keys supported for existing Azure Cosmos accounts?
206
206
207
-
This feature is currently available for new accounts only.
207
+
This feature is currently available only for new accounts.
208
208
209
209
### Is there a plan to support finer granularity than account-level keys?
210
210
211
-
Not currently, however container-level keys are being considered.
211
+
Not currently, but container-level keys are being considered.
212
212
213
-
### How does customer-managed keys affect a backup?
213
+
### How do customer-managed keys affect a backup?
214
214
215
-
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.
215
+
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 was made and the version of the key that was used at the time of the backup will still be enabled.
216
216
217
217
### How do I revoke an encryption key?
218
218
@@ -230,5 +230,5 @@ The only operation possible when the encryption key has been revoked is account
230
230
231
231
## Next steps
232
232
233
-
- Learn more about [data encryption in Azure Cosmos DB](./database-encryption-at-rest.md)
234
-
- Get an overview of [secure access to data in Cosmos DB](secure-access-to-data.md)
233
+
- Learn more about [data encryption in Azure Cosmos DB](./database-encryption-at-rest.md).
234
+
- Get an overview of [secure access to data in Cosmos DB](secure-access-to-data.md).
0 commit comments