Skip to content

Commit 23febe3

Browse files
committed
Fixed Entra IDs in the how-to
1 parent d656a68 commit 23febe3

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

articles/cosmos-db/postgresql/how-to-configure-authentication.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,36 @@ ms.date: 11/06/2023
1414
[!INCLUDE [PostgreSQL](../includes/appliesto-postgresql.md)]
1515

1616
> [!IMPORTANT]
17-
> Microsoft Entra authentication in Azure Cosmos DB for PostgreSQL is currently in preview.
17+
> Microsoft Entra ID authentication in Azure Cosmos DB for PostgreSQL is currently in preview.
1818
> This preview version is provided without a service level agreement, and it's not recommended
1919
> for production workloads. Certain features might not be supported or might have constrained
2020
> capabilities.
2121
>
2222
> You can see a complete list of other new features in [preview features](product-updates.md#features-in-preview).
2323
24-
In this article, you configure authentication methods for Azure Cosmos DB for PostgreSQL. You manage Microsoft Entra admin users and native PostgreSQL roles for authentication with Azure Cosmos DB for PostgreSQL. You also learn how to use a Microsoft Entra token with Azure Cosmos DB for PostgreSQL.
24+
In this article, you configure authentication methods for Azure Cosmos DB for PostgreSQL. You manage Microsoft Entra ID admin users and native PostgreSQL roles for authentication with Azure Cosmos DB for PostgreSQL. You also learn how to use a Microsoft Entra ID token with Azure Cosmos DB for PostgreSQL.
2525

2626
An Azure Cosmos DB for PostgreSQL cluster is created with one built-in native PostgreSQL role named 'citus'. You can add more native PostgreSQL roles after cluster provisioning is completed.
2727

28-
You can also configure Microsoft Entra authentication for Azure Cosmos DB for PostgreSQL. You can enable Microsoft Entra authentication in addition or instead of the native PostgreSQL authentication on your cluster. You can change authentication methods enabled on cluster at any point after the cluster is provisioned. When Microsoft Entra authentication is enabled, you can add multiple Microsoft Entra users to an Azure Cosmos DB for PostgreSQL cluster and make any of them administrators. Microsoft Entra user can be a user or a service principal.
28+
You can also configure Microsoft Entra ID authentication for Azure Cosmos DB for PostgreSQL. You can enable Microsoft Entra ID authentication in addition or instead of the native PostgreSQL authentication on your cluster. You can change authentication methods enabled on cluster at any point after the cluster is provisioned. When Microsoft Entra ID authentication is enabled, you can add multiple Microsoft Entra ID users to an Azure Cosmos DB for PostgreSQL cluster and make any of them administrators. Microsoft Entra ID user can be a user or a service principal.
2929

3030
## Choose authentication method
3131
You need to use Azure portal to configure authentication methods on an Azure Cosmos DB for PostgreSQL cluster.
3232

33-
Complete the following items on your Azure Cosmos DB for PostgreSQL cluster to enable or disable Microsoft Entra authentication and native PostgreSQL authentication.
33+
Complete the following items on your Azure Cosmos DB for PostgreSQL cluster to enable or disable Microsoft Entra ID authentication and native PostgreSQL authentication.
3434

3535
1. On the cluster page, under the **Cluster management** heading, choose **Authentication** to open authentication management options.
36-
1. In **Authentication methods** section, choose **PostgreSQL authentication only**, **Microsoft Entra authentication (preview)**, or **PostgreSQL and Microsoft Entra authentication (preview)** as the authentication method based on your requirements.
36+
1. In **Authentication methods** section, choose **PostgreSQL authentication only**, **Microsoft Entra ID authentication (preview)**, or **PostgreSQL and Microsoft Entra ID authentication (preview)** as the authentication method based on your requirements.
3737

38-
Once done proceed with [configuring Microsoft Entra authentication](#configure-azure-active-directory-authentication) or [adding native PostgreSQL roles](#configure-native-postgresql-authentication) on **Authentication** page.
38+
Once done proceed with [configuring Microsoft Entra ID authentication](#configure-azure-active-directory-authentication) or [adding native PostgreSQL roles](#configure-native-postgresql-authentication) on **Authentication** page.
3939

4040
<a name='configure-azure-active-directory-authentication'></a>
4141

4242
## Configure Microsoft Entra ID authentication
4343

4444
### Prerequisites
4545

46-
Users need to be allowed to sign in to Azure Cosmos DB for PostgreSQL in the Microsoft Entra tenant. These steps should be performed once for the Microsoft Entra ID tenant that is going to be used for authentication on Azure Cosmos DB for PostgreSQL clusters.
46+
Users need to be allowed to sign in to Azure Cosmos DB for PostgreSQL in the Microsoft Entra ID tenant. These steps should be performed once for the Microsoft Entra ID tenant that is going to be used for authentication on Azure Cosmos DB for PostgreSQL clusters.
4747

4848
> [!IMPORTANT]
4949
> Microsoft Entra ID tenant administrator permissions are needed to make the change. See [guidance for troubleshooting permissions](/entra/identity/enterprise-apps/add-application-portal-configure#prerequisites).
@@ -64,12 +64,12 @@ az ad sp update --id b4fa09d8-5da5-4352-83d9-05c2a44cf431 --set accountEnabled=t
6464
```
6565
---
6666

67-
### Add Microsoft Entra admins to Azure Cosmos DB for PostgreSQL cluster
67+
### Add Microsoft Entra ID admins to Azure Cosmos DB for PostgreSQL cluster
6868

69-
To add or remove Microsoft Entra roles on cluster, follow these steps on **Authentication** page:
69+
To add or remove Microsoft Entra ID roles on cluster, follow these steps on **Authentication** page:
7070

71-
1. In **Microsoft Entra authentication (preview)** section, select **Add Microsoft Entra admins**.
72-
1. In **Select Microsoft Entra Admins** panel, select one or more valid Microsoft Entra user or enterprise application in the current AD tenant to be a Microsoft Entra administrator on your Azure Cosmos DB for PostgreSQL cluster.
71+
1. In **Microsoft Entra ID authentication (preview)** section, select **Add Microsoft Entra ID admins**.
72+
1. In **Select Microsoft Entra ID Admins** panel, select one or more valid Microsoft Entra ID user or enterprise application in the current AD tenant to be a Microsoft Entra ID administrator on your Azure Cosmos DB for PostgreSQL cluster.
7373
1. Use **Select** to confirm your choice.
7474
1. In the **Authentication** page, select **Save** in the toolbar to save changes or proceed with adding native PostgreSQL roles.
7575

@@ -79,15 +79,15 @@ To add Postgres roles on cluster, follow these steps on **Authentication** page:
7979

8080
1. In **PostgreSQL authentication** section, select **Add PostgreSQL role**.
8181
1. Enter the role name and password. Select **Save**.
82-
1. In the **Authentication** page, select **Save** in the toolbar to save changes or proceed with adding Microsoft Entra admin users.
82+
1. In the **Authentication** page, select **Save** in the toolbar to save changes or proceed with adding Microsoft Entra ID admin users.
8383

8484
The native PostgreSQL user is created on the coordinator node of the cluster, and propagated to all the worker nodes. Roles created through the Azure portal have the LOGIN attribute, which means they’re true users who can sign in to the database.
8585

8686
<a name='connect-to-azure-cosmos-for-postgresql-by-using-azure-ad-authentication'></a>
8787

88-
## Connect to Azure Cosmos for PostgreSQL by using Microsoft Entra authentication
88+
## Connect to Azure Cosmos for PostgreSQL by using Microsoft Entra ID authentication
8989

90-
Microsoft Entra integration works with standard PostgreSQL client tools like **psql**, which aren't Microsoft Entra aware and support only specifying the username and password when you're connecting to PostgreSQL. In such cases, the Microsoft Entra token is passed as the password.
90+
Microsoft Entra ID integration works with standard PostgreSQL client tools like **psql**, which aren't Microsoft Entra ID aware and support only specifying the username and password when you're connecting to PostgreSQL. In such cases, the Microsoft Entra ID token is passed as the password.
9191

9292
We've tested the following clients:
9393

@@ -105,13 +105,13 @@ Start by authenticating with Microsoft Entra ID by using the Azure CLI. This ste
105105
az login
106106
```
107107

108-
The command opens a browser window to the Microsoft Entra authentication page. It requires you to give your Microsoft Entra user ID and password.
108+
The command opens a browser window to the Microsoft Entra ID authentication page. It requires you to give your Microsoft Entra ID user name and password.
109109

110110
<a name='retrieve-the-azure-ad-access-token'></a>
111111

112-
### Retrieve the Microsoft Entra access token
112+
### Retrieve the Microsoft Entra ID access token
113113

114-
Use the Azure CLI to acquire an access token for the Microsoft Entra authenticated user to access Azure Cosmos for PostgreSQL. Here's an example:
114+
Use the Azure CLI to acquire an access token for the Microsoft Entra ID authenticated user to access Azure Cosmos for PostgreSQL. Here's an example:
115115

116116
```azurecli-interactive
117117
az account get-access-token --resource https://postgres.cosmos.azure.com
@@ -161,8 +161,8 @@ export PGPASSWORD=$(az account get-access-token --resource-type oss-rdbms --quer
161161

162162

163163
> [!NOTE]
164-
> Make sure PGPASSWORD variable is set to the Microsoft Entra access token for your
165-
> subscription for Microsoft Entra authentication. If you need to do Postgres role authentication
164+
> Make sure PGPASSWORD variable is set to the Microsoft Entra ID access token for your
165+
> subscription for Microsoft Entra ID authentication. If you need to do Postgres role authentication
166166
> from the same session you can set PGPASSWORD to the Postgres role password
167167
> or clear the PGPASSWORD variable value to enter the password interactively.
168168
> Authentication would fail with the wrong value in PGPASSWORD.
@@ -175,22 +175,22 @@ psql "host=mycluster.[uniqueID].postgres.cosmos.azure.com [email protected]
175175

176176
### Use a token as a password for signing in with PgAdmin
177177

178-
To connect by using a Microsoft Entra token with PgAdmin, follow these steps:
178+
To connect by using a Microsoft Entra ID token with PgAdmin, follow these steps:
179179

180180
1. Clear the **Connect now** option at server creation.
181181
1. Enter your server details on the **Connection** tab and save.
182-
1. Make sure a valid Microsoft Entra user is specified in **Username**.
182+
1. Make sure a valid Microsoft Entra ID user is specified in **Username**.
183183
1. From the pgAdmin **Object** menu, select **Connect Server**.
184184
1. Enter the Active Directory token password when you're prompted.
185185

186186
Here are some essential considerations when you're connecting:
187187

188-
- `[email protected]` is the name of the Microsoft Entra user.
189-
- Be sure to use the exact way the Azure user is spelled. Microsoft Entra user and group names are case-sensitive.
188+
- `[email protected]` is the name of the Microsoft Entra ID user.
189+
- Be sure to use the exact way the Azure user is spelled. Microsoft Entra ID user and group names are case-sensitive.
190190
- If the name contains spaces, use a backslash (`\`) before each space to escape it.
191191
- The access token's validity is 5 minutes to 90 minutes. You should get the access token before initiating the sign-in to Azure Cosmos for PostgreSQL.
192192

193-
You're now authenticated to your Azure Cosmos for PostgreSQL server through Microsoft Entra authentication.
193+
You're now authenticated to your Azure Cosmos for PostgreSQL server through Microsoft Entra ID authentication.
194194

195195
## Manage native PostgreSQL roles
196196

@@ -202,7 +202,7 @@ To update a user, visit the **Authentication** page for your cluster,
202202
and select the ellipses **...** next to the user. The ellipses open a menu
203203
to delete the user or reset their password.
204204

205-
The `citus` role is privileged and can't be deleted. However, `citus` role would be disabled, if 'Microsoft Entra authentication only' authentication method is selected for the cluster.
205+
The `citus` role is privileged and can't be deleted. However, `citus` role would be disabled, if 'Microsoft Entra ID authentication only' authentication method is selected for the cluster.
206206

207207
## How to modify privileges for user roles
208208

@@ -216,7 +216,7 @@ For example, to allow PostgreSQL `db_user` to read `mytable`, grant the permissi
216216
GRANT SELECT ON mytable TO db_user;
217217
```
218218

219-
To grant the same permissions to Microsoft Entra role `[email protected]` use the following command:
219+
To grant the same permissions to Microsoft Entra ID role `[email protected]` use the following command:
220220

221221
```sql
222222
GRANT SELECT ON mytable TO "[email protected]";
@@ -231,7 +231,7 @@ system-wide (for example, for all tables in a schema):
231231
GRANT SELECT ON ALL TABLES IN SCHEMA public TO db_user;
232232
```
233233

234-
Or for Microsoft Entra role
234+
Or for Microsoft Entra ID role
235235

236236
```sql
237237
-- applies to the coordinator node and propagates to worker nodes for Azure AD role [email protected]
@@ -243,5 +243,5 @@ GRANT SELECT ON ALL TABLES IN SCHEMA public TO "[email protected]";
243243

244244
- Learn about [authentication in Azure Cosmos DB for PostgreSQL](./concepts-authentication.md)
245245
- Check out [Microsoft Entra ID limits and limitations in Azure Cosmos DB for PostgreSQL](./reference-limits.md#azure-active-directory-authentication)
246-
- Review [Microsoft Entra fundamentals](./../../active-directory/fundamentals/active-directory-whatis.md)
246+
- Review [Microsoft Entra ID fundamentals](/entra/fundamentals/whatis)
247247
- [Learn more about SQL GRANT in PostgreSQL](https://www.postgresql.org/docs/current/sql-grant.html)

0 commit comments

Comments
 (0)