Microsoft Azure Synapse Analytics
App Vendor: Microsoft
App Category: Data Lake & Analytics
Connector Version: 1.0.0
API Version: ODBC Driver 18 for SQL Server
About App
The Microsoft Azure Synapse analytics app helps teams interact with their synapse data environments to support analytics and operational workflows. it provides a simple way to run SQL queries and manage data securely.
The Microsoft Azure Synapse Analytics app is configured with Cyware Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Execute Query | Enter a T-SQL SELECT query to retrieve data from Azure Synapse. Only SELECT statements are supported. |
Configuration Parameters
The following configuration parameters are required for the Microsoft Azure Synapse Analytics app to communicate with the Microsoft Azure Synapse Analytics enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
SQL Endpoint | Enter the Azure Synapse SQL endpoint. You can use either the dedicated SQL endpoint or the serverless SQL endpoint from your Synapse workspace. Example: workspacename.sql.azuresynapse.net or workspacename-ondemand.sql.azuresynapse.net | Text | Required | |
Database | Enter the name of the SQL database in the Synapse workspace that you want to connect to. Example: analyticsdb | Text | Required | |
Username | Enter the username based on the selected authentication type. | Text | Required | Use the SQL admin username for SQL, the Azure AD tenant user ID for ActiveDirectoryPassword, or the application's client ID for ActiveDirectoryServicePrincipal. |
Password | Enter the password based on the selected authentication type. Use the SQL admin password for SQL, the Azure AD tenant user password for ActiveDirectoryPassword, or the application's client secret for ActiveDirectoryServicePrincipal. | Password | Required | |
Authentication Type | Select the authentication type to connect to Azure Synapse. allowed values are SQL (for SQL authentication), ActiveDirectoryPassword (for an Azure AD tenant user), or ActiveDirectoryServicePrincipal (for an application's service principal). | Text | Required | |
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with the Microsoft Azure Synapse Analytics. | Integer | Optional | Allowed range: 15-120 seconds Default timeout: 30 seconds |
Verify | Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in connection errors. | Boolean | Optional |
Action: Execute Query
This action executes a SQL query on Azure Synapse, handling data retrieval (SELECT) operations. It manages the database connection, executes the query safely, and returns the results in a structured, JSON-serializable format.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
SQL Query | Enter a T-SQL SELECT query to retrieve data from Azure Synapse. Only SELECT statements are supported. Example: SELECT DB_NAME() AS CurrentDB, GETDATE() AS ServerTime; | Text | Required |
Example Request
[
{
"sql_query": "SELECT DB_NAME() AS CurrentDB, GETDATE() AS ServerTime"
}
]