QuickStart: Connect a Synapse workspace to an Azure Purview account

In this quickstart, you will register an Azure Purview Account to a Synapse workspace. That connection allows you to discover Azure Purview assets, interact with them through Synapse capabilities, and push lineage information to Purview.

You can perform the following tasks in Synapse:

  • Use the search box at the top to find Purview assets based on keywords
  • Understand the data based on metadata, lineage, annotations
  • Connect those data to your workspace with linked services or integration datasets
  • Analyze those datasets with Synapse Apache Spark, Synapse SQL, and Data Flow
  • Execute pipelines and push lineage information to Purview

Prerequisites

Permissions for connecting an Azure Purview account

To connect an Azure Purview Account to a Synapse workspace, you need a Contributor role in Synapse workspace from Azure portal IAM and you need access to that Azure Purview Account. For more information, see Azure Purview permissions.

Connect an Azure Purview account

Follow the steps to connect an Azure Purview account:

  1. Go to https://web.azuresynapse.net and sign in to your Synapse workspace.
  2. Go to Manage -> Azure Purview, select Connect to a Purview account.
  3. You can choose From Azure subscription or Enter manually. From Azure subscription, you can select the account that you have access to.
  4. Once connected, you can see the name of the Purview account in the tab Azure Purview account.

If your Purview account is protected by firewall, create the managed private endpoints for Purview. Learn more about how to let Azure Synapse access a secured Purview account. You can either do it during the initial connection or edit an existing connection later.

The Purview connection information is stored in the Synapse workspace resource like the following. To establish the connection programmatically, you can update the Synapse workspace and add the purviewConfiguration settings.

{
    "name": "ContosoSynapseWorkspace",
    "type": "Microsoft.Synapse/workspaces",
    "location": "<region>",
    "properties": {
        ...
        "purviewConfiguration": {
            "purviewResourceId": "/subscriptions/<subscriptionId>/resourceGroups/<resourceGroupname>/providers/Microsoft.Purview/accounts/<PurviewAccountName>"
        }
    },
    "identity": {...},
    ...
}

Set up authentication

Synapse workspace's managed identity is used to authenticate lineage push operations from Synapse workspace to Purview.

  • For Purview account created on or after August 18, 2021, grant the Synapse workspace's managed identity Data Curator role on your Purview root collection. Learn more about Access control in Azure Purview and Add roles and restrict access through collections.

    When connecting Synapse workspace to Purview in Synapse Studio, Synapse tries to add such role assignment automatically. If you have Collection admins role on the Purview root collection and have access to Purview account from your network, this operation is done successfully.

  • For Purview account created before August 18, 2021, grant the Synapse workspace's managed identity Azure built-in Purview Data Curator role on your Purview account. Learn more about Access control in Azure Purview - legacy permissions.

    When connecting Synapse workspace to Purview in Synapse Studio, Synapse tries to add such role assignment automatically. If you have Azure built-in Owner or User Access Administrator role on the Purview account, this operation is done successfully.

You may see below warning if you have the privilege to read Purview role assignment information and the needed role is not granted. To make sure the connection is properly set for the pipeline lineage push, go to your Purview account and check if Purview Data Curator role is granted to the Synapse workspace's managed identity. If not, manually add the role assignment.

Screenshot for warning of registering a Purview account.

Report lineage to Azure Purview

Once you connect the Synapse workspace to a Purview account, when you execute pipelines, Synapse reports lineage information to the Purview account. For detailed supported capabilities and an end to end walkthrough, see Metadata and lineage from Azure Synapse Analytics.

Discover and explore data using Purview

Once you connect the Synapse workspace to a Purview account, you can use the search bar at the top center of Synapse workspace to search for data and perform actions. Learn more from Discover, connect and explore data in Synapse using Azure Purview.

Next steps

Discover, connect and explore data in Synapse using Azure Purview

Metadata and lineage from Azure Synapse Analytics

Access a secured Purview account

Register and scan Azure Synapse assets in Azure Purview

Get lineage from Power BI into Azure Purview

Connect Azure Data Share and Azure Purview