Microsoft Power BI

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: OAuth 2.0.
  • Connection: A user authorizes the connection in the provider's consent screen.
  • Scopes: https://analysis.windows.net/powerbi/api/Workspace.Read.All, https://analysis.windows.net/powerbi/api/Dataset.Read.All, https://analysis.windows.net/powerbi/api/Report.Read.All, offline_access.
  • Optional scopes: https://analysis.windows.net/powerbi/api/Dataset.ReadWrite.All.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

These variables are required only when you supply your own OAuth app. If a managed app is available, you can connect without setting them. Provider permissions and consent still apply.

VariableRequiredDescription
MICROSOFT_CLIENT_IDYesMicrosoft Azure App Client ID (Application ID) Docs.
MICROSOFT_CLIENT_SECRETYesMicrosoft Azure App Client Secret Docs.

Setup

  1. Get a Power BI account: Sign in at https://app.powerbi.com with a work or school account. For testing, you can create a free Microsoft 365 developer tenant or start a Power BI trial and publish a sample report.
  2. Register an Azure app: In the Azure portal, open Microsoft Entra ID > App registrations > New registration. Choose 'Accounts in any organizational directory' and add your callback URL as a Web redirect URI.
  3. Add Power BI delegated permissions: Under API permissions, select Add a permission > Power BI Service > Delegated permissions, and add Workspace.Read.All, Dataset.Read.All, and Report.Read.All (plus Dataset.ReadWrite.All if you want to trigger refreshes).
  4. Create a client secret: Under Certificates & secrets, create a client secret. Set MICROSOFT_CLIENT_ID to the Application (client) ID and MICROSOFT_CLIENT_SECRET to the secret value.

Provider notes

  • Execute DAX Query requires the tenant setting 'Dataset Execute Queries REST API' (Power BI admin portal > Integration settings) to be enabled, and the user needs read and Build permissions on the dataset.
  • Execute DAX Query is limited to one query per call, 100,000 rows or 1,000,000 values, and 15 MB of data per query.
  • Dataset refreshes on shared capacities are limited to eight per day per dataset and only accept the notifyOption body field; Refresh Dataset needs the Dataset.ReadWrite.All scope.
  • Power BI REST APIs refer to workspaces as 'groups'.

Provider API reference.

Tools

ToolAccessDescription
List Workspaces<br /><code className="reference-identifier">power-bi__list_workspaces</code>ReadList workspaces
List My Workspace Datasets<br /><code className="reference-identifier">power-bi__list_datasets</code>ReadList My workspace datasets
List Workspace Datasets<br /><code className="reference-identifier">power-bi__list_workspace_datasets</code>ReadList workspace datasets
List My Workspace Reports<br /><code className="reference-identifier">power-bi__list_reports</code>ReadList My workspace reports
List Workspace Reports<br /><code className="reference-identifier">power-bi__list_workspace_reports</code>ReadList workspace reports
Execute DAX Query<br /><code className="reference-identifier">power-bi__execute_dax_query</code>ReadRun read-only DAX query
Refresh Dataset<br /><code className="reference-identifier">power-bi__refresh_dataset</code>WriteStart dataset refresh
Refresh Workspace Dataset<br /><code className="reference-identifier">power-bi__refresh_workspace_dataset</code>WriteStart workspace dataset refresh
List Refresh History<br /><code className="reference-identifier">power-bi__list_refresh_history</code>ReadList refresh history
List Workspace Refresh History<br /><code className="reference-identifier">power-bi__list_workspace_refresh_history</code>ReadList workspace refresh history

Verify the connection

Call a read tool such as power-bi__list_workspaces with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.