Prepare to run the PowerBI collector

Set up Azure application registration, authentication, and permissions before running the collector.

Before you begin

Role required: admin

Important: A Power BI Administrator is needed to enable settings in the Power BI Admin Portal.

About this task

The collector uses Azure application registration and supports two authentication methods: service principal or username and password. You must register an application, configure authentication, enable metadata scanning, and retrieve the tenant ID. Optionally, configure report image harvesting and lineage mapping.

Procedure

1. Register an application in Azure and create client credentials.

   See Register Power BI application.

2. Configure authentication based on your preferred method.

   • For service principal authentication, see Configure Power BI service principal authentication.

   • For username and password authentication, see Configure Power BI username and password authentication.

3. Enable metadata scanning to access detailed data source information.

   See Configure Power BI metadata scanning.

4. Get the Power BI tenant ID.

   See Get Power BI tenant ID.

5. Configure report image harvesting to collect preview images from Power BI reports.

   See Configure Power BI report image harvesting.

6. Configure lineage mapping for ODBC connections, server aliases, or custom SQL statements.

   See Configure Power BI lineage mapping .

7. Register Power BI application
   Register an application in Azure and create client credentials for Power BI collector authentication.

8. Configure Power BI service principal authentication
   Set up service principal authentication to enable Power BI metadata collection.
9. Configure Power BI username and password authentication
   Set up API permissions for username and password authentication to enable Power BI metadata collection.
10. Configure Power BI metadata scanning
    Enable metadata scanning to access detailed data source information including tables and columns.
11. Get Power BI tenant ID
    Retrieve the tenant ID from the Power BI application.
12. Configure Power BI report image harvesting
    Enable report image harvesting to collect preview images from Power BI reports.
13. Configure Power BI lineage mapping
    Create a YAML file to map data sources for lineage harvesting.

Parent Topic:PowerBI metadata collector