Configure Azure Synapse Analytics Integration

This page provides a tutorial for enabling the Azure Synapse Analytics integration on the Immuta app settings page. To configure this integration via the Immuta API, see the Configure an Azure Synapse Analytics integration API guide.

For an overview of the integration, see the Azure Synapse Analytics overview documentation.

Requirement

• A running dedicated SQL pool is required.

Prerequisites

If you are using the OAuth authentication method,

• Ensure that Microsoft Entra ID is on the same account as the Azure Synapse Analytics workspace and dedicated SQL pool.

• Set up OAuth via Microsoft Entra ID app registration with a client secret.

• Select Accounts in this organizational directory only as the account type.

Add an Azure Synapse Analytics integration

1. Click the App Settings icon in the navigation menu.

2. Click the Integrations tab.

3. Click the +Add Integration button and select Azure Synapse Analytics from the dropdown menu.

4. Complete the Host, Port, Immuta Database, and Immuta Schema fields.

5. Opt to check the Enable Impersonation box and customize the Impersonation Role name as needed. This will allow users to natively impersonate another user.

6. Opt to update the User Profile Delimiters. This will be necessary if any of the provided symbols are used in user profile information.

Select your configuration method

You have two options for configuring your Azure Synapse Analytic environment:

• Automatic setup: Grant Immuta one-time use of credentials to automatically configure your environment and the integration.

• Manual setup: Run the Immuta script in your Azure Synapse Analytics environment yourself to configure the integration.

Automatic setup

Enter the username and password in the Privileged User Credentials section.

Manual setup

1. Select Manual.

2. Download, fill out the appropriate fields, and run the bootstrap master script and bootstrap script linked in the Setup section. Note: The master script is not required if you're using the OAuth authentication method.

3. Select the authentication method:

   1. Username and Password: Enter the username and password in the Immuta System Account Credentials section. The username and password provided must be the credentials that were set in the bootstrap master script when you created the user.

   2. Entra ID OAuth Client Secret: The values below can be found on the overview page of the application you created in Microsoft Entra ID. Before you enter this information, ensure you have completed the prerequisites for OAuth authentication listed above.

      1. Display Name: This must match the name of the OAuth application you registered.

      2. Tenant Id

      3. Client Id

      4. Client Secret: Enter the Value of the secret, not the secret ID.

      

Save the configuration

Click Save.

Register data

Register Azure Synapse Analytics data in Immuta.

Edit an Azure Synapse Analytics integration

1. Click the App Settings icon in the navigation menu.

2. Navigate to the Integrations tab and click the down arrow next to the Azure Synapse Analytics Integration.

3. Edit the field you want to change. Note any field shadowed is not editable, and the integration must be disabled and re-installed to change it.

4. Use the authentication method and credentials you provided when initially configuring the integration.

5. Click Save.

Immuta requires temporary, one-time use of credentials with specific permissions

When performing edits to an integration, Immuta requires temporary, one-time use of credentials of a Superuser or a user with the Manage GRANTS permission.

Alternatively, you can download the Edit Script from your Azure Synapse Analytics configuration on the Immuta app settings page and run it in Azure Synapse Analytics.

Remove an Azure Synapse Analytics integration

1. Click the App Settings icon in the navigation menu.

2. Navigate to the Integrations tab and click the down arrow next to the Azure Synapse Analytics Integration.

3. Click the checkbox to disable the integration.

4. Enter the credentials that were used to initially configure the integration.

5. Click Save.