Skip to content

Commit 0ef5675

Browse files
author
Affonso Moia Vieira (Improving Vancouver Technologies)
committed
Entra support documentation for Azure database for PostgreSQL
1 parent c3362a1 commit 0ef5675

File tree

4 files changed

+86
-1
lines changed

4 files changed

+86
-1
lines changed

articles/data-factory/connector-azure-database-for-postgresql.md

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ The following properties are supported for the Azure Database for PostgreSQL lin
8383
|:--- |:--- |:--- |
8484
| type | The type property must be set to: **AzurePostgreSql**. | Yes |
8585
| version | The version that you specify. The value is `2.0`. | Yes |
86-
| authenticationType | Select from basic or service principal authentication | Yes |
86+
| authenticationType | Select from basic, service principal, system-assigned managed identity and user-assigned managed identity authentication types | Yes |
8787
| server | Specifies the host name and optionally port on which Azure Database for PostgreSQL is running. | Yes |
8888
| port |The TCP port of the Azure Database for PostgreSQL server. The default value is `5432`. |No |
8989
| database| The name of the Azure Database for PostgreSQL database to connect to. |Yes |
@@ -157,6 +157,91 @@ The following properties are supported for the Azure Database for PostgreSQL lin
157157
}
158158
```
159159

160+
### System-assigned managed identity authentication
161+
162+
A data factory or Synapse workspace can be associated with a [System-assigned managed identity](/azure/data-factory/data-factory-service-identity#system-assigned-managed-identity) that represents the service when authenticating to other resources in Azure. You can use this managed identity for Azure database for PostgreSQL authentication. The designated factory or Synapse workspace can access and copy data from or to your database by using this identity.
163+
164+
To use System-assigned managed identity, follow the steps:
165+
166+
1. A data factory or Synapse workspace can be associated with a system-assigned managed identity. Learn More, [Generate system-assigned managed identity](/azure/data-factory/data-factory-service-identity#generate-managed-identity)
167+
168+
1. The Azure data for PostgreSQL with System assigned managed identity **On**.
169+
170+
:::image type="content" source="media/connector-azure-database-for-postgresql/system-managed-identity-configuration.png" alt-text="Screenshot of the system assigned managed identity configuration in the Azure database for PostgreSQL server resource." lightbox="media/connector-azure-database-for-postgresql/system-managed-identity-configuration.png":::
171+
172+
1. Configure an Azure database for PostgreSQL linked service.
173+
174+
```json
175+
{
176+
"name": "AzurePostgreSqlLinkedService",
177+
"type": "Microsoft.DataFactory/factories/linkedservices",
178+
"properties": {
179+
"annotations": [],
180+
"type": "AzurePostgreSql",
181+
"version": "2.0",
182+
"typeProperties": {
183+
"server": "<server name>",
184+
"port": 5432,
185+
"database": "<database name>",
186+
"sslMode": 2,
187+
"authenticationType": "SystemAssignedManagedIdentity"
188+
}
189+
}
190+
}
191+
```
192+
193+
### User-assigned managed identity authentication
194+
195+
A data factory or Synapse workspace can be associated with a [User-assigned managed identity](/azure/data-factory/data-factory-service-identity#user-assigned-managed-identity) that represents the service when authenticating to other resources in Azure. You can use this managed identity for Azure database for PostgreSQL authentication. The designated factory or Synapse workspace can access and copy data from or to your database by using this identity.
196+
197+
To use user-assigned managed identity authentication, in addition to the generic properties that are described in the preceding section, specify the following properties:
198+
199+
| Property | Description | Required |
200+
|:--- |:--- |:--- |
201+
| credential | Specify the user-assigned managed identity as the credential object. | Yes |
202+
203+
You also need to follow the steps:
204+
205+
1. Make sure to create on **User-assigned Managed Identity** resource on Azure portal. To learn more, go to [Manage user-assigned managed identities](/entra/identity/managed-identities-azure-resources/how-manage-user-assigned-managed-identities?pivots=identity-mi-methods-azp)
206+
1. Assign the **User-assigned Managed Identity** to your Azure database for PostgreSQL resource
207+
1. In your Azure database for PostgreSQL server resource, under **Security**
208+
1. Select **Authentication**
209+
1. Verify if Authentication method is **Microsoft Entra authentication only** or **PostgreSQL and Microsoft Entra authentication**
210+
1. Click on **+ Add Microsoft Entra administrators** and select your user-assigned managed identity
211+
212+
:::image type="content" source="media/connector-azure-database-for-postgresql/user-managed-identity-postgresql-configuration.png" alt-text="Screenshot of the user-assigned managed identity configuration in the Azure database for PostgreSQL server." lightbox="media/connector-azure-database-for-postgresql/user-managed-identity-postgresql-configuration.png":::
213+
214+
1. Assign the **User-assigned Managed Identity** to your Azure Data Factory resource
215+
1. Select **Settings** and then **Managed Identities**
216+
1. Under the **User assigned** tab. Click on the **+ Add** and select your user-managed identity
217+
218+
:::image type="content" source="media/connector-azure-database-for-postgresql/data-factory-user-identity-configuration.png" alt-text="Screenshot of the user-assigned managed identity configuration in the Azure Data Factory resource." lightbox="media/connector-azure-database-for-postgresql/data-factory-user-identity-configuration.png":::
219+
220+
1. Configure an Azure database for PostgreSQL linked service.
221+
222+
```json
223+
{
224+
"name": "AzurePostgreSqlLinkedService",
225+
"type": "Microsoft.DataFactory/factories/linkedservices",
226+
"properties": {
227+
"annotations": [],
228+
"type": "AzurePostgreSql",
229+
"version": "2.0",
230+
"typeProperties": {
231+
"server": "<server name>",
232+
"port": 5432,
233+
"database": "<database name>",
234+
"sslMode": 2,
235+
"authenticationType": "UserAssignedManagedIdentity",
236+
"credential": {
237+
"referenceName": "<your credential>",
238+
"type": "CredentialReference"
239+
}
240+
}
241+
}
242+
}
243+
```
244+
160245
### Service principal authentication
161246

162247
| Property | Description | Required |
166 KB
Loading
158 KB
Loading
Loading

0 commit comments

Comments
 (0)