Skip to content

Commit b3cd9dd

Browse files
committed
latest changes suggested by reviewer april 10
1 parent c62e254 commit b3cd9dd

File tree

6 files changed

+21
-23
lines changed

6 files changed

+21
-23
lines changed

articles/cosmos-db/postgresql/concepts-customer-managed-keys.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
2-
title: Concepts of Customer Managed Keys
3-
description: Concepts of customer Managed Keys
2+
title: Concepts of customer managed keys in Azure Cosmos DB for PostgreSQL.
3+
description: Concepts of customer managed keys.
44
ms.author: akashrao
55
author: akashraokm
66
ms.service: cosmos-db
77
ms.subservice: postgresql
88
ms.topic: conceptual
99
ms.date: 04/06/2023
1010
---
11-
# Customer-managed Keys in Azure Cosmos DB for PostgreSQL
11+
# Customer-managed keys in Azure Cosmos DB for PostgreSQL
1212

1313
[!INCLUDE [PostgreSQL](../includes/appliesto-postgresql.md)]
1414

1515
Data stored in your Azure Cosmos DB for PostgreSQL cluster is automatically and seamlessly encrypted with keys managed by Microsoft. These keys are referred to as **service-managed keys**. Azure Cosmos DB for PostgreSQL uses [Azure Storage encryption](../../storage/common/storage-service-encryption.md) to encrypt data at-rest by default using service-managed keys. You can optionally choose to add an extra layer of security by enabling encryption with **customer-managed keys**.
1616

1717

1818

19-
## Service-managed Keys
19+
## Service-managed keys
2020

2121
The Azure Cosmos DB for PostgreSQL service uses the FIPS 140-2 validated cryptographic module for storage encryption of data at-rest. All Data including backups and temporary files created while running queries are encrypted on disk. The service uses the AES 256-bit cipher included in Azure storage encryption, and the keys are system-managed. Storage encryption is always on and cannot be disabled.
2222

23-
## Customer-managed Keys
23+
## Customer-managed keys
2424

2525
Many organizations require full control of access to data using a customer-managed key. Data encryption with customer-managed keys for Azure Cosmos DB for PostgreSQL enables you to bring your own key for protecting data at rest. It also allows organizations to implement separation of duties in the management of keys and data. With customer-managed encryption, you're responsible for, and in full control of, a key's lifecycle, usage permissions, and auditing of operations.
2626

@@ -49,7 +49,7 @@ For a cluster to use customer-managed keys stored in Key Vault for encryption of
4949
The key vault administrator can also enable logging of Key Vault audit events, so they can be audited later.
5050
When the Azure Cosmos DB for PostgreSQL cluster is configured to use the customer-managed key stored in the key vault, the cluster sends the DEK to the key vault for encryptions. Key Vault returns the encrypted DEK, which is stored in the user database. Similarly, when needed, the server sends the protected DEK to the key vault for decryption. Auditors can use [Azure Monitor](../../azure-monitor/index.yml) to review Key Vault audit event logs, if logging is enabled.
5151

52-
![Architecture of Data Enrcryption with Customer Managed Keys.](media/concepts-customer-managed-keys/architecture.png)
52+
![Screenshot of architecture of Data Enrcryption with Customer Managed Keys.](media/concepts-customer-managed-keys/architecture-customer-managed-keys.png)
5353

5454
## Benefits
5555

@@ -61,7 +61,7 @@ Data encryption with customer-managed keys for Azure Cosmos DB for PostgreSQL pr
6161
- Ability to implement separation of duties between security officers, database administrators, and system administrators.
6262
- Enabling encryption doesn't have any extra performance effect with or without customer-managed keys. Azure Cosmos DB for PostgreSQL relies on Azure Storage for data encryption in both customer-managed and service-managed key scenarios.
6363

64-
## Next-steps
64+
## Next Steps
6565

6666
>[!div class="nextstepaction"]
6767
>[Enable encryption with customer managed keys](how-to-customer-managed-keys.md)

articles/cosmos-db/postgresql/how-to-customer-managed-keys.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to enable encryption with customer managed keys
2+
title: How to enable encryption with customer managed keys in Azure Cosmos DB for PostgreSQL.
33
description: How to enable data encryption with customer managed keys.
44
ms.author: akashrao
55
author: akashraokm
@@ -34,11 +34,11 @@ ms.date: 04/06/2023
3434

3535
## Detailed steps
3636

37-
### 1. User Assigned Managed Identity:
37+
1. ### User Assigned Managed Identity
3838

3939
1. Search for Managed Identities in the global search bar.
4040

41-
![Searching for Managed Identities in Azure portal.](media/how-to-customer-managed-keys/user-assigned-managed-identity.png)
41+
![Screenshot of Managed Identities in Azure portal.](media/how-to-customer-managed-keys/user-assigned-managed-identity.png)
4242

4343

4444
1. Create a new User assigned managed Identity in the same region as your Azure Cosmos DB for PostgreSQL cluster.
@@ -48,7 +48,7 @@ ms.date: 04/06/2023
4848

4949
Learn more about [User Assigned Managed Identity.](../../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md?pivots=identity-mi-methods-azp#create-a-user-assigned-managed-identity).
5050

51-
### 2. Key Vault:
51+
1. ### Key Vault
5252

5353
Using customer-managed keys with Azure Cosmos DB for PostgreSQL requires you to set two properties on the Azure Key Vault instance that you plan to use to host your encryption keys: Soft Delete and Purge Protection.
5454

@@ -58,15 +58,15 @@ ms.date: 04/06/2023
5858

5959
1. If you're using an existing Azure Key Vault instance, you can verify that these properties are enabled by looking at the Properties section on the Azure portal. If any of these properties aren’t enabled, see the "Enabling soft delete" and "Enabling Purge Protection" sections in one of the following articles.
6060

61-
* How to use [soft-delete with PowerShell.](../../key-vault/ general/key-vault-recovery.md)
61+
* How to use [soft-delete with PowerShell.](../../key-vault/general/key-vault-recovery.md)
6262
* How to use [soft-delete with Azure CLI.](../../key-vault/general/key-vault-recovery.md)
6363

6464
1. The key Vault must be set with 90 days for 'Days to retain deleted vaults'. If the existing key Vault has been configured with a lower number, you'll need to create a new key vault as it can't be modified after creation.
6565

6666
> [!IMPORTANT]
6767
> Your Azure Key Vault instance must be allow public access from all the networks.
6868
69-
### 3. Add an Access Policy to the Key Vault:
69+
1. ### Add an Access Policy to the Key Vault
7070

7171
1. From the Azure portal, go to the Azure Key Vault instance that you plan to use to host your encryption keys. Select Access configuration from the left menu and then select Go to access policies.
7272

@@ -82,7 +82,7 @@ ms.date: 04/06/2023
8282

8383
1. Navigate to Review + create select Create.
8484

85-
### 4. Create / Import Key:
85+
1. ### Create / Import Key
8686

8787
1. From the Azure portal, go to the Azure Key Vault instance that you plan to use to host your encryption keys.
8888

@@ -100,12 +100,12 @@ ms.date: 04/06/2023
100100

101101
1. If you're manually rotating the key, the old key version shouldn't be deleted for at least 24 hours.
102102

103-
### 5. Enable CMK encryption during the provisioning for a new cluster
103+
1. ### Enable CMK encryption during the provisioning for a new cluster
104104

105105
# [Portal](#tab/portal)
106106

107107
1. During the provisioning of a new Cosmos DB for PostgreSQL cluster, after providing the necessary information under Basics and Networking Tab, Navigate to the Encryption (Preview) Tab.
108-
![Screenshot of Encrytion configuration page.](media/how-to-customer-managed-keys/provisioning%20-encryption-tab.png)
108+
![Screenshot of Encrytion configuration page.](media/how-to-customer-managed-keys/encryption-tab.png)
109109

110110
1. Select Customer Managed Key under Data encryption key option.
111111

@@ -235,21 +235,19 @@ ms.date: 04/06/2023
235235
```
236236
---
237237

238-
### High Availability:
238+
### High availability
239239

240240
When CMK encryption is enabled on the primary cluster, all standby HA replicas are automatically encrypted by the primary cluster’s CMK
241241

242242
### Restrictions
243243

244-
1. CMK encryption can't be enabled on cross region read replicas.
244+
* CMK encryption can't be enabled on cross region read replicas.
245245

246-
1. CMK encryption can only be enabled during the creation of a new Azure Cosmos DB for PostgreSQL cluster.
246+
* CMK encryption can only be enabled during the creation of a new Azure Cosmos DB for PostgreSQL cluster.
247247

248-
1. CMK encryption is available in the following regions Switzerland North and North Europe.
248+
* CMK encryption isn't supported with Private access (including VNET).
249249

250-
1. CMK encryption isn't supported with Private access (including VNET).
251-
252-
### Changing Encryption Configuration by performing a PITR.
250+
### Changing encryption configuration by performing a PITR
253251

254252
Encryption configuration can be changed from service managed encryption to CMK encryption or vice versa while performing a Point in restore operation to a new cluster.
255253

973 Bytes
Loading
20.3 KB
Loading

0 commit comments

Comments
 (0)