Skip to content

Commit de38c10

Browse files
committed
Update Linked service properties section
1 parent dd88b7f commit de38c10

File tree

1 file changed

+69
-41
lines changed

1 file changed

+69
-41
lines changed

articles/data-factory/connector-sql-server.md

Lines changed: 69 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -85,59 +85,20 @@ The following sections provide details about properties that are used to define
8585

8686
This SQL server connector supports the following authentication types. See the corresponding sections for details.
8787

88-
- [Windows authentication](#windows-authentication)
8988
- [SQL authentication](#sql-authentication)
89+
- [Windows authentication](#windows-authentication)
9090

9191
>[!TIP]
9292
>If you hit an error with the error code "UserErrorFailedToConnectToSqlServer" and a message like "The session limit for the database is XXX and has been reached," add `Pooling=false` to your connection string and try again.
9393
94-
### Windows authentication
95-
96-
To use Windows authentication, the following properties are supported:
97-
98-
| Property | Description | Required |
99-
|:--- |:--- |:--- |
100-
| type | The type property must be set to **SqlServer**. | Yes |
101-
| connectionString | Specify **connectionString** information that's needed to connect to the SQL Server database. Refer to the following samples.
102-
| userName | Specify a user name. An example is **domainname\\username**. |Yes |
103-
| password | Specify a password for the user account you specified for the user name. 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 |
104-
| alwaysEncryptedSettings | Specify **alwaysencryptedsettings** information that's needed to enable Always Encrypted to protect sensitive data stored in SQL server by using either managed identity or service principal. For more information, see the JSON example following the table and [Using Always Encrypted](#using-always-encrypted) section. If not specified, the default always encrypted setting is disabled. |No |
105-
| connectVia | This [integration runtime](concepts-integration-runtime.md) is used to connect to the data store. Learn more from [Prerequisites](#prerequisites) section. If not specified, the default Azure integration runtime is used. |No |
106-
107-
> [!NOTE]
108-
> Windows authentication is not supported in data flow.
109-
110-
**Example: Use Windows authentication**
111-
112-
```json
113-
{
114-
"name": "SqlServerLinkedService",
115-
"properties": {
116-
"type": "SqlServer",
117-
"typeProperties": {
118-
"connectionString": "Data Source=<servername>\\<instance name if using named instance>;Initial Catalog=<databasename>;Integrated Security=True;",
119-
"userName": "<domain\\username>",
120-
"password": {
121-
"type": "SecureString",
122-
"value": "<password>"
123-
}
124-
},
125-
"connectVia": {
126-
"referenceName": "<name of Integration Runtime>",
127-
"type": "IntegrationRuntimeReference"
128-
}
129-
}
130-
}
131-
```
132-
13394
### SQL authentication
13495

13596
To use SQL authentication, the following properties are supported:
13697

13798
| Property | Description | Required |
13899
|:--- |:--- |:--- |
139100
| type | The type property must be set to **SqlServer**. | Yes |
140-
| connectionString | Specify **connectionString** information that's needed to connect to the SQL Server database by using either SQL authentication. Specify a login name as your user name, and ensure the database that you want to connect is mapped to this login. Refer to the following samples. | Yes |
101+
| connectionString | Specify **connectionString** information that's needed to connect to the SQL Server database. Specify a login name as your user name, and ensure the database that you want to connect is mapped to this login. Refer to the following samples. | Yes |
141102
| password | If you want to put a password in Azure Key Vault, pull the `password` configuration out of the connection string. For more information, see the JSON example following the table and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md). |No |
142103
| alwaysEncryptedSettings | Specify **alwaysencryptedsettings** information that's needed to enable Always Encrypted to protect sensitive data stored in SQL server by using either managed identity or service principal. For more information, see the JSON example following the table and [Using Always Encrypted](#using-always-encrypted) section. If not specified, the default always encrypted setting is disabled. |No |
143104
| connectVia | This [integration runtime](concepts-integration-runtime.md) is used to connect to the data store. Learn more from [Prerequisites](#prerequisites) section. If not specified, the default Azure integration runtime is used. |No |
@@ -210,6 +171,73 @@ To use SQL authentication, the following properties are supported:
210171
}
211172
```
212173

174+
### Windows authentication
175+
176+
To use Windows authentication, the following properties are supported:
177+
178+
| Property | Description | Required |
179+
|:--- |:--- |:--- |
180+
| type | The type property must be set to **SqlServer**. | Yes |
181+
| connectionString | Specify **connectionString** information that's needed to connect to the SQL Server database. Refer to the following samples.
182+
| userName | Specify a user name. An example is **domainname\\username**. |Yes |
183+
| password | Specify a password for the user account you specified for the user name. 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 |
184+
| alwaysEncryptedSettings | Specify **alwaysencryptedsettings** information that's needed to enable Always Encrypted to protect sensitive data stored in SQL server by using either managed identity or service principal. For more information, see [Using Always Encrypted](#using-always-encrypted) section. If not specified, the default always encrypted setting is disabled. |No |
185+
| connectVia | This [integration runtime](concepts-integration-runtime.md) is used to connect to the data store. Learn more from [Prerequisites](#prerequisites) section. If not specified, the default Azure integration runtime is used. |No |
186+
187+
> [!NOTE]
188+
> Windows authentication is not supported in data flow.
189+
190+
**Example: Use Windows authentication**
191+
192+
```json
193+
{
194+
"name": "SqlServerLinkedService",
195+
"properties": {
196+
"type": "SqlServer",
197+
"typeProperties": {
198+
"connectionString": "Data Source=<servername>\\<instance name if using named instance>;Initial Catalog=<databasename>;Integrated Security=True;",
199+
"userName": "<domain\\username>",
200+
"password": {
201+
"type": "SecureString",
202+
"value": "<password>"
203+
}
204+
},
205+
"connectVia": {
206+
"referenceName": "<name of Integration Runtime>",
207+
"type": "IntegrationRuntimeReference"
208+
}
209+
}
210+
}
211+
```
212+
213+
**Example: Use Windows authentication with a password in Azure Key Vault**
214+
215+
```json
216+
{
217+
"name": "SqlServerLinkedService",
218+
"properties": {
219+
"annotations": [],
220+
"type": "SqlServer",
221+
"typeProperties": {
222+
"connectionString": "Data Source=<servername>\\<instance name if using named instance>;Initial Catalog=<databasename>;Integrated Security=True;",
223+
"userName": "<domain\\username>",
224+
"password": {
225+
"type": "AzureKeyVaultSecret",
226+
"store": {
227+
"referenceName": "<Azure Key Vault linked service name>",
228+
"type": "LinkedServiceReference"
229+
},
230+
"secretName": "<secretName>"
231+
}
232+
},
233+
"connectVia": {
234+
"referenceName": "<name of Integration Runtime>",
235+
"type": "IntegrationRuntimeReference"
236+
}
237+
}
238+
}
239+
```
240+
213241
## Dataset properties
214242

215243
For a full list of sections and properties available for defining datasets, see the [datasets](concepts-datasets-linked-services.md) article. This section provides a list of properties supported by the SQL Server dataset.

0 commit comments

Comments
 (0)