Connect to and manages an Azure Database for PostgreSQL in Microsoft Purview

This article outlines how to register an Azure Database for PostgreSQL deployed with single server deployment option, as well as how to authenticate and interact with an Azure Database for PostgreSQL in Microsoft Purview. For more information about Microsoft Purview, read the introductory article.

Supported capabilities

Metadata Extraction Full Scan Incremental Scan Scoped Scan Classification Access Policy Lineage Data Sharing
Yes Yes Yes Yes Yes No Limited** No

** Lineage is supported if dataset is used as a source/sink in Data Factory Copy activity

Important

Microsoft Purview only supports single server deployment option for Azure Database for PostgreSQL. Versions 8.x to 12.x

Prerequisites

Register

This section describes how to register an Azure Database for PostgreSQL in Microsoft Purview using the Microsoft Purview governance portal.

Authentication for registration

Currently, to be able to manage and interact with an Azure Database for PostgreSQL single server, only SQL Authentication is supported.

SQL Authentication

Connecting to an Azure Database for PostgreSQL database requires the fully qualified server name and login credentials. You can follow the instructions in CONNECT AND QUERY to create a login for your Azure Database for PostgreSQL if you don't have this available. You will need username and password for the next steps.

  1. If you do not have an Azure Key vault already, follow this guide to create an Azure Key Vault.
  2. Navigate to your key vault in the Azure portal
  3. Select Settings > Secrets
  4. Select + Generate/Import and enter the Name and Value as the password from your Azure PostgreSQL Database
  5. Select Create to complete
  6. If your key vault is not connected to Microsoft Purview yet, you will need to create a new key vault connection
  7. Finally, create a new credential of type SQL authentication using the username and password to set up your scan

Steps to register

To register a new Azure Database for PostgreSQL in your data catalog, do the following:

  1. Navigate to your Microsoft Purview account.

  2. Select Data Map on the left navigation.

  3. Select Register

  4. On Register sources, select Azure Database for PostgreSQL. Select Continue.

register new data source

On the Register sources Azure Database for PostgreSQL screen, do the following:

  1. Enter a Name for your data source. This will be the display name for this data source in your Catalog.
  2. Select From Azure subscription, select the appropriate subscription from the Azure subscription drop-down box and the appropriate server from the Server name drop-down box.
  3. Select Register to register the data source.

register sources options

Scan

Follow the steps below to scan an Azure Database for PostgreSQL database to automatically identify assets and classify your data. For more information about scanning in general, see our introduction to scans and ingestion

Create and run scan

To create and run a new scan, do the following:

  1. Select the Data Map tab on the left pane in the Microsoft Purview governance portal.

  2. Select the Azure Database for PostgreSQL source that you registered.

  3. Select New scan

  4. Select the credential to connect to your data source.

    Set up scan

  5. You can scope your scan to specific folders or subfolders by choosing the appropriate items in the list.

    Scope your scan

  6. Then select a scan rule set. You can choose between the system default, existing custom rule sets, or create a new rule set inline.

    Scan rule set

  7. Choose your scan trigger. You can set up a schedule or run the scan once.

    trigger scan

  8. Review your scan and select Save and run.

View your scans and scan runs

To view existing scans:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab on the left pane.

  2. Select the desired data source. You can view a list of existing scans on that data source under Recent scans, or you can view all scans on the Scans tab.

  3. Select the scan that has results you want to view.

    The page that appears shows you all of the previous scan runs, along with the status and metrics for each scan run. It also displays:

    • Whether your scan was scheduled or manual.
    • How many assets had classifications applied.
    • How many total assets were discovered.
    • The start and end times of the scan, and the total scan duration.

Manage your scans - edit, delete, or cancel

To manage or delete a scan:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab on the left pane.

  2. Select the desired data source. You can view a list of existing scans on that data source under Recent scans, or you can view all scans on the Scans tab.

  3. Select the scan that you want to manage. You can then:

    • Edit the scan by selecting Edit scan.
    • Cancel an in-progress scan by selecting Cancel scan run.
    • Delete your scan by selecting Delete scan.

Note

  • Deleting your scan does not delete catalog assets created from previous scans.
  • The asset will no longer be updated with schema changes if your source table has changed and you re-scan the source table after editing the description on the Schema tab of Microsoft Purview.

Next steps

Now that you have registered your source, follow the below guides to learn more about Microsoft Purview and your data.