Skip to content

Commit 6a68b02

Browse files
ShannonLeavittShannonLeavitt
authored
Merge pull request #98633 from Samantha-Yu/adfupdate1211
Updated connectionString settings for connector articles
2 parents e5b3628 + 201be94 commit 6a68b02

24 files changed

+75
-231
lines changed

‎articles/data-factory/connector-azure-blob-storage.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ To use storage account key authentication, the following properties are supporte
7171
| Property | Description | Required |
7272
|:--- |:--- |:--- |
7373
| type | The type property must be set to **AzureBlobStorage** (suggested) or **AzureStorage** (see notes below). |Yes |
74-
| connectionString | Specify the information needed to connect to Storage for the connectionString property. <br/>Mark this field as a SecureString to store it securely in Data Factory. You can also put account key in Azure Key Vault and pull the `accountKey` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. |Yes |
74+
| connectionString | Specify the information needed to connect to Storage for the connectionString property. <br/> You can also put account key in Azure Key Vault and pull the `accountKey` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. |Yes |
7575
| connectVia | 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 in a private network). If not specified, it uses the default Azure Integration Runtime. |No |
7676

7777
>[!NOTE]
@@ -88,10 +88,7 @@ To use storage account key authentication, the following properties are supporte
8888
"properties": {
8989
"type": "AzureBlobStorage",
9090
"typeProperties": {
91-
"connectionString": {
92-
"type": "SecureString",
93-
"value": "DefaultEndpointsProtocol=https;AccountName=<accountname>;AccountKey=<accountkey>"
94-
}
91+
"connectionString": "DefaultEndpointsProtocol=https;AccountName=<accountname>;AccountKey=<accountkey>"
9592
},
9693
"connectVia": {
9794
"referenceName": "<name of Integration Runtime>",
@@ -109,10 +106,7 @@ To use storage account key authentication, the following properties are supporte
109106
"properties": {
110107
"type": "AzureBlobStorage",
111108
"typeProperties": {
112-
"connectionString": {
113-
"type": "SecureString",
114-
"value": "DefaultEndpointsProtocol=https;AccountName=<accountname>;"
115-
},
109+
"connectionString": "DefaultEndpointsProtocol=https;AccountName=<accountname>;",
116110
"accountKey": { 
117111
"type": "AzureKeyVaultSecret", 
118112
"store": { 

‎articles/data-factory/connector-azure-cosmos-db-mongodb-api.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The following properties are supported for the Azure Cosmos DB's API for MongoDB
4343
| Property | Description | Required |
4444
|:--- |:--- |:--- |
4545
| type | The **type** property must be set to **CosmosDbMongoDbApi**. | Yes |
46-
| connectionString |Specify the connection string for your Azure Cosmos DB's API for MongoDB. You can find it in the Azure portal -> your Cosmos DB blade -> primary or secondary connection string, with the pattern of `mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.documents.azure.com:10255/?ssl=true&replicaSet=globaldb`. <br/><br />Mark this field as a **SecureString** type to store it securely in Data Factory. You can also [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). |Yes |
46+
| connectionString |Specify the connection string for your Azure Cosmos DB's API for MongoDB. You can find it in the Azure portal -> your Cosmos DB blade -> primary or secondary connection string, with the pattern of `mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.documents.azure.com:10255/?ssl=true&replicaSet=globaldb`. <br/><br />You can also put a password in Azure Key Vault and pull the `password` configuration out of the connection string. Refer to [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) with more details.|Yes |
4747
| database | Name of the database that you want to access. | Yes |
4848
| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to use to connect to the data store. You can use the Azure Integration Runtime or a self-hosted integration runtime (if your data store is located in a private network). If this property isn't specified, the default Azure Integration Runtime is used. |No |
4949

@@ -55,10 +55,7 @@ The following properties are supported for the Azure Cosmos DB's API for MongoDB
5555
"properties": {
5656
"type": "CosmosDbMongoDbApi",
5757
"typeProperties": {
58-
"connectionString": {
59-
"type": "SecureString",
60-
"value": "mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.documents.azure.com:10255/?ssl=true&replicaSet=globaldb"
61-
},
58+
"connectionString": "mongodb://<cosmosdb-name>:<password>@<cosmosdb-name>.documents.azure.com:10255/?ssl=true&replicaSet=globaldb",
6259
"database": "myDatabase"
6360
},
6461
"connectVia": {

‎articles/data-factory/connector-azure-cosmos-db.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The following properties are supported for the Azure Cosmos DB (SQL API) linked
5656
| Property | Description | Required |
5757
|:--- |:--- |:--- |
5858
| type | The **type** property must be set to **CosmosDb**. | Yes |
59-
| connectionString |Specify information that's required to connect to the Azure Cosmos DB database.<br />**Note**: You must specify database information in the connection string as shown in the examples that follow. <br/>Mark this field as a SecureString to store it securely in Data Factory. You can also put account key in Azure Key Vault and pull the `accountKey` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. |Yes |
59+
| connectionString |Specify information that's required to connect to the Azure Cosmos DB database.<br />**Note**: You must specify database information in the connection string as shown in the examples that follow. <br/> You can also put account key in Azure Key Vault and pull the `accountKey` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. |Yes |
6060
| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to use to connect to the data store. You can use the Azure Integration Runtime or a self-hosted integration runtime (if your data store is located in a private network). If this property isn't specified, the default Azure Integration Runtime is used. |No |
6161

6262
**Example**
@@ -67,10 +67,7 @@ The following properties are supported for the Azure Cosmos DB (SQL API) linked
6767
"properties": {
6868
"type": "CosmosDb",
6969
"typeProperties": {
70-
"connectionString": {
71-
"type": "SecureString",
72-
"value": "AccountEndpoint=<EndpointUrl>;AccountKey=<AccessKey>;Database=<Database>"
73-
}
70+
"connectionString": "AccountEndpoint=<EndpointUrl>;AccountKey=<AccessKey>;Database=<Database>"
7471
},
7572
"connectVia": {
7673
"referenceName": "<name of Integration Runtime>",
@@ -88,10 +85,7 @@ The following properties are supported for the Azure Cosmos DB (SQL API) linked
8885
"properties": {
8986
"type": "CosmosDb",
9087
"typeProperties": {
91-
"connectionString": {
92-
"type": "SecureString",
93-
"value": "AccountEndpoint=<EndpointUrl>;Database=<Database>"
94-
},
88+
"connectionString": "AccountEndpoint=<EndpointUrl>;Database=<Database>",
9589
"accountKey": { 
9690
"type": "AzureKeyVaultSecret", 
9791
"store": { 

‎articles/data-factory/connector-azure-database-for-mariadb.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The following properties are supported for Azure Database for MariaDB linked ser
4141
| Property | Description | Required |
4242
|:--- |:--- |:--- |
4343
| type | The type property must be set to: **AzureMariaDB** | Yes |
44-
| connectionString | A connection string to connect to Azure Database for MariaDB. You can find it from the Azure portal -> your Azure Database for MariaDB -> Connection strings -> ADO.NET one. <br/>Mark this field as a SecureString to store it securely in Data Factory. You can also put password in Azure Key Vault and pull the `pwd` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. | Yes |
44+
| connectionString | A connection string to connect to Azure Database for MariaDB. You can find it from the Azure portal -> your Azure Database for MariaDB -> Connection strings -> ADO.NET one. <br/> You can also put password in Azure Key Vault and pull the `pwd` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. | Yes |
4545
| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to be used to connect to the data store. If not specified, it uses the default Azure Integration Runtime. |No |
4646

4747
**Example:**
@@ -52,10 +52,7 @@ The following properties are supported for Azure Database for MariaDB linked ser
5252
"properties": {
5353
"type": "AzureMariaDB",
5454
"typeProperties": {
55-
"connectionString": {
56-
"type": "SecureString",
57-
"value": "Server={your_server}.mariadb.database.azure.com; Port=3306; Database={your_database}; Uid={your_user}@{your_server}; Pwd={your_password}; SslMode=Preferred;"
58-
}
55+
"connectionString": "Server={your_server}.mariadb.database.azure.com; Port=3306; Database={your_database}; Uid={your_user}@{your_server}; Pwd={your_password}; SslMode=Preferred;"
5956
},
6057
"connectVia": {
6158
"referenceName": "<name of Integration Runtime>",
@@ -73,10 +70,7 @@ The following properties are supported for Azure Database for MariaDB linked ser
7370
"properties": {
7471
"type": "AzureMariaDB",
7572
"typeProperties": {
76-
"connectionString": {
77-
"type": "SecureString",
78-
"value": "Server={your_server}.mariadb.database.azure.com; Port=3306; Database={your_database}; Uid={your_user}@{your_server}; SslMode=Preferred;"
79-
},
73+
"connectionString": "Server={your_server}.mariadb.database.azure.com; Port=3306; Database={your_database}; Uid={your_user}@{your_server}; SslMode=Preferred;",
8074
"pwd": { 
8175
"type": "AzureKeyVaultSecret", 
8276
"store": { 

‎articles/data-factory/connector-azure-database-for-mysql.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The following properties are supported for Azure Database for MySQL linked servi
4343
| Property | Description | Required |
4444
|:--- |:--- |:--- |
4545
| type | The type property must be set to: **AzureMySql** | Yes |
46-
| connectionString | Specify information needed to connect to the Azure Database for MySQL instance. <br/>Mark this field as a SecureString to store it securely in Data Factory. You can also put password in Azure Key Vault and pull the `password` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. | Yes |
46+
| connectionString | Specify information needed to connect to the Azure Database for MySQL instance. <br/> You can also put password in Azure Key Vault and pull the `password` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. | Yes |
4747
| connectVia | 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 |
4848

4949
A typical connection string is `Server=<server>.mysql.database.azure.com;Port=<port>;Database=<database>;UID=<username>;PWD=<password>`. More properties you can set per your case:
@@ -61,10 +61,7 @@ A typical connection string is `Server=<server>.mysql.database.azure.com;Port=<p
6161
"properties": {
6262
"type": "AzureMySql",
6363
"typeProperties": {
64-
"connectionString": {
65-
"type": "SecureString",
66-
"value": "Server=<server>.mysql.database.azure.com;Port=<port>;Database=<database>;UID=<username>;PWD=<password>"
67-
}
64+
"connectionString": "Server=<server>.mysql.database.azure.com;Port=<port>;Database=<database>;UID=<username>;PWD=<password>"
6865
},
6966
"connectVia": {
7067
"referenceName": "<name of Integration Runtime>",
@@ -82,10 +79,7 @@ A typical connection string is `Server=<server>.mysql.database.azure.com;Port=<p
8279
"properties": {
8380
"type": "AzureMySql",
8481
"typeProperties": {
85-
"connectionString": {
86-
"type": "SecureString",
87-
"value": "Server=<server>.mysql.database.azure.com;Port=<port>;Database=<database>;UID=<username>;"
88-
},
82+
"connectionString": "Server=<server>.mysql.database.azure.com;Port=<port>;Database=<database>;UID=<username>;",
8983
"password": { 
9084
"type": "AzureKeyVaultSecret", 
9185
"store": { 

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The following properties are supported for the Azure Database for PostgreSQL lin
4343
| Property | Description | Required |
4444
|:--- |:--- |:--- |
4545
| type | The type property must be set to: **AzurePostgreSql**. | Yes |
46-
| connectionString | An ODBC connection string to connect to Azure Database for PostgreSQL.<br/>Mark this field as a SecureString to store it securely in Data Factory. You can also put a password in Azure Key Vault and pull the `password` configuration out of the connection string. See the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) for more details. | Yes |
46+
| connectionString | An ODBC connection string to connect to Azure Database for PostgreSQL.<br/>You can also put a password in Azure Key Vault and pull the `password` configuration out of the connection string. See the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) for more details. | Yes |
4747
| 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 |
4848

4949
A typical connection string is `Server=<server>.postgres.database.azure.com;Database=<database>;Port=<port>;UID=<username>;Password=<Password>`. Here are more properties you can set per your case:
@@ -61,10 +61,7 @@ A typical connection string is `Server=<server>.postgres.database.azure.com;Data
6161
"properties": {
6262
"type": "AzurePostgreSql",
6363
"typeProperties": {
64-
"connectionString": {
65-
"type": "SecureString",
66-
"value": "Server=<server>.postgres.database.azure.com;Database=<database>;Port=<port>;UID=<username>;Password=<Password>"
67-
}
64+
"connectionString": "Server=<server>.postgres.database.azure.com;Database=<database>;Port=<port>;UID=<username>;Password=<Password>"
6865
}
6966
}
7067
}
@@ -80,10 +77,7 @@ A typical connection string is `Server=<server>.postgres.database.azure.com;Data
8077
"properties": {
8178
"type": "AzurePostgreSql",
8279
"typeProperties": {
83-
"connectionString": {
84-
"type": "SecureString",
85-
"value": "Server=<server>.postgres.database.azure.com;Database=<database>;Port=<port>;UID=<username>;"
86-
},
80+
"connectionString": "Server=<server>.postgres.database.azure.com;Database=<database>;Port=<port>;UID=<username>;",
8781
"password": { 
8882
"type": "AzureKeyVaultSecret", 
8983
"store": { 

‎articles/data-factory/connector-azure-sql-data-warehouse.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,7 @@ For different authentication types, refer to the following sections on prerequis
8181
"properties": {
8282
"type": "AzureSqlDW",
8383
"typeProperties": {
84-
"connectionString": {
85-
"type": "SecureString",
86-
"value": "Server=tcp:<servername>.database.windows.net,1433;Database=<databasename>;User ID=<username>@<servername>;Password=<password>;Trusted_Connection=False;Encrypt=True;Connection Timeout=30"
87-
}
84+
"connectionString": "Server=tcp:<servername>.database.windows.net,1433;Database=<databasename>;User ID=<username>@<servername>;Password=<password>;Trusted_Connection=False;Encrypt=True;Connection Timeout=30"
8885
},
8986
"connectVia": {
9087
"referenceName": "<name of Integration Runtime>",
@@ -102,10 +99,7 @@ For different authentication types, refer to the following sections on prerequis
10299
"properties": {
103100
"type": "AzureSqlDW",
104101
"typeProperties": {
105-
"connectionString": {
106-
"type": "SecureString",
107-
"value": "Server=tcp:<servername>.database.windows.net,1433;Database=<databasename>;User ID=<username>@<servername>;Trusted_Connection=False;Encrypt=True;Connection Timeout=30"
108-
},
102+
"connectionString": "Server=tcp:<servername>.database.windows.net,1433;Database=<databasename>;User ID=<username>@<servername>;Trusted_Connection=False;Encrypt=True;Connection Timeout=30",
109103
"password": {
110104
"type": "AzureKeyVaultSecret",
111105
"store": {
@@ -158,10 +152,7 @@ To use service principal-based Azure AD application token authentication, follow
158152
"properties": {
159153
"type": "AzureSqlDW",
160154
"typeProperties": {
161-
"connectionString": {
162-
"type": "SecureString",
163-
"value": "Server=tcp:<servername>.database.windows.net,1433;Database=<databasename>;Connection Timeout=30"
164-
},
155+
"connectionString": "Server=tcp:<servername>.database.windows.net,1433;Database=<databasename>;Connection Timeout=30",
165156
"servicePrincipalId": "<service principal id>",
166157
"servicePrincipalKey": {
167158
"type": "SecureString",
@@ -207,10 +198,7 @@ To use managed identity authentication, follow these steps:
207198
"properties": {
208199
"type": "AzureSqlDW",
209200
"typeProperties": {
210-
"connectionString": {
211-
"type": "SecureString",
212-
"value": "Server=tcp:<servername>.database.windows.net,1433;Database=<databasename>;Connection Timeout=30"
213-
}
201+
"connectionString": "Server=tcp:<servername>.database.windows.net,1433;Database=<databasename>;Connection Timeout=30"
214202
},
215203
"connectVia": {
216204
"referenceName": "<name of Integration Runtime>",

0 commit comments

Comments
 (0)