Merge pull request #296319 from MitchellGale/service-principal

Data Factory - Azure Database for PostgreSQL connector - Adding Service principal

Author: ttorble

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

@@ -83,11 +83,10 @@ The following properties are supported for the Azure Database for PostgreSQL lin
 |:--- |:--- |:--- |
 | type | The type property must be set to: **AzurePostgreSql**. | Yes |
 | version | The version that you specify. The value is `2.0`. | Yes |
+| authenticationType | Select from basic or service principal authentication | Yes |
 | server | Specifies the host name and optionally port on which Azure Database for PostgreSQL is running. | Yes |
 | port |The TCP port of the Azure Database for PostgreSQL server. The default value is `5432`. |No |
 | database| The name of the Azure Database for PostgreSQL database to connect to. |Yes |
-| username| The username to connect with. Not required if using IntegratedSecurity. |Yes |
-| password| The password to connect with. Not required if using IntegratedSecurity. Mark this field as **SecureString** to store it securely. Or, you can  [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). |Yes |
 | sslMode | Controls whether SSL is used, depending on server support. <br/>- **Disable**: SSL is disabled. If the server requires SSL, the connection will fail.<br/>- **Allow**: Prefer non-SSL connections if the server allows them, but allow SSL connections.<br/>- **Prefer**: Prefer SSL connections if the server allows them, but allow connections without SSL.<br/>- **Require**: The connection fails if the server doesn't support SSL.<br/>- **Verify-ca**: The connection fails if the server doesn't support SSL. Also verifies server certificate.<br/>- **Verify-full**: The connection fails if the server doesn't support SSL. Also verifies server certificate with host's name. <br/>Options: Disable (0) / Allow (1) / Prefer (2) **(Default)** / Require (3) / Verify-ca (4) / Verify-full (5) | No |
 | connectVia | This property represents the [integration runtime](concepts-integration-runtime.md) to be used to connect to the data store. You can use Azure Integration Runtime or Self-hosted Integration Runtime (if your data store is located in private network). If not specified, it uses the default Azure Integration Runtime.|No|
 | ***Additional connection properties:*** |  |  |
@@ -100,6 +99,13 @@ The following properties are supported for the Azure Database for PostgreSQL lin
 | timezone | Gets or sets the session timezone. | No |
 | encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. | No |
 
+### Basic authentication
+
+| Property | Description | Required |
+|:--- |:--- |:--- |
+| username | The username to connect with. Not required if using IntegratedSecurity. | Yes |
+| password | The password to connect with. Not required if using IntegratedSecurity. Mark this field as **SecureString** to store it securely. Or, you can  [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). | Yes |
+
 **Example**:
 
 ```json
@@ -149,8 +155,81 @@ The following properties are supported for the Azure Database for PostgreSQL lin
         }
     }
 }
+``` 
+
+### Service principal authentication
+
+| Property | Description | Required |
+|:--- |:--- |:--- |
+| username | The display name of the service principal | Yes |
+| tenant | The tenant which the Azure Database for PostgreSQL server is located |Yes |
+| servicePrincipalId | Application ID of service principal |Yes |
+| servicePrincipalCredentialType | Select if service principal certificate or service principal key is desired authentication method<br/>- **ServicePrincipalCert**: Set to service principal certificate for service principal certificate.<br/>- **ServicePrincipalKey**: Set to service principal key for service principal key authentication. | Yes |
+| servicePrincipalKey | Client secret value. Used when service principal key is selected | Yes |
+| azureCloudType | Select the Azure cloud type of your Azure Database for PostgreSQL server | Yes |
+| servicePrincipalEmbeddedCert | Service principal certificate file | Yes |
+| servicePrincipalEmbeddedCertPassword | Service principal certificate password if required | No |
+
+**Example**:
+
+**Service principal key**
+```json
+{
+    "name": "AzurePostgreSqlLinkedService",
+    "type": "Microsoft.DataFactory/factories/linkedservices",
+    "properties": {
+        "annotations": [],
+        "type": "AzurePostgreSql",
+        "version": "2.0",
+        "typeProperties": {
+            "server": "<server name>",
+            "port": 5432,
+            "database": "<database name>",
+            "sslMode": 2,
+            "username": "<service principal name>",
+            "authenticationType": "<authentication type>",
+            "tenant": "<tenant>",
+            "servicePrincipalId": "<service principal ID>",
+            "azureCloudType": "<azure cloud type>",
+            "servicePrincipalCredentialType": "<service principal type>",
+            "servicePrincipalKey": "<service principal key>"
+        }
+    }
+}
+```
+
+**Example**:
+
+**Service principal certificate**
+```json
+{
+    "name": "AzurePostgreSqlLinkedService",
+    "type": "Microsoft.DataFactory/factories/linkedservices",
+    "properties": {
+        "annotations": [],
+        "type": "AzurePostgreSql",
+        "version": "2.0",
+        "typeProperties": {
+            "server": "<server name>",
+            "port": 5432,
+            "database": "<database name>",
+            "sslMode": 2,
+            "username": "<service principal name>",
+            "authenticationType": "<authentication type>",
+            "tenant": "<tenant>",
+            "servicePrincipalId": "<service principal ID>",
+            "azureCloudType": "<azure cloud type>",
+            "servicePrincipalCredentialType": "<service principal type>",
+            "servicePrincipalEmbeddedCert": "<service principal certificate>",
+            "servicePrincipalEmbeddedCertPassword": "<service principal embedded certificate password>"
+        }
+    }
+}
 ```
 
+
+
+
 ### Version 1.0
 
 The following properties are supported for the Azure Database for PostgreSQL linked service when you apply version 1.0: