Register and scan Azure Data Explorer

This article outlines how to register an Azure Data Explorer account in Azure Purview and set up a scan.

Supported capabilities

Azure Data Explorer supports full and incremental scans to capture the metadata and schema. Scans also classify the data automatically based on system and custom classification rules.

Prerequisites

  • Before registering data sources, create an Azure Purview account. For more information on creating a Purview account, see Quickstart: Create an Azure Purview account.
  • You need to be an Azure Purview Data Source Admin

Setting up authentication for a scan

There is only one way to set up authentication for Azure data explorer:

  • Service Principal

Service principal

To use service principal authentication for scans, you can use an existing one or create a new one.

Note

If you have to create a new Service Principal, please follow these steps:

  1. Navigate to the Azure portal.
  2. Select Azure Active Directory from the left-hand side menu.
  3. Select App registrations.
  4. Select + New application registration.
  5. Enter a name for the application (the service principal name).
  6. Select Accounts in this organizational directory only.
  7. For Redirect URI select Web and enter any URL you want; it doesn't have to be real or work.
  8. Then select Register.

It is required to get the Service Principal's application ID and secret:

  1. Navigate to your Service Principal in the Azure portal
  2. Copy the values the Application (client) ID from Overview and Client secret from Certificates & secrets.
  3. Navigate to your key vault
  4. Select Settings > Secrets
  5. Select + Generate/Import and enter the Name of your choice and Value as the Client secret from your Service Principal
  6. Select Create to complete
  7. If your key vault is not connected to Purview yet, you will need to create a new key vault connection
  8. Finally, create a new credential using the Service Principal to setup your scan

Granting the Service Principal access to your Azure data explorer instance

  1. Navigate to the Azure portal. Then navigate to your Azure data explorer instance.

  2. Add the service principal to the AllDatabasesViewer role in the Permissions tab, as shown in the following screenshot.

    Screenshot to add service principal in permissions

Register an Azure Data Explorer account

To register a new Azure Data Explorer (Kusto) account in your data catalog, do the following:

  1. Navigate to your Purview account
  2. Select Sources on the left navigation
  3. Select Register
  4. On Register sources, select Azure Data Explorer
  5. Select Continue

register new data source

On the Register sources (Azure Data Explorer (Kusto)) screen, do the following:

  1. Enter a Name that the data source will be listed with in the Catalog.
  2. Choose how you want to point to your desired storage account:
    1. Select From Azure subscription, select the appropriate subscription from the Azure subscription drop down box and the appropriate cluster from the Cluster drop down box.
    2. Or, you can select Enter manually and enter a service endpoint (URL).
  3. Finish to register the data source.

register sources options

Creating and running a scan

Note

The steps and screenshots shown below illustrate the general process for managing scans across different data source types. Your options may differ slightly depending on the types of data sources that you are working with.

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

  1. Navigate to the Sources

  2. Select the data 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 parts of the data source such as folders, collections or schemas by checking the appropriate items in the list.

    Scope your scan

  6. The select a scan rule set for you scan. You can choose between the system default, the existing custom ones or create a new one inline.

    Scan rule set

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

    trigger

  8. Review your scan and select Save and run.

Viewing your scans and scan runs

To view existing scans, do the following:

  1. Navigate to the management center. Select Data sources under the Sources and scanning section.

  2. Select the desired data source. You will see a list of existing scans on that data source.

  3. Select the scan whose results you are interested to view.

  4. This page will show you all of the previous scan runs along with metrics and status for each scan run. It will also display whether your scan was scheduled or manual, how many assets had classifications applied, how many total assets were discovered, the start and end time of the scan, and the total scan duration.

Manage your scans - edit, delete, or cancel

To manage or delete a scan, do the following:

  1. Navigate to the management center. Select Data sources under the Sources and scanning section then select on the desired data source.

  2. Select the scan you would like to manage. You can edit the scan by selecting Edit.

  3. You can delete your scan by selecting Delete.

Next steps