PowerBI

Module powerbi

Important Capabilities

Capability	Status	Notes
Extract Ownership	✅	On by default but can disabled by configuration

This plugin extracts the following:

• Power BI dashboards, tiles and datasets
• Names, descriptions and URLs of dashboard and tile
• Owners of dashboards

CLI based Ingestion

Install the Plugin

pip install 'acryl-datahub[powerbi]'

Starter Recipe

Check out the following recipe to get started with ingestion! See below for full configuration options.

For general pointers on writing and running a recipe, see our main recipe guide.

source:
  type: "powerbi"
  config:
    # Your Power BI tenant identifier
    tenant_id: a949d688-67c0-4bf1-a344-e939411c6c0a
    # Ingest elements of below PowerBi Workspace into Datahub
    workspace_id: 4bd10256-e999-45dd-8e56-571c77153a5f
    # Workspaces dataset environments (PROD, DEV, QA, STAGE)
    env: DEV
    # Azure AD Application identifier
    client_id: foo
    # Azure AD App client secret
    client_secret: bar
    # Enable / Disable ingestion of user information for dashboards
    extract_ownership: true
    # dataset_type_mapping is fixed mapping of Power BI datasources type to equivalent Datahub "data platform" dataset
    dataset_type_mapping:
        PostgreSql: postgres
        Oracle: oracle

sink:
  # sink configs

Config Details

Options

Note that a . is used to denote nested fields in the YAML recipe.

View All Configuration Options

Field	Required	Type	Description	Default
env		string	The environment that all assets produced by this connector belong to	PROD
tenant_id	✅	string	PowerBI tenant identifier	None
workspace_id	✅	string	PowerBI workspace identifier	None
dataset_type_mapping	✅	Dict[str,string]	Mapping of PowerBI datasource type to DataHub supported data-sources. See Quickstart Recipe for mapping
client_id	✅	string	Azure app client identifier	None
client_secret	✅	string	Azure app client secret	None
scan_timeout		integer	timeout for PowerBI metadata scanning	60
extract_ownership		boolean	Whether ownership should be ingested	True
platform_name		string		powerbi
platform_urn		string		urn:li:dataPlatform:powerbi

Schema

The JSONSchema for this configuration is inlined below.

{
  "title": "PowerBiDashboardSourceConfig",
  "description": "Any source that produces dataset urns in a single environment should inherit this class",
  "type": "object",
  "properties": {
    "env": {
      "title": "Env",
      "description": "The environment that all assets produced by this connector belong to",
      "default": "PROD",
      "type": "string"
    },
    "tenant_id": {
      "title": "Tenant Id",
      "description": "PowerBI tenant identifier",
      "type": "string"
    },
    "workspace_id": {
      "title": "Workspace Id",
      "description": "PowerBI workspace identifier",
      "type": "string"
    },
    "dataset_type_mapping": {
      "title": "Dataset Type Mapping",
      "description": "Mapping of PowerBI datasource type to DataHub supported data-sources. See Quickstart Recipe for mapping",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "client_id": {
      "title": "Client Id",
      "description": "Azure app client identifier",
      "type": "string"
    },
    "client_secret": {
      "title": "Client Secret",
      "description": "Azure app client secret",
      "type": "string"
    },
    "scan_timeout": {
      "title": "Scan Timeout",
      "description": "timeout for PowerBI metadata scanning",
      "default": 60,
      "type": "integer"
    },
    "extract_ownership": {
      "title": "Extract Ownership",
      "description": "Whether ownership should be ingested",
      "default": true,
      "type": "boolean"
    },
    "platform_name": {
      "title": "Platform Name",
      "default": "powerbi",
      "type": "string"
    },
    "platform_urn": {
      "title": "Platform Urn",
      "default": "urn:li:dataPlatform:powerbi",
      "type": "string"
    }
  },
  "required": [
    "tenant_id",
    "workspace_id",
    "dataset_type_mapping",
    "client_id",
    "client_secret"
  ],
  "additionalProperties": false
}

Configuration Notes

See the

1. Microsoft AD App Creation doc for the steps to create an app client ID and secret
2. Login to Power BI as Admin and from Tenant settings allow below permissions

• Allow service principles to use Power BI APIs
• Allow service principals to use read-only Power BI admin APIs
• Enhance admin APIs responses with detailed metadata

Concept mapping

Power BI	Datahub
Dashboard	Dashboard
Dataset, Datasource	Dataset
Tile	Chart
Report.webUrl	Chart.externalUrl
Workspace	N/A
Report	N/A

If Tile is created from report then Chart.externalUrl is set to Report.webUrl.

Code Coordinates

• Class Name: datahub.ingestion.source.powerbi.PowerBiDashboardSource
• Browse on GitHub

Questions

If you've got any questions on configuring ingestion for PowerBI, feel free to ping us on our Slack