Skip to content

Commit 635e5ef

Browse files
ecfanecfan
committed
Refactor built-in connector operation info
1 parent ebcd113 commit 635e5ef

File tree

1 file changed

+7
-248
lines changed

1 file changed

+7
-248
lines changed

‎articles/connectors/connectors-create-api-sqlazure.md

Lines changed: 7 additions & 248 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ The SQL Server connector has different versions, based on [logic app type and ho
3838
|-----------|-------------|-------------------|
3939
| **Consumption** | Multi-tenant Azure Logic Apps | Managed connector (Standard class). For more information, review the following documentation: <br><br>- [SQL Server managed connector reference](/connectors/sql) <br>- [Managed connectors in Azure Logic Apps](managed.md) |
4040
| **Consumption** | Integration service environment (ISE) | Managed connector (Standard class) and ISE version, which has different message limits than the Standard class. For more information, review the following documentation: <br><br>- [SQL Server managed connector reference](/connectors/sql) <br>- [ISE message limits](../logic-apps/logic-apps-limits-and-config.md#message-size-limits) <br>- [Managed connectors in Azure Logic Apps](managed.md) |
41-
| **Standard** | Single-tenant Azure Logic Apps and App Service Environment v3 (Windows plans only) | Managed connector (Azure-hosted) and built-in connector, which is [service provider based](../logic-apps/custom-connector-overview.md#service-provider-interface-implementation). The built-in version differs in the following ways: <br><br>- The built-in version doesn't have triggers. You can use the SQL managed connector trigger or a different trigger. <br><br>- The built-in version can connect directly to an SQL database and access Azure virtual networks. You don't need an on-premises data gateway.<br><br>For more information, review the following documentation: <br><br>- [SQL Server managed connector reference](/connectors/sql/) <br>- [SQL Server built-in connector reference](#built-in-connector-operations) section later in this article <br>- [Built-in connectors in Azure Logic Apps](built-in.md) |
41+
| **Standard** | Single-tenant Azure Logic Apps and App Service Environment v3 (Windows plans only) | Managed connector (Azure-hosted) and built-in connector, which is [service provider based](../logic-apps/custom-connector-overview.md#service-provider-interface-implementation). The built-in version differs in the following ways: <br><br>- The built-in version doesn't have triggers. You can use the SQL managed connector trigger or a different trigger. <br><br>- The built-in version can connect directly to an SQL database and access Azure virtual networks. You don't need an on-premises data gateway.<br><br>For more information, review the following documentation: <br><br>- [SQL Server managed connector reference](/connectors/sql/) <br>- [SQL Server built-in connector reference](/azure/logic-apps/connectors/built-in/reference/sql/) <br>- [Built-in connectors in Azure Logic Apps](built-in.md) |
4242

4343
## Limitations
4444

45-
For more information, review the [SQL Server managed connector reference](/connectors/sql/) or the [SQL Server built-in connector reference](#built-in-connector-operations).
45+
For more information, review the [SQL Server managed connector reference](/connectors/sql/) or the [SQL Server built-in connector reference](/azure/logic-apps/connectors/built-in/reference/sql/).
4646

4747
## Prerequisites
4848

@@ -87,7 +87,9 @@ For more information, review the [SQL Server managed connector reference](/conne
8787

8888
You can use the SQL Server built-in connector or managed connector.
8989

90-
* To use the built-in connector, you can authenticate your connection with either a managed identity, Active Directory OAuth, or a connection string. You can adjust connection pooling by specifying parameters in the connection string. For more information, review [Connection Pooling](/dotnet/framework/data/adonet/connection-pooling).
90+
* To use Azure Active Directory authentication or managed identity authentication with your logic app, you have to set up your SQL Server to work with these authentication types. For more information, see [Authentication - SQL Server managed connector reference](/connectors/sql/#authentication).
91+
92+
* To use the built-in connector, you can authenticate your connection with either a managed identity, Azure Active Directory, or a connection string. You can adjust connection pooling by specifying parameters in the connection string. For more information, review [Connection Pooling](/dotnet/framework/data/adonet/connection-pooling).
9193

9294
* To use the SQL Server managed connector, follow the same requirements as a Consumption logic app workflow in multi-tenant Azure Logic Apps. For other connector requirements, review the [SQL Server managed connector reference](/connectors/sql/).
9395

@@ -231,7 +233,7 @@ In this example, the logic app workflow starts with the [Recurrence trigger](../
231233

232234
1. Under the **Choose an operation** search box, select either of the following options:
233235

234-
* **Built-in** when you want to use SQL Server [built-in actions](#built-in-connector-operations) such as **Execute query**
236+
* **Built-in** when you want to use SQL Server [built-in actions](/azure/logic-apps/connectors/built-in/reference/sql/) such as **Execute query**
235237

236238
![Screenshot showing the Azure portal, workflow designer for Standard logic app, and designer search box with "Built-in" selected underneath.](./media/connectors-create-api-sqlazure/select-built-in-category-standard.png)
237239

@@ -243,7 +245,7 @@ In this example, the logic app workflow starts with the [Recurrence trigger](../
243245

244246
1. From the actions list, select the SQL Server action that you want.
245247

246-
* [Built-in actions](#built-in-connector-operations)
248+
* [Built-in actions](/azure/logic-apps/connectors/built-in/reference/sql/)
247249

248250
This example selects the built-in action named **Execute query**.
249251

@@ -447,249 +449,6 @@ When you call a stored procedure by using the SQL Server connector, the returned
447449

448450
1. To reference the JSON content properties, click inside the edit boxes where you want to reference those properties so that the dynamic content list appears. In the list, under the [**Parse JSON**](../logic-apps/logic-apps-perform-data-operations.md#parse-json-action) heading, select the data tokens for the JSON content properties that you want.
449451

450-
<a name="built-in-connector-app-settings"></a>
451-
452-
## Built-in connector app settings
453-
454-
In a Standard logic app resource, the SQL Server built-in connector includes app settings that control various thresholds for performance, throughput, capacity, and so on. For example, you can change the query timeout value from 30 seconds. For more information, review [Reference for app settings - local.settings.json](../logic-apps/edit-app-settings-host-settings.md#reference-local-settings-json).
455-
456-
<a name="built-in-connector-operations"></a>
457-
458-
## SQL built-in connector operations
459-
460-
The SQL Server built-in connector is available only for Standard logic app workflows and provides the following actions, but no triggers:
461-
462-
| Action | Description |
463-
|--------|-------------|
464-
| [**Delete rows**](#delete-rows) | Deletes and returns the table rows that match the specified **Where condition** value. |
465-
| [**Execute query**](#execute-query) | Runs a query on an SQL database. |
466-
| [**Execute stored procedure**](#execute-stored-procedure) | Runs a stored procedure on an SQL database. |
467-
| [**Get rows**](#get-rows) | Gets the table rows that match the specified **Where condition** value. |
468-
| [**Get tables**](#get-tables) | Gets all the tables from the database. |
469-
| [**Insert row**](#insert-row) | Inserts a single row in the specified table. |
470-
| [**Update rows**](#update-rows) | Updates the specified columns in all the table rows that match the specified **Where condition** value using the **Set columns** column names and values. |
471-
472-
<a name="delete-rows"></a>
473-
474-
### Delete rows
475-
476-
Operation ID: `deleteRows`
477-
478-
Deletes and returns the table rows that match the specified **Where condition** value.
479-
480-
#### Parameters
481-
482-
| Name | Key | Required | Type | Description |
483-
|------|-----|----------|------|-------------|
484-
| **Table name** | `tableName` | True | String | The name for the table |
485-
| **Where condition** | `columnValuesForWhereCondition` | True | Object | This object contains the column names and corresponding values used for selecting the rows to delete. To provide this information, follow the *key-value* pair format, for example, *columnName* and *columnValue*, which also lets you specify single or specific rows to delete. |
486-
487-
#### Returns
488-
489-
| Name | Type |
490-
|------|------|
491-
| **Result** | An array object that returns all the deleted rows. Each row contains the column name and the corresponding deleted value. |
492-
| **Result Item** | An array object that returns one deleted row at a time. A **For each** loop is automatically added to your workflow to iterate through the array. Each row contains the column name and the corresponding deleted value. |
493-
494-
*Example*
495-
496-
The following example shows sample parameter values for the **Delete rows** action:
497-
498-
**Sample values**
499-
500-
| Parameter | JSON name | Sample value |
501-
|-----------|-----------|--------------|
502-
| **Table name** | `tableName` | tableName1 |
503-
| **Where condition** | `columnValuesForWhereCondition` | Key-value pairs: <br><br>- <*columnName1*>, <*columnValue1*> <br><br>- <*columnName2*>, <*columnValue2*> |
504-
505-
**Parameters in the action's underlying JSON definition**
506-
507-
```json
508-
"parameters": {
509-
"tableName": "tableName1",
510-
"columnValuesForWhereCondition": {
511-
"columnName1": "columnValue1",
512-
"columnName2": "columnValue2"
513-
}
514-
},
515-
```
516-
517-
<a name="execute-query"></a>
518-
519-
### Execute query
520-
521-
Operation ID: `executeQuery`
522-
523-
Runs a query on an SQL database.
524-
525-
#### Parameters
526-
527-
| Name | Key | Required | Type | Description |
528-
|------|-----|----------|------|-------------|
529-
| **Query** | `query` | True | Dynamic | The body for your SQL query |
530-
| **Query parameters** | `queryParameters` | False | Objects | The parameters for your query. <br><br>**Note**: If the query requires input parameters, you must provide these parameters. |
531-
532-
#### Returns
533-
534-
| Name | Type |
535-
|------|------|
536-
| **Result** | An array object that returns all the query results. Each row contains the column name and the corresponding value. |
537-
| **Result Item** | An array object that returns one query result at a time. A **For each** loop is automatically added to your workflow to iterate through the array. Each row contains the column name and the corresponding value. |
538-
539-
<a name="execute-stored-procedure"></a>
540-
541-
### Execute stored procedure
542-
543-
Operation ID: `executeStoredProcedure`
544-
545-
Runs a stored procedure on an SQL database.
546-
547-
#### Parameters
548-
549-
| Name | Key | Required | Type | Description |
550-
|------|-----|----------|------|-------------|
551-
| **Procedure name** | `storedProcedureName` | True | String | The name for your stored procedure |
552-
| **Parameters** | `storedProcedureParameters` | False | Dynamic | The parameters for your stored procedure. <br><br>**Note**: If the stored procedure requires input parameters, you must provide these parameters. |
553-
554-
#### Returns
555-
556-
| Name | Type |
557-
|------|------|
558-
| **Result** | An object that contains the result sets array, return code, and output parameters |
559-
| **Result Result Sets** | An object array that contains all the result sets from the stored procedure, which might return zero, one, or multiple result sets. |
560-
| **Result Return Code** | An integer that represents the status code from the stored procedure |
561-
| **Result Stored Procedure Parameters** | An object that contains the final values of the stored procedure's output and input-output parameters |
562-
| **Status Code** | The status code from the **Execute stored procedure** operation |
563-
564-
<a name="get-rows"></a>
565-
566-
### Get rows
567-
568-
Operation ID: `getRows`
569-
570-
Gets the table rows that match the specified **Where condition** value.
571-
572-
#### Parameters
573-
574-
| Name | Key | Required | Type | Description |
575-
|------|-----|----------|------|-------------|
576-
| **Table name** | `tableName` | True | String | The name for the table |
577-
| **Where condition** | `columnValuesForWhereCondition` | False | Dynamic | This object contains the column names and corresponding values used for selecting the rows to get. To provide this information, follow the *key-value* pair format, for example, *columnName* and *columnValue*, which also lets you specify single or specific rows to get. |
578-
579-
#### Returns
580-
581-
| Name | Type |
582-
|------|------|
583-
| **Result** | An array object that returns all the row results. |
584-
| **Result Item** | An array object that returns one row result at a time. A **For each** loop is automatically added to your workflow to iterate through the array. |
585-
586-
*Example*
587-
588-
The following example shows sample parameter values for the **Get rows** action:
589-
590-
**Sample values**
591-
592-
| Parameter | JSON name | Sample value |
593-
|-----------|-----------|--------------|
594-
| **Table name** | `tableName` | tableName1 |
595-
| **Where condition** | `columnValuesForWhereCondition` | Key-value pairs: <br><br>- <*columnName1*>, <*columnValue1*> <br><br>- <*columnName2*>, <*columnValue2*> |
596-
597-
**Parameters in the action's underlying JSON definition**
598-
599-
```json
600-
"parameters": {
601-
"tableName": "tableName1",
602-
"columnValuesForWhereCondition": {
603-
"columnName1": "columnValue1",
604-
"columnName2": "columnValue2"
605-
}
606-
},
607-
```
608-
609-
<a name="get-tables"></a>
610-
611-
### Get tables
612-
613-
Operation ID: `getTables`
614-
615-
Gets a list of all the tables in the database.
616-
617-
#### Parameters
618-
619-
None.
620-
621-
#### Returns
622-
623-
| Name | Type |
624-
|------|------|
625-
| **Result** | An array object that contains the full names and display names for all tables in the database. |
626-
| **Result Display Name** | An array object that contains the display name for each table in the database. A **For each** loop is automatically added to your workflow to iterate through the array. |
627-
| **Result Full Name** | An array object that contains the full name for each table in the database. A **For each** loop is automatically added to your workflow to iterate through the array. |
628-
| **Result Item** | An array object that returns the full name and display name one at time for each table. A **For each** loop is automatically added to your workflow to iterate through the array. |
629-
630-
<a name="insert-row"></a>
631-
632-
### Insert row
633-
634-
Operation ID: `insertRow`
635-
636-
Inserts a single row in the specified table.
637-
638-
| Name | Key | Required | Type | Description |
639-
|------|-----|----------|------|-------------|
640-
| **Table name** | `tableName` | True | String | The name for the table |
641-
| **Set columns** | `setColumns` | False | Dynamic | This object contains the column names and corresponding values to insert. To provide this information, follow the *key-value* pair format, for example, *columnName* and *columnValue*. If the table has columns with default or autogenerated values, you can leave this field empty. |
642-
643-
#### Returns
644-
645-
| Name | Type |
646-
|------|------|
647-
| **Result** | The inserted row, including the names and values of any autogenerated, default, and null value columns. |
648-
649-
<a name="update-rows"></a>
650-
651-
### Update rows
652-
653-
Operation ID: `updateRows`
654-
655-
Updates the specified columns in all the table rows that match the specified **Where condition** value using the **Set columns** column names and values.
656-
657-
| Name | Key | Required | Type | Description |
658-
|------|-----|----------|------|-------------|
659-
| **Table name** | `tableName` | True | String | The name for the table |
660-
| **Where condition** | `columnValuesForWhereCondition` | True | Dynamic | This object contains the column names and corresponding values for selecting the rows to update. To provide this information, follow the *key-value* pair format, for example, *columnName* and *columnValue*, which also lets you specify single or specific rows to update. |
661-
| **Set columns** | `setColumns` | True | Dynamic | This object contains the column names and the corresponding values to use for the update. To provide this information, follow the *key-value* pair format, for example, *columnName* and *columnValue*. |
662-
663-
#### Returns
664-
665-
| Name | Type |
666-
|------|------|
667-
| **Result** | An array object that returns all the columns for the updated rows. |
668-
| **Result Item** | An array object that returns one column at a time from the updated rows. A **For each** loop is automatically added to your workflow to iterate through the array. |
669-
670-
*Example*
671-
672-
The following example shows sample parameter values for the **Update rows** action:
673-
674-
**Sample values**
675-
676-
| Parameter | JSON name | Sample value |
677-
|-----------|-----------|--------------|
678-
| **Table name** | `tableName` | tableName1 |
679-
| **Where condition** | `columnValuesForWhereCondition` | Key-value pairs: <br><br>- <*columnName1*>, <*columnValue1*> <br><br>- <*columnName2*>, <*columnValue2*> |
680-
681-
**Parameters in the action's underlying JSON definition**
682-
683-
```json
684-
"parameters": {
685-
"tableName": "tableName1",
686-
"columnValuesForWhereCondition": {
687-
"columnName1": "columnValue1",
688-
"columnName2": "columnValue2"
689-
}
690-
},
691-
```
692-
693452
## Troubleshoot problems
694453

695454
<a name="connection-problems"></a>

0 commit comments

Comments
 (0)