Skip to content

Commit 83ad78c

Browse files
authored
Merge pull request #217492 from markingmyname/format
[PostgreSQL] Format and grammar updates
2 parents 18bea7e + 4b30e60 commit 83ad78c

File tree

6 files changed

+165
-147
lines changed

6 files changed

+165
-147
lines changed

articles/postgresql/flexible-server/concepts-azure-ad-authentication.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn about the concepts of Azure Active Directory for authenticati
44
author: kabharati
55
ms.author: kabharati
66
ms.reviewer: maghan
7-
ms.date: 10/12/2022
7+
ms.date: 11/03/2022
88
ms.service: postgresql
99
ms.subservice: flexible-server
1010
ms.topic: conceptual
@@ -14,7 +14,7 @@ ms.topic: conceptual
1414

1515
[!INCLUDE [applies-to-postgresql-Flexible-server](../includes/applies-to-postgresql-Flexible-server.md)]
1616

17-
> [!NOTE]
17+
> [!NOTE]
1818
> Azure Active Directory Authentication for PostgreSQL Flexible Server is currently in preview.
1919
2020
Microsoft Azure Active Directory (Azure AD) authentication is a mechanism of connecting to Azure Database for PostgreSQL using identities defined in Azure AD.
@@ -36,13 +36,13 @@ Azure Active Directory Authentication for Flexible Server is built using our exp
3636
The following table provides a list of high-level Azure AD features and capabilities comparisons between Single Server and Flexible Server
3737

3838
| **Feature / Capability** | **Single Server** | **Flexible Server** |
39-
| ---- | ---- | ---- |
40-
| Multiple Azure AD Admins | No | Yes|
41-
| Managed Identities (System & User assigned) | Partial | Full|
39+
| --- | --- | --- |
40+
| Multiple Azure AD Admins | No | Yes |
41+
| Managed Identities (System & User assigned) | Partial | Full |
4242
| Invited User Support | No | Yes |
43-
| Disable Password Authentication | Not Available | Available|
44-
| Service Principal can act as group member| No | Yes |
45-
| Audit Azure AD Logins | No | Yes |
43+
| Disable Password Authentication | Not Available | Available |
44+
| Service Principal can act as group member | No | Yes |
45+
| Audit Azure AD Logins | No | Yes |
4646
| PG bouncer support | No | Planned for GA |
4747

4848
## How Azure AD Works In Flexible Server
@@ -55,7 +55,7 @@ The following high-level diagram summarizes how authentication works using Azure
5555

5656
## Manage PostgreSQL Access For AD Principals
5757

58-
When Azure AD authentication is enabled and Azure AD principal is added as an Azure AD administrator the account gets the same privileges as the original PostgreSQL administrator. Only Azure AD administrator can manage other Azure AD enabled roles on the server using Azure portal or Database API. The Azure AD administrator log in can be an Azure AD user, Azure AD group, Service Principal or Managed Identity. Using a group account as an administrator enhances manageability by allowing you to centrally add and remove group members in Azure AD without changing the users or permissions in the PostgreSQL server. Multiple Azure AD administrators can be configured at any time and you can optionally disable password authentication to an Azure Database for PostgreSQL Flexible Server for better auditing and compliance needs.
58+
When Azure AD authentication is enabled and Azure AD principal is added as an Azure AD administrator the account gets the same privileges as the original PostgreSQL administrator. Only Azure AD administrator can manage other Azure AD enabled roles on the server using Azure portal or Database API. The Azure AD administrator sign-in can be an Azure AD user, Azure AD group, Service Principal or Managed Identity. Using a group account as an administrator enhances manageability by allowing you to centrally add and remove group members in Azure AD without changing the users or permissions in the PostgreSQL server. Multiple Azure AD administrators can be configured at any time and you can optionally disable password authentication to an Azure Database for PostgreSQL Flexible Server for better auditing and compliance needs.
5959

6060
![admin structure][2]
6161

@@ -79,11 +79,11 @@ Once you've authenticated against the Active Directory, you then retrieve a toke
7979
> [!NOTE]
8080
> Use these steps to configure Azure AD with Azure Database for PostgreSQL Flexible Server [Configure and sign in with Azure AD for Azure Database for PostgreSQL Flexible Server](how-to-configure-sign-in-azure-ad-authentication.md).
8181
82-
## Additional considerations
82+
## Other considerations
8383

8484
- Multiple Azure AD principals (a user, group, service principal or managed identity) can be configured as Azure AD Administrator for an Azure Database for PostgreSQL server at any time.
8585
- Azure AD groups must be a mail enabled security group for authentication to work.
86-
- In preview , `Azure Active Directory Authentication only` is supported post server creation, this option is currently disabled during server creation experience
86+
- In preview, `Azure Active Directory Authentication only` is supported post server creation, this option is currently disabled during server creation experience
8787
- Only an Azure AD administrator for PostgreSQL can initially connect to the Azure Database for PostgreSQL using an Azure Active Directory account. The Active Directory administrator can configure subsequent Azure AD database users.
8888
- If an Azure AD principal is deleted from Azure AD, it still remains as PostgreSQL role, but it will no longer be able to acquire new access token. In this case, although the matching role still exists in the database it won't be able to authenticate to the server. Database administrators need to transfer ownership and drop roles manually.
8989

articles/postgresql/flexible-server/concepts-data-encryption.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Data encryption with customer-managed key - Azure Database for PostgreSQL - Flexible server
33
description: Azure Database for PostgreSQL Flexible server data encryption with a customer-managed key enables you to Bring Your Own Key (BYOK) for data protection at rest. It also allows organizations to implement separation of duties in the management of keys and data.
4+
author: gennadNY
5+
ms.author: gennadyk
6+
ms.reviewer: maghan
7+
ms.date: 11/03/2022
48
ms.service: postgresql
59
ms.subservice: flexible-server
610
ms.topic: conceptual
7-
ms.author: gennadyk
8-
author: gennadNY
9-
ms.reviewer: maghan
10-
ms.date: 10/12/2022
1111
---
1212

1313
# Azure Database for PostgreSQL - Flexible Server Data Encryption with a Customer-managed Key Preview
@@ -40,17 +40,17 @@ Data encryption with customer-managed keys for Azure Database for PostgreSQL - F
4040

4141
**Key encryption key (KEK)**: An encryption key used to encrypt the DEKs. A KEK that never leaves Key Vault allows the DEKs themselves to be encrypted and controlled. The entity that has access to the KEK might be different than the entity that requires the DEK. Since the KEK is required to decrypt the DEKs, the KEK is effectively a single point by which DEKs can be effectively deleted by deleting the KEK.
4242

43-
The DEKs, encrypted with the KEKs, are stored separately. Only an entity with access to the KEK can decrypt these DEKs. For more information, see [Security in encryption at rest](../../security/fundamentals/encryption-atrest.md).
43+
The DEKs, encrypted with the KEKs, are stored separately. Only an entity with access to the KEK can decrypt these DEKs. For more information, see [Security in encryption at rest](../../security/fundamentals/encryption-atrest.md).
4444

4545
## How data encryption with a customer-managed key work
4646

4747
:::image type="content" source="./media/concepts-data-encryption/postgresql-data-encryption-overview.png" alt-text ="Diagram that shows an overview of Bring Your Own Key." :::
4848

4949
For a PostgreSQL server to use customer-managed keys stored in Key Vault for encryption of the DEK, a Key Vault administrator gives the following access rights to the server:
5050

51-
- **get**: For retrieving the public part and properties of the key in the key Vault.
51+
- **get**: For retrieving, the public part and properties of the key in the key Vault.
5252

53-
- **list**: For listing\iterating through keys in the key Vault.
53+
- **list**: For listing\iterating through keys in, the key Vault.
5454

5555
- **wrapKey**: To be able to encrypt the DEK. The encrypted DEK is stored in the Azure Database for PostgreSQL.
5656

@@ -102,7 +102,7 @@ Here are recommendations for configuring a customer-managed key:
102102

103103
- Keep a copy of the customer-managed key in a secure place, or escrow it to the escrow service.
104104

105-
- If Key Vault generates the key, create a key backup before using the key for the first time. You can only restore the backup to Key Vault.
105+
- If Key Vault generates the key, create a key backup before using the key for the first time. You can only restore the backup to Key Vault.
106106

107107
### Accidental key access revocation from Key Vault
108108

@@ -128,9 +128,9 @@ To monitor the database state, and to enable alerting for the loss of transparen
128128

129129
## Restore and replicate with a customer's managed key in Key Vault
130130

131-
After Azure Database for PostgreSQL - Flexible Server is encrypted with a customer's managed key stored in Key Vault, any newly created server copy is also encrypted. You can make this new copy through a [PITR restore](concepts-backup-restore.md) operation or read replicas.
131+
After Azure Database for PostgreSQL - Flexible Server is encrypted with a customer's managed key stored in Key Vault, any newly created server copy is also encrypted. You can make this new copy through a [PITR restore](concepts-backup-restore.md) operation or read replicas.
132132

133-
> [!NOTE]
133+
> [!NOTE]
134134
> At this time we don't support revoking the original encryption key after restoring CMK enabled server to another server
135135
136136
Avoid issues while setting up customer-managed data encryption during restore or read replica creation by following these steps on the primary and restored/replica servers:
@@ -155,33 +155,33 @@ Prerequisites:
155155

156156
Follow the steps below to enable CMK while creating Postgres Flexible Server.
157157

158-
1. Navigate to Azure Database for PostgreSQL - Flexible Server create blade via Azure portal
158+
1. Navigate to Azure Database for PostgreSQL - Flexible Server create pane via Azure portal
159159

160-
2. Provide required information on Basics and Networking tabs
160+
1. Provide required information on Basics and Networking tabs
161161

162-
3. Navigate to Security(preview) tab. On the screen, provide Azure Active Directory (Azure AD) identity that has access to the Key Vault and Key in Key Vault in the same region where you're creating this server
162+
1. Navigate to Security(preview) tab. On the screen, provide Azure Active Directory (Azure AD) identity that has access to the Key Vault and Key in Key Vault in the same region where you're creating this server
163163

164-
4. On Review Summary tab, make sure that you provided correct information in Security section and press Create button
164+
1. On Review Summary tab, make sure that you provided correct information in Security section and press Create button
165165

166-
5. Once it's finished, you should be able to navigate to Data Encryption (preview) screen for the server and update identity or key if necessary
166+
1. Once it's finished, you should be able to navigate to Data Encryption (preview) screen for the server and update identity or key if necessary
167167

168168
## Update Customer Managed Key on the CMK enabled Flexible Server
169169

170170
Prerequisites:
171171

172172
- Azure Active Directory (Azure AD) user-managed identity in region where Postgres Flex Server will be created. Follow this [tutorial](../../active-directory/managed-identities-azure-resources/qs-configure-portal-windows-vm.md) to create identity.
173173

174-
- Key Vault with key in region where Postgres Flex Server will be created. Follow this [tutorial](../../key-vault/general/quick-create-portal.md) to create Key Vault and generate key.
174+
- Key Vault with key in region where Postgres Flex Server will be created. Follow this [tutorial](../../key-vault/general/quick-create-portal.md) to create Key Vault and generate key.
175175

176176
Follow the steps below to update CMK on CMK enabled Flexible Server:
177177

178178
1. Navigate to Azure Database for PostgreSQL - Flexible Server create a page via the Azure portal.
179179

180-
2. Navigate to Data Encryption (preview) screen under Security tab
180+
1. Navigate to Data Encryption (preview) screen under Security tab
181181

182-
3. Select different identity to connect to Azure Key Vault, remembering that this identity needs to have proper access rights to the Key Vault
182+
1. Select different identity to connect to Azure Key Vault, remembering that this identity needs to have proper access rights to the Key Vault
183183

184-
4. Select different key by choosing subscription, Key Vault and key from dropdowns provided.
184+
1. Select different key by choosing subscription, Key Vault and key from dropdowns provided.
185185

186186
## Limitations
187187

@@ -195,14 +195,14 @@ The following are limitations for configuring the customer-managed key in Flexib
195195

196196
The following are other limitations for the public preview of configuring the customer-managed key that we expect to remove at the General Availability of this feature:
197197

198-
- No support for Geo backup enabled servers
198+
- No support for Geo backup enabled servers
199199

200200
- **No support for revoking key after restoring CMK enabled server to another server**
201201

202-
- No support for Azure HSM Key Vault
202+
- No support for Azure HSM Key Vault
203203

204204
- No CLI or PowerShell support
205205

206206
## Next steps
207207

208-
- [Azure Active Directory](../../active-directory-domain-services/overview.md)
208+
- [Azure Active Directory](../../active-directory-domain-services/overview.md)

0 commit comments

Comments
 (0)