Azure Synapse

📘

Azure Synapse coverage and related capabilities

Only the Azure Synapse dedicated SQL pool is supported.

This integration covers all the catalog and monitoring features (including all monitor types).

The automated lineage is not supported.

You can integrate with Synapse by following these steps:

  1. Create a Microsoft Entra Enterprise Application and a client secret
  2. Create a SQL user in Synapse with the correct permissions
  3. Create a Synapse data source in Sifflet

1- Create a Microsoft Entra Enterprise Application and a Client Secret

Create a Microsoft Entra Enterprise Application

  • Go to the Azure Portal
  • Go to Entra ID
  • Go to Enterprise Applications
  • Click on New Application
  • Click on Create your own application
  • Select “Integrate any other application you don't find in the gallery (Non-gallery)” and choose a name for the application. You should see this:
  • Click on Create
  • Save the Enterprise Application Name and ID for later

Create a Client Secret for the Enterprise Application

  • Go to the Azure Portal
  • Go to Entra ID
  • Go to App registrations
  • Click on All applications
  • Click on the application that you’ve just created. You should see this:
  • Click on Certificates & Secrets
  • Click on New client secret
  • Click on Add
  • Save the Secret Value for later

2- Create a SQL User in Synapse with the Right Permissions

Do the following steps:

  • Open Synapse Studio and run the following query in the dedicated SQL pool that you want to connect to Sifflet:
    CREATE USER [my-enterprise-app-name] FROM EXTERNAL PROVIDER;
  • Run the following query to give the db_datareader role to the user:
    EXEC sp_addrolemember 'db_datareader', 'my-enterprise-app-name';

3- Create a Synapse Data Source in Sifflet

To create a Synapse data source in Sifflet, you will need:

  • The Enterprise Application ID
  • The Enterprise Application Client Secret Value

Create the Credential

To create the Synapse credential, follow these steps:

  • In Integrations > Credentials, create a new credential
  • In the Credential area, paste the following JSON and replace the values with your Enterprise Application ID and client secret value:
    {"user":"<my-enterprise-app-id>", "password":"<my-client-secret>"}

Add the Data Source

You can refer to this page on adding a data source in Sifflet for more detailed information.

  • In Integrations > Sources, click + New
  • Fill out the necessary information collected above
    • The host is built like this: <name-of-your-synapse-workspace>.sql.azuresynapse.net (e.g. synapse-sifflet.sql.azuresynapse.net)

Troubleshooting

Depending on your system's configuration, you may not see the schemas in the master database in Sifflet.

If that is the case, verify that the default permissions include access to the master database.

If the issue persists, contact your dedicated support representative.


Did this page help you?