PowerBI

There are 2 sources that provide integration with PowerBI

Source Module Documentation

powerbi

This plugin extracts the following:

Power BI dashboards, tiles and datasets
Names, descriptions and URLs of dashboard and tile
Owners of dashboards Read more...

powerbi-report-server

Use this plugin to connect to PowerBI Report Server. It extracts the following:

Metadata that can be ingested:

report name
report description
ownership(can add existing users in DataHub as owners)
transfer folders structure to DataHub as it is in Report Server
webUrl to report in Report Server

Due to limits of PBIRS REST API, it's impossible to ingest next data for now:

tiles info
datasource of report
dataset of report

Next types of report can be ingested:

PowerBI report(.pbix)
Paginated report(.rdl)
Mobile report
Linked report Read more...

Module `powerbi`

Important Capabilities

Capability	Status	Notes
Descriptions	✅	Enabled by default
Extract Ownership	✅	Disabled by default, configured using `extract_ownership`
Platform Instance	✅	Enabled by default

This plugin extracts the following:

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

Configuration Notes

Refer Microsoft AD App Creation doc to create a Microsoft AD Application. Once Microsoft AD Application is created you can configure client-credential i.e. client_id and client_secret in recipe for ingestion.
Enable admin access only if you want to ingest dataset, lineage and endorsement tags. Refer section Admin Ingestion vs. Basic Ingestion for more detail.
Login to PowerBI as Admin and from Admin API settings allow below permissions
- Allow service principals to use read-only admin APIs
- Enhance admin APIs responses with detailed metadata
- Enhance admin APIs responses with DAX and mashup expressions

Concept mapping

PowerBI	Datahub
`Dashboard`	`Dashboard`
`Dataset's Table`	`Dataset`
`Tile`	`Chart`
`Report.webUrl`	`Chart.externalUrl`
`Workspace`	`N/A`
`Report`	`Dashboard`
`Page`	`Chart`

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

Lineage

This source extract table lineage for tables present in PowerBI Datasets. Lets consider a PowerBI Dataset SALES_REPORT and a PostgreSQL database is configured as data-source in SALES_REPORT dataset.

Consider SALES_REPORT PowerBI Dataset has a table SALES_ANALYSIS which is backed by SALES_ANALYSIS_VIEW of PostgreSQL Database then in this case SALES_ANALYSIS_VIEW will appear as upstream dataset for SALES_ANALYSIS table.

You can control table lineage ingestion using extract_lineage configuration parameter, by default it is set to true.

PowerBI Source extracts the lineage information by parsing PowerBI M-Query expression.

PowerBI Source supports M-Query expression for below listed PowerBI Data Sources

Snowflake
Oracle
PostgreSQL
Microsoft SQL Server
Google BigQuery

Native SQL query parsing is supported for Snowflake and Amazon Redshift data-sources and only first table from FROM clause will be ingested as upstream table. Advance SQL construct like JOIN and SUB-QUERIES in FROM clause are not supported.

For example refer below native SQL query. The table OPERATIONS_ANALYTICS.TRANSFORMED_PROD.V_UNIT_TARGET will be ingested as upstream table.

let
  Source = Value.NativeQuery(
    Snowflake.Databases(
      "sdfsd788.ws-east-2.fakecomputing.com", 
      "operations_analytics_prod", 
      [Role = "OPERATIONS_ANALYTICS_MEMBER"]
    ){[Name = "OPERATIONS_ANALYTICS"]}[Data], 
    "select #(lf)UPPER(REPLACE(AGENT_NAME,\'-\',\'\')) AS Agent,#(lf)TIER,#(lf)UPPER(MANAGER),#(lf)TEAM_TYPE,#(lf)DATE_TARGET,#(lf)MONTHID,#(lf)TARGET_TEAM,#(lf)SELLER_EMAIL,#(lf)concat((UPPER(REPLACE(AGENT_NAME,\'-\',\'\'))), MONTHID) as AGENT_KEY,#(lf)UNIT_TARGET AS SME_Quota,#(lf)AMV_TARGET AS Revenue_Quota,#(lf)SERVICE_QUOTA,#(lf)BL_TARGET,#(lf)SOFTWARE_QUOTA as Software_Quota#(lf)#(lf)from OPERATIONS_ANALYTICS.TRANSFORMED_PROD.V_UNIT_TARGETS#(lf)#(lf)where YEAR_TARGET >= 2020#(lf)and TEAM_TYPE = \'foo\'#(lf)and TARGET_TEAM = \'bar\'", 
    null, 
    [EnableFolding = true]
  ), 
  #"Added Conditional Column" = Table.AddColumn(
    Source, 
    "Has PS Software Quota?", 
    each 
      if [TIER] = "Expansion (Medium)" then
        "Yes"
      else if [TIER] = "Acquisition" then
        "Yes"
      else
        "No"
  )
in
  #"Added Conditional Column"

Use full-table-name in from clause. For example dev.public.category

M-Query Pattern Supported For Lineage Extraction

Lets consider a M-Query which combine two PostgreSQL tables. Such M-Query can be written as per below patterns.

Pattern-1

let
Source = PostgreSQL.Database("localhost", "book_store"),
book_date = Source{[Schema="public",Item="book"]}[Data],
issue_history = Source{[Schema="public",Item="issue_history"]}[Data],
combine_result  = Table.Combine({book_date, issue_history})
in
combine_result

Pattern-2

let
Source = PostgreSQL.Database("localhost", "book_store"),
combine_result  = Table.Combine({Source{[Schema="public",Item="book"]}[Data], Source{[Schema="public",Item="issue_history"]}[Data]})
in
combine_result

Pattern-2 is not supported for upstream table lineage extraction as it uses nested item-selector i.e. {Source{[Schema="public",Item="book"]}[Data], Source{[Schema="public",Item="issue_history"]}[Data]} as argument to M-QUery table function i.e. Table.Combine

Pattern-1 is supported as it first assign the table from schema to variable and then variable is used in M-Query Table function i.e. Table.Combine

Extract endorsements to tags

By default, extracting endorsement information to tags is disabled. The feature may be useful if organization uses endorsements to identify content quality.

Please note that the default implementation overwrites tags for the ingested entities, if you need to preserve existing tags, consider using a transformer with semantics: PATCH tags instead of OVERWRITE.

Admin Ingestion vs. Basic Ingestion

PowerBI provides two sets of API i.e. Basic API and Admin API.

The Basic API returns metadata of PowerBI resources where service principal has granted access explicitly on resources whereas Admin API returns metadata of all PowerBI resources irrespective of whether service principal has granted or doesn't granted access explicitly on resources.

The Admin Ingestion (explain below) is the recommended way to execute PowerBI ingestion as this ingestion can extract most of the metadata.

Admin Ingestion: Service Principal As Admin in Tenant Setting and Added as Member In Workspace

To grant admin access to the service principal, visit your PowerBI tenant Settings.

If you have added service principal as member in workspace and also allowed below permissions from PowerBI tenant Settings

Allow service principal to use read-only PowerBI Admin APIs
Enhance admin APIs responses with detailed metadata
Enhance admin APIs responses with DAX and mashup expressions

PowerBI Source would be able to ingest below listed metadata of that particular workspace

Lineage
PowerBI Dataset
Endorsement as tag
Dashboards
Reports
Dashboard's Tiles
Report's Pages

If you don't want to add a service principal as a member in your workspace, then you can enable the admin_apis_only: true in recipe to use PowerBI Admin API only.

Caveats of setting admin_apis_only to true:

Report's pages would not get ingested as page API is not available in PowerBI Admin API
PowerBI Parameters would not get resolved to actual values while processing M-Query for table lineage

Basic Ingestion: Service Principal As Member In Workspace

If you have added service principal as member in workspace then PowerBI Source would be able ingest below metadata of that particular workspace

Dashboards
Reports
Dashboard's Tiles
Report's Pages

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

    # Azure AD Application identifier
    client_id: foo
    # Azure AD App client secret
    client_secret: bar
    
    # Ingest elements of below PowerBi Workspace into Datahub
    workspace_id_pattern:
      allow:
        - 4bd10256-e999-45dd-8e56-571c77153a5f
      deny:

    # Enable / Disable ingestion of ownership information for dashboards
    extract_ownership: true
    
    # Enable/Disable extracting workspace information to DataHub containers
    extract_workspaces_to_containers: true
    
    # Enable / Disable ingestion of endorsements.
    # Please notice that this may overwrite any existing tags defined to ingested entities!
    extract_endorsements_to_tags: false
    
    # Optional -- This mapping is optional and only required to configure platform-instance for upstream tables
    # A mapping of PowerBI datasource's server i.e host[:port] to data platform instance.
    # :port is optional and only needed if your datasource server is running on non-standard port.
    # For Google BigQuery the datasource's server is google bigquery project name
    server_to_platform_instance:
        ap-south-1.snowflakecomputing.com:
          platform_instance: operational_instance
          env: DEV
        oracle-server:1920:
          platform_instance: high_performance_production_unit
          env: PROD
        big-query-sales-project:
          platform_instance: sn-2
          env: QA

sink:
  # sink configs

Config Details

Options
Schema

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

View All Configuration Options

Field [Required]	Type	Description	Default
admin_apis_only [✅]	boolean	Retrieve metadata using PowerBI Admin API only. If this is enabled, then Report Pages will not be extracted. Admin API access is required if this setting is enabled	None
client_id [✅]	string	Azure app client identifier	None
client_secret [✅]	string	Azure app client secret	None
convert_lineage_urns_to_lowercase [✅]	boolean	Whether to convert the urns of ingested lineage dataset to lowercase	True
convert_urns_to_lowercase [✅]	boolean	Whether to convert the PowerBI assets urns to lowercase	None
extract_endorsements_to_tags [✅]	boolean	Whether to extract endorsements to tags, note that this may overwrite existing tags. Admin API access is required is this setting is enabled	None
extract_lineage [✅]	boolean	Whether lineage should be ingested between X and Y. Admin API access is required if this setting is enabled	True
extract_ownership [✅]	boolean	Whether ownership should be ingested. Admin API access is required if this setting is enabled. Note that enabling this may overwrite owners that you've added inside DataHub's web application.	None
extract_reports [✅]	boolean	Whether reports should be ingested	True
extract_workspaces_to_containers [✅]	boolean	Extract workspaces to DataHub containers	True
native_query_parsing [✅]	boolean	Whether PowerBI native query should be parsed to extract lineage	True
platform_instance [✅]	string	The instance of the platform that all assets produced by this recipe belong to	None
scan_timeout [✅]	integer	timeout for PowerBI metadata scanning	60
tenant_id [✅]	string	PowerBI tenant identifier	None
env [✅]	string	The environment that all assets produced by this connector belong to	PROD
server_to_platform_instance [✅]	map(str,PlatformDetail)		None
server_to_platform_instance.`key`.platform_instance [❓ (required if server_to_platform_instance is set)]	string	DataHub platform instance name. To generate correct urn for upstream dataset, this should match with platform instance name used in ingestionrecipe of other datahub sources.	None
server_to_platform_instance.`key`.env [❓ (required if server_to_platform_instance is set)]	string	The environment that the platform is located in. It is default to PROD	PROD
workspace_id_pattern [✅]	AllowDenyPattern	Regex patterns to filter PowerBI workspaces in ingestion	{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
workspace_id_pattern.allow [❓ (required if workspace_id_pattern is set)]	array(string)		None
workspace_id_pattern.deny [❓ (required if workspace_id_pattern is set)]	array(string)		None
workspace_id_pattern.ignoreCase [❓ (required if workspace_id_pattern is set)]	boolean	Whether to ignore case sensitivity during pattern matching.	True
stateful_ingestion [✅]	StatefulStaleMetadataRemovalConfig	PowerBI Stateful Ingestion Config.	None
stateful_ingestion.enabled [❓ (required if stateful_ingestion is set)]	boolean	The type of the ingestion state provider registered with datahub.	None
stateful_ingestion.ignore_new_state [❓ (required if stateful_ingestion is set)]	boolean	If set to True, ignores the current checkpoint state.	None
stateful_ingestion.ignore_old_state [❓ (required if stateful_ingestion is set)]	boolean	If set to True, ignores the previous checkpoint state.	None
stateful_ingestion.remove_stale_metadata [❓ (required if stateful_ingestion is set)]	boolean	Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.	True

The JSONSchema for this configuration is inlined below.

{
  "title": "PowerBiDashboardSourceConfig",
  "description": "Base configuration class for stateful ingestion for source configs to inherit from.",
  "type": "object",
  "properties": {
    "env": {
      "title": "Env",
      "description": "The environment that all assets produced by this connector belong to",
      "default": "PROD",
      "type": "string"
    },
    "platform_instance": {
      "title": "Platform Instance",
      "description": "The instance of the platform that all assets produced by this recipe belong to",
      "type": "string"
    },
    "stateful_ingestion": {
      "title": "Stateful Ingestion",
      "description": "PowerBI Stateful Ingestion Config.",
      "allOf": [
        {
          "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
        }
      ]
    },
    "tenant_id": {
      "title": "Tenant Id",
      "description": "PowerBI tenant identifier",
      "type": "string"
    },
    "workspace_id_pattern": {
      "title": "Workspace Id Pattern",
      "description": "Regex patterns to filter PowerBI workspaces in ingestion",
      "default": {
        "allow": [
          ".*"
        ],
        "deny": [],
        "ignoreCase": true
      },
      "allOf": [
        {
          "$ref": "#/definitions/AllowDenyPattern"
        }
      ]
    },
    "server_to_platform_instance": {
      "title": "Server To Platform Instance",
      "description": "A mapping of PowerBI datasource's server i.e host[:port] to Data platform instance. :port is optional and only needed if your datasource server is running on non-standard port.For Google BigQuery the datasource's server is google bigquery project name",
      "default": {},
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/PlatformDetail"
      }
    },
    "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. Admin API access is required if this setting is enabled. Note that enabling this may overwrite owners that you've added inside DataHub's web application.",
      "default": false,
      "type": "boolean"
    },
    "extract_reports": {
      "title": "Extract Reports",
      "description": "Whether reports should be ingested",
      "default": true,
      "type": "boolean"
    },
    "extract_lineage": {
      "title": "Extract Lineage",
      "description": "Whether lineage should be ingested between X and Y. Admin API access is required if this setting is enabled",
      "default": true,
      "type": "boolean"
    },
    "extract_endorsements_to_tags": {
      "title": "Extract Endorsements To Tags",
      "description": "Whether to extract endorsements to tags, note that this may overwrite existing tags. Admin API access is required is this setting is enabled",
      "default": false,
      "type": "boolean"
    },
    "extract_workspaces_to_containers": {
      "title": "Extract Workspaces To Containers",
      "description": "Extract workspaces to DataHub containers",
      "default": true,
      "type": "boolean"
    },
    "native_query_parsing": {
      "title": "Native Query Parsing",
      "description": "Whether PowerBI native query should be parsed to extract lineage",
      "default": true,
      "type": "boolean"
    },
    "convert_urns_to_lowercase": {
      "title": "Convert Urns To Lowercase",
      "description": "Whether to convert the PowerBI assets urns to lowercase",
      "default": false,
      "type": "boolean"
    },
    "convert_lineage_urns_to_lowercase": {
      "title": "Convert Lineage Urns To Lowercase",
      "description": "Whether to convert the urns of ingested lineage dataset to lowercase",
      "default": true,
      "type": "boolean"
    },
    "admin_apis_only": {
      "title": "Admin Apis Only",
      "description": "Retrieve metadata using PowerBI Admin API only. If this is enabled, then Report Pages will not be extracted. Admin API access is required if this setting is enabled",
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "tenant_id",
    "client_id",
    "client_secret"
  ],
  "additionalProperties": false,
  "definitions": {
    "DynamicTypedStateProviderConfig": {
      "title": "DynamicTypedStateProviderConfig",
      "type": "object",
      "properties": {
        "type": {
          "title": "Type",
          "description": "The type of the state provider to use. For DataHub use `datahub`",
          "type": "string"
        },
        "config": {
          "title": "Config",
          "description": "The configuration required for initializing the state provider. Default: The datahub_api config if set at pipeline level. Otherwise, the default DatahubClientConfig. See the defaults (https://github.com/datahub-project/datahub/blob/master/metadata-ingestion/src/datahub/ingestion/graph/client.py#L19)."
        }
      },
      "required": [
        "type"
      ],
      "additionalProperties": false
    },
    "StatefulStaleMetadataRemovalConfig": {
      "title": "StatefulStaleMetadataRemovalConfig",
      "description": "Base specialized config for Stateful Ingestion with stale metadata removal capability.",
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enabled",
          "description": "The type of the ingestion state provider registered with datahub.",
          "default": false,
          "type": "boolean"
        },
        "ignore_old_state": {
          "title": "Ignore Old State",
          "description": "If set to True, ignores the previous checkpoint state.",
          "default": false,
          "type": "boolean"
        },
        "ignore_new_state": {
          "title": "Ignore New State",
          "description": "If set to True, ignores the current checkpoint state.",
          "default": false,
          "type": "boolean"
        },
        "remove_stale_metadata": {
          "title": "Remove Stale Metadata",
          "description": "Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.",
          "default": true,
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "AllowDenyPattern": {
      "title": "AllowDenyPattern",
      "description": "A class to store allow deny regexes",
      "type": "object",
      "properties": {
        "allow": {
          "title": "Allow",
          "description": "List of regex patterns to include in ingestion",
          "default": [
            ".*"
          ],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "deny": {
          "title": "Deny",
          "description": "List of regex patterns to exclude from ingestion.",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ignoreCase": {
          "title": "Ignorecase",
          "description": "Whether to ignore case sensitivity during pattern matching.",
          "default": true,
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "PlatformDetail": {
      "title": "PlatformDetail",
      "type": "object",
      "properties": {
        "platform_instance": {
          "title": "Platform Instance",
          "description": "DataHub platform instance name. To generate correct urn for upstream dataset, this should match with platform instance name used in ingestionrecipe of other datahub sources.",
          "type": "string"
        },
        "env": {
          "title": "Env",
          "description": "The environment that the platform is located in. It is default to PROD",
          "default": "PROD",
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  }
}

Code Coordinates

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

Module `powerbi-report-server`

Important Capabilities

Capability	Status	Notes
Extract Ownership	✅	Enabled by default

Use this plugin to connect to PowerBI Report Server. It extracts the following:

Metadata that can be ingested:

report name
report description
ownership(can add existing users in DataHub as owners)
transfer folders structure to DataHub as it is in Report Server
webUrl to report in Report Server

Due to limits of PBIRS REST API, it's impossible to ingest next data for now:

tiles info
datasource of report
dataset of report

Next types of report can be ingested:

PowerBI report(.pbix)
Paginated report(.rdl)
Mobile report
Linked report

Configuration Notes

See the

Microsoft Grant user access to a Report Server doc
Use your user credentials from previous step in yaml file

Concept mapping

Power BI Report Server	Datahub
`Paginated Report`	`Dashboard`
`Power BI Report`	`Dashboard`
`Mobile Report`	`Dashboard`
`Linked Report`	`Dashboard`
`Dataset, Datasource`	`N/A`

CLI based Ingestion

Install the Plugin

pip install 'acryl-datahub[powerbi-report-server]'

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-report-server
  config:
    # Your Power BI Report Server Windows username
    username: username
    # Your Power BI Report Server Windows password
    password: password
    # Your Workstation name
    workstation_name: workstation_name
    # Your Power BI Report Server host URL, example: localhost:80
    host_port: host_port
    # Your alias for Power BI Report Server host URL, example: local_powerbi_report_server
    server_alias: server_alias
    # Workspace's dataset environments, example: (PROD, DEV, QA, STAGE)
    env: DEV
    # Your Power BI Report Server base virtual directory name for reports
    report_virtual_directory_name: Reports
    #  Your Power BI Report Server base virtual directory name for report server
    report_server_virtual_directory_name: ReportServer
    # Enable/Disable extracting ownership information of Dashboard
    extract_ownership: True
    # Set ownership type
    ownership_type: TECHNICAL_OWNER


sink:
  # sink configs

Config Details

Options
Schema

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

View All Configuration Options

Field [Required]	Type	Description	Default
extract_ownership [✅]	boolean	Whether ownership should be ingested	True
graphql_url [✅]	string	[deprecated] Not used	None
host_port [✅]	string	Power BI Report Server host URL	None
ownership_type [✅]	string	Ownership type of owner	NONE
password [✅]	string	Windows account password	None
platform_name [✅]	string		powerbi
platform_urn [✅]	string		urn:li:dataPlatform:powerbi
report_server_virtual_directory_name [✅]	string	Report Server Virtual Directory URL name	None
report_virtual_directory_name [✅]	string	Report Virtual Directory URL name	None
server_alias [✅]	string	Alias for Power BI Report Server host URL	None
username [✅]	string	Windows account username	None
workstation_name [✅]	string	Workstation name	localhost
env [✅]	string	The environment that all assets produced by this connector belong to	PROD
chart_pattern [✅]	AllowDenyPattern		{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
chart_pattern.allow [❓ (required if chart_pattern is set)]	array(string)		None
chart_pattern.deny [❓ (required if chart_pattern is set)]	array(string)		None
chart_pattern.ignoreCase [❓ (required if chart_pattern is set)]	boolean	Whether to ignore case sensitivity during pattern matching.	True
report_pattern [✅]	AllowDenyPattern		{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
report_pattern.allow [❓ (required if report_pattern is set)]	array(string)		None
report_pattern.deny [❓ (required if report_pattern is set)]	array(string)		None
report_pattern.ignoreCase [❓ (required if report_pattern is set)]	boolean	Whether to ignore case sensitivity during pattern matching.	True

The JSONSchema for this configuration is inlined below.

{
  "title": "PowerBiReportServerDashboardSourceConfig",
  "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"
    },
    "username": {
      "title": "Username",
      "description": "Windows account username",
      "type": "string"
    },
    "password": {
      "title": "Password",
      "description": "Windows account password",
      "type": "string"
    },
    "workstation_name": {
      "title": "Workstation Name",
      "description": "Workstation name",
      "default": "localhost",
      "type": "string"
    },
    "host_port": {
      "title": "Host Port",
      "description": "Power BI Report Server host URL",
      "type": "string"
    },
    "server_alias": {
      "title": "Server Alias",
      "description": "Alias for Power BI Report Server host URL",
      "default": "",
      "type": "string"
    },
    "graphql_url": {
      "title": "Graphql Url",
      "description": "[deprecated] Not used",
      "type": "string"
    },
    "report_virtual_directory_name": {
      "title": "Report Virtual Directory Name",
      "description": "Report Virtual Directory URL name",
      "type": "string"
    },
    "report_server_virtual_directory_name": {
      "title": "Report Server Virtual Directory Name",
      "description": "Report Server Virtual Directory URL name",
      "type": "string"
    },
    "extract_ownership": {
      "title": "Extract Ownership",
      "description": "Whether ownership should be ingested",
      "default": true,
      "type": "boolean"
    },
    "ownership_type": {
      "title": "Ownership Type",
      "description": "Ownership type of owner",
      "default": "NONE",
      "type": "string"
    },
    "platform_name": {
      "title": "Platform Name",
      "default": "powerbi",
      "type": "string"
    },
    "platform_urn": {
      "title": "Platform Urn",
      "default": "urn:li:dataPlatform:powerbi",
      "type": "string"
    },
    "report_pattern": {
      "title": "Report Pattern",
      "default": {
        "allow": [
          ".*"
        ],
        "deny": [],
        "ignoreCase": true
      },
      "allOf": [
        {
          "$ref": "#/definitions/AllowDenyPattern"
        }
      ]
    },
    "chart_pattern": {
      "title": "Chart Pattern",
      "default": {
        "allow": [
          ".*"
        ],
        "deny": [],
        "ignoreCase": true
      },
      "allOf": [
        {
          "$ref": "#/definitions/AllowDenyPattern"
        }
      ]
    }
  },
  "required": [
    "username",
    "password",
    "host_port",
    "report_virtual_directory_name",
    "report_server_virtual_directory_name"
  ],
  "additionalProperties": false,
  "definitions": {
    "AllowDenyPattern": {
      "title": "AllowDenyPattern",
      "description": "A class to store allow deny regexes",
      "type": "object",
      "properties": {
        "allow": {
          "title": "Allow",
          "description": "List of regex patterns to include in ingestion",
          "default": [
            ".*"
          ],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "deny": {
          "title": "Deny",
          "description": "List of regex patterns to exclude from ingestion.",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ignoreCase": {
          "title": "Ignorecase",
          "description": "Whether to ignore case sensitivity during pattern matching.",
          "default": true,
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  }
}

Code Coordinates

Class Name: datahub.ingestion.source.powerbi_report_server.report_server.PowerBiReportServerDashboardSource
Browse on GitHub

Questions

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

PowerBI

Module powerbi​

Important Capabilities​

Configuration Notes​

Concept mapping​

Lineage​

M-Query Pattern Supported For Lineage Extraction​

Extract endorsements to tags​

Admin Ingestion vs. Basic Ingestion​

Admin Ingestion: Service Principal As Admin in Tenant Setting and Added as Member In Workspace​

Basic Ingestion: Service Principal As Member In Workspace​

CLI based Ingestion​

Install the Plugin​

Starter Recipe​

Config Details​

Code Coordinates​

Module powerbi-report-server​

Important Capabilities​

Configuration Notes​

Concept mapping​

CLI based Ingestion​

Install the Plugin​

Starter Recipe​

Config Details​

Code Coordinates​

Questions​

Module `powerbi`

Important Capabilities

Configuration Notes

Concept mapping

Lineage

M-Query Pattern Supported For Lineage Extraction

Extract endorsements to tags

Admin Ingestion vs. Basic Ingestion

Admin Ingestion: Service Principal As Admin in Tenant Setting and Added as Member In Workspace

Basic Ingestion: Service Principal As Member In Workspace

CLI based Ingestion

Install the Plugin

Starter Recipe

Config Details

Code Coordinates

Module `powerbi-report-server`

Important Capabilities

Configuration Notes

Concept mapping

CLI based Ingestion

Install the Plugin

Starter Recipe

Config Details

Code Coordinates

Questions