- Category: business intelligence
- Auth: OAUTH2
- Composio-managed OAuth available? No
- Tools: 116
- Triggers: 0
- Slug:
MICROSOFT_POWER_BI - Version: 20261101_00
Tools
Add A Tenant Encryption Key
Add A Tenant Encryption Key
MICROSOFT_POWER_BI_ADD_A_TENANT_ENCRYPTION_KEYAdd a tenant encryption key. Adds an encryption key for Power BI workspaces assigned to a capacity. Requires a Fabric administrator. Maximum 600 requests per hour. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_AddPowerBIEncryptionKey.Input Parameters
Output
Add Dashboard to Workspace
Add Dashboard to Workspace
MICROSOFT_POWER_BI_ADD_DASHBOARD2Creates a new empty dashboard in the specified workspace. Use this action when you need to create a new dashboard in a Power BI workspace. The API call can be called by a service principal profile. Requires the Workspace.ReadWrite.All scope. Note: The created dashboard will be empty and can be populated with tiles afterward using other APIs.Input Parameters
Output
Delete A Service Principal Profile As Admin
Delete A Service Principal Profile As Admin
MICROSOFT_POWER_BI_ADMIN_DELETE_SERVICE_PRINCIPAL_PROFILEDelete a service-principal profile as admin. Deletes the specified service principal profile. The user must be a Fabric administrator. Maximum 200 requests per hour. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_DeleteProfileAsAdmin.Input Parameters
Output
Grant Deployment Pipeline Permissions As Admin
Grant Deployment Pipeline Permissions As Admin
MICROSOFT_POWER_BI_ADMIN_GRANT_PIPELINE_PERMISSIONSGrant deployment pipeline permissions as admin. Grants user permissions to a specified deployment pipeline. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_UpdateUserAsAdmin.Input Parameters
Output
List Organization Workspace Ids Optionally Filtered By Modification Date
List Organization Workspace Ids Optionally Filtered By Modification Date
MICROSOFT_POWER_BI_ADMIN_LIST_MODIFIED_WORKSPACESList organization workspace IDs, optionally filtered by modification date. Gets a list of workspace IDs in the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation WorkspaceInfo_GetModifiedWorkspaces.Input Parameters
Output
List Organization Deployment Pipelines As Admin
List Organization Deployment Pipelines As Admin
MICROSOFT_POWER_BI_ADMIN_LIST_PIPELINESList organization deployment pipelines as admin. Returns a list of deployment pipelines for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelinesAsAdmin.Input Parameters
users and stages.Output
List Organization Service Principal Profiles
List Organization Service Principal Profiles
MICROSOFT_POWER_BI_ADMIN_LIST_SERVICE_PRINCIPAL_PROFILESList organization service-principal profiles. Returns a list of service principal profiles for the organization. Requires a Fabric administrator or service principal. Limited to 200 requests per hour. Use $top and $skip to page through results. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_GetProfilesAsAdmin.Input Parameters
Output
Remove Deployment Pipeline Permissions As Admin
Remove Deployment Pipeline Permissions As Admin
MICROSOFT_POWER_BI_ADMIN_REMOVE_PIPELINE_USERRemove deployment pipeline permissions as admin. Removes user permissions from a specified deployment pipeline. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_DeleteUserAsAdmin.Input Parameters
User, provide the user principal name (UPN). Otherwise, provide the Object ID of the principal.Output
Remove Sensitivity Labels From Power Bi Items
Remove Sensitivity Labels From Power Bi Items
MICROSOFT_POWER_BI_ADMIN_REMOVE_SENSITIVITY_LABELSRemove sensitivity labels from Power BI items. Remove sensitivity labels from Power BI items (such as reports or dashboards) by item ID. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation InformationProtection_RemoveLabelsAsAdmin.Input Parameters
Output
Unassign Workspaces From Capacity As Admin
Unassign Workspaces From Capacity As Admin
MICROSOFT_POWER_BI_ADMIN_UNASSIGN_WORKSPACES_FROM_CAPACITYUnassign workspaces from capacity as admin. Migrates the specified workspaces to shared capacity. Requires a Fabric administrator; maximum 200 requests per hour. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/capacities-unassign-workspaces-from-capacity.Input Parameters
Output
Get Reports From App
Get Reports From App
MICROSOFT_POWER_BI_APPS_GET_REPORTSReturns a list of reports from the specified app. Use this action when you need to retrieve all reports that belong to a specific Power BI app. This is useful for exploring app contents, finding specific reports within apps, or managing app resources. Required Scope: Report.ReadWrite.All or Report.Read.All Limitations: Service principal authentication isn’t supported.Input Parameters
Output
Assign My Workspace To A Capacity
Assign My Workspace To A Capacity
MICROSOFT_POWER_BI_ASSIGN_MY_WORKSPACE_TO_A_CAPACITYAssign My workspace to a capacity. Use an empty GUID (00000000-0000-0000-0000-000000000000) as capacityId to unassign it. Requires administrator rights or Assign permission on the capacity. Required delegated scopes: Capacity.ReadWrite.All and Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_AssignMyWorkspaceToCapacity.Input Parameters
Output
Assign Workspace to Capacity
Assign Workspace to Capacity
MICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_CAPACITYAssigns the specified workspace to the specified capacity. Use this action when you need to assign a Power BI workspace to a dedicated capacity or unassign My workspace from a capacity by providing an empty GUID (00000000-0000-0000-0000-000000000000). This operation is typically performed by Fabric administrators to manage workspace capacity assignments. Note: The user must have appropriate permissions (Capacity.ReadWrite.All or workspace admin rights).Input Parameters
Output
Assign A Workspace To A Dataflow Storage Account
Assign A Workspace To A Dataflow Storage Account
MICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_DATAFLOW_STORAGEAssign a workspace to a dataflow storage account. Requires workspace admin permissions and an enabled dataflow storage account. To unassign, use dataflowStorageId 00000000-0000-0000-0000-000000000000. Required delegated scopes: StorageAccount.ReadWrite.All and Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_AssignToDataflowStorage.Input Parameters
Output
Assign A Workspace To A Deployment Pipeline Stage
Assign A Workspace To A Deployment Pipeline Stage
MICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_PIPELINE_STAGEAssign a workspace to the specified deployment pipeline stage. Requires both Pipeline.ReadWrite.All and Workspace.ReadWrite.All delegated scopes. You must be an admin of the workspace. The stage must be unassigned, the workspace must not belong to another deployment pipeline, and no deployment operation may be active. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_AssignWorkspace.Input Parameters
Output
Bind A Workspace Dataset To A Gateway
Bind A Workspace Dataset To A Gateway
MICROSOFT_POWER_BI_BIND_A_WORKSPACE_DATASET_TO_A_GATEWAYBind a workspace dataset to a gateway. Binds the specified dataset from the specified workspace to the specified gateway, optionally with a given set of data source IDs. If you don’t supply a specific data source ID, the dataset will be bound to the first matching data source in the gateway. Only supports the on-premises data gateway. The API caller principal must be a data source user on the gateway. Service principal profiles are supported. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_BindToGatewayInGroup.Input Parameters
Output
Cancel A Dataflow Transaction
Cancel A Dataflow Transaction
MICROSOFT_POWER_BI_CANCEL_A_DATAFLOW_TRANSACTIONCancel a dataflow transaction. Attempts to cancel the specified transactions. Required delegated scopes: Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_CancelDataflowTransaction.Input Parameters
Output
Cancel A Dataset Refresh In My Workspace
Cancel A Dataset Refresh In My Workspace
MICROSOFT_POWER_BI_CANCEL_A_DATASET_REFRESH_IN_MY_WORKSPACECancel a dataset refresh in My workspace. Cancels the specified refresh operation for the specified dataset from My workspace. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_CancelRefresh.Input Parameters
Output
Cancel Dataset Refresh in Workspace
Cancel Dataset Refresh in Workspace
MICROSOFT_POWER_BI_CANCEL_REFRESH2Cancels the specified refresh operation for the specified dataset from the specified workspace. Use this action when you need to cancel an in-progress dataset refresh operation within a specific Power BI workspace. This is useful for stopping long-running refreshes that are no longer needed or that appear to be stuck. Note that only refresh operations with status of Unknown or Queued can be canceled. Once a refresh has started processing, it cannot be cancelled. This action is irreversible - once a refresh is successfully cancelled, it cannot be resumed and must be triggered again manually. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Change A Capacity Encryption Key
Change A Capacity Encryption Key
MICROSOFT_POWER_BI_CHANGE_A_CAPACITY_ENCRYPTION_KEYChange a capacity encryption key. Changes specific capacity information. Currently, this API call only supports changing the capacity’s encryption key. The user must be a Fabric administrator. Maximum 200 requests per hour. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_PatchCapacityAsAdmin.Input Parameters
Output
Check Gateway Data Source Connectivity
Check Gateway Data Source Connectivity
MICROSOFT_POWER_BI_CHECK_GATEWAY_DATA_SOURCE_CONNECTIVITYCheck gateway data source connectivity. Checks the connectivity status of the specified data source from the specified gateway. Requires gateway admin permissions; VNet gateways are unsupported. Success returns no response body; connectivity failures raise provider errors. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_GetDatasourceStatus.Input Parameters
Output
Clone A Dashboard Tile In A Workspace
Clone A Dashboard Tile In A Workspace
MICROSOFT_POWER_BI_CLONE_A_DASHBOARD_TILE_IN_A_WORKSPACEClone a tile from a workspace dashboard to a target dashboard. Returns the cloned tile. For cross-workspace clones, provide target report and model IDs to preserve working report/dataset links; omitting them removes those links and leaves the tile broken. Same-workspace clones retain source links when those IDs are omitted. Rebinding preserves the original report filters in the tile’s underlying query. Required delegated scope: Dashboard.ReadWrite.All. Service principal profiles are supported. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_CloneTileInGroup.Input Parameters
Output
Clone A Dashboard Tile In My Workspace
Clone A Dashboard Tile In My Workspace
MICROSOFT_POWER_BI_CLONE_A_DASHBOARD_TILE_IN_MY_WORKSPACEClone the specified dashboard tile from My workspace. Cloning preserves the underlying query’s original report filters. If target report and dataset IDs are omitted, same-workspace clones retain the source links; cross-workspace clones lose those links and the tile will be broken. Supply targetReportId and targetModelId to rebind a linked tile. Required delegated scope: Dashboard.ReadWrite.All. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_CloneTile.Input Parameters
Output
Clone Report
Clone Report
MICROSOFT_POWER_BI_CLONE_REPORT2Clones the specified report from My workspace. If the dataset for a cloned report resides in two different workspaces or in My workspace, then a shared dataset is created. Use when you need to duplicate a report within My workspace or to another workspace. This is useful for creating backup copies of reports, testing modifications without affecting the original, or preparing reports for different audiences. Required Scope: Report.ReadWrite.AllInput Parameters
Output
Clone Report in Workspace
Clone Report in Workspace
MICROSOFT_POWER_BI_CLONE_REPORT_IN_GROUPClones the specified report from the specified workspace. Use this action when you need to duplicate a Power BI report within the same workspace or to a different workspace. If the dataset for a cloned report resides in two different workspaces or in My workspace, then a share is required. The API returns the cloned report with a new ID. Required Scope: Report.ReadWrite.AllInput Parameters
Output
Create A Deployment Pipeline
Create A Deployment Pipeline
MICROSOFT_POWER_BI_CREATE_A_DEPLOYMENT_PIPELINECreate a deployment pipeline. Creates a new deployment pipeline. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_CreatePipeline.Input Parameters
Output
Create A Gateway Data Source
Create A Gateway Data Source
MICROSOFT_POWER_BI_CREATE_A_GATEWAY_DATA_SOURCECreate a gateway data source. Creates a new data source on the specified on-premises gateway. Requires gateway admin permissions. Set encryptedConnection to Encrypted and encrypt credentials using the gateway public key. VNet and cloud gateways and OAuth2 credential types are not supported. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/create-datasource.Input Parameters
Output
Create A Service Principal Profile
Create A Service Principal Profile
MICROSOFT_POWER_BI_CREATE_A_SERVICE_PRINCIPAL_PROFILECreate a profile owned by the calling service principal. Only service-principal authentication is supported. A service principal can own at most 100,000 profiles. https://learn.microsoft.com/en-us/rest/api/power-bi/profiles/create-profileInput Parameters
Output
Create Goal Value Check-in
Create Goal Value Check-in
MICROSOFT_POWER_BI_CREATE_GOAL_VALUECreates a new goal value check-in for a Power BI scorecard goal. Use this action when you need to record a new value check-in for a specific goal within a Power BI scorecard. This action allows you to update the current value, target, status, trend, and forecast of a goal. The timestamp is required and represents the UTC time of the check-in. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Create Workspace
Create Workspace
MICROSOFT_POWER_BI_CREATE_GROUPCreates a new workspace in Power BI. Use this action when you need to create a new Power BI workspace to organize reports, dashboards, datasets, and other Power BI content. This API call can be called by a service principal profile. Requires the Workspace.ReadWrite.All scope. Note: The created workspace will be empty and may require additional configuration such as assigning capacity or adding members.Input Parameters
Output
Create My Workspace Dashboard
Create My Workspace Dashboard
MICROSOFT_POWER_BI_CREATE_MY_WORKSPACE_DASHBOARDCreate a new empty dashboard in the signed-in user’s My workspace. Returns the dashboard ID and available dashboard properties. Use Add Dashboard in a specified workspace to create a dashboard in a shared workspace instead. Required scope: Content.Create.Input Parameters
Output
Create Push Dataset
Create Push Dataset
MICROSOFT_POWER_BI_CREATE_PUSH_DATASETCreates a new dataset on My workspace in Power BI. Use this action when you need to create a new push dataset to store and manage data that can be pushed programmatically via the Power BI REST API. This API call only supports push datasets (Push, Streaming, or PushStreaming mode). This action is irreversible once the dataset is created. The dataset name must be unique within the workspace.Input Parameters
Output
Create Scorecard
Create Scorecard
MICROSOFT_POWER_BI_CREATE_SCORECARDCreates a new scorecard in the specified Power BI workspace. Use this action when you need to create a new scorecard to track business objectives and key results in a specific Power BI workspace. Scorecards help organizations monitor progress toward goals with customizable metrics, status rules, and reporting. Requires the Dataset.ReadWrite.All scope. This action is irreversible once the scorecard is created. The scorecard name must be unique within the workspace.Input Parameters
Output
Generate An Automated Template App Installation Ticket
Generate An Automated Template App Installation Ticket
MICROSOFT_POWER_BI_CREATE_TEMPLATE_APP_INSTALL_TICKETGenerate an installation ticket for an automated template-app install using service-principal authentication. The tenant must own the app; the app must be on AppSource or both the ticket creator and installing user must have explicit access. Configure every required query parameter. Supply single-app appId/packageKey/ownerTenantId/config fields, or a batch installDetails array. No delegated scopes apply. https://learn.microsoft.com/en-us/rest/api/power-bi/template-apps/create-install-ticketInput Parameters
Output
Create Temporary Upload Location
Create Temporary Upload Location
Create Temporary Upload Location
Create Temporary Upload Location
Delete A Dashboard In A Workspace
Delete A Dashboard In A Workspace
MICROSOFT_POWER_BI_DELETE_A_DASHBOARD_IN_A_WORKSPACEDelete a dashboard in a workspace. Deletes the specified dashboard from the specified workspace. Required delegated scopes: Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_DeleteDashboardInGroup.Input Parameters
Output
Delete A Deployment Pipeline
Delete A Deployment Pipeline
MICROSOFT_POWER_BI_DELETE_A_DEPLOYMENT_PIPELINEDelete a deployment pipeline. Deletes the specified deployment pipeline. Fails if there is an active deployment operation. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_DeletePipeline.Input Parameters
Output
Delete A Gateway Data Source
Delete A Gateway Data Source
MICROSOFT_POWER_BI_DELETE_A_GATEWAY_DATA_SOURCEDelete the specified data source from the specified gateway. Requires gateway admin permissions and delegated scope Dataset.ReadWrite.All. Virtual network (VNet) gateways aren’t supported. Provider documentation: https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/delete-datasourceInput Parameters
Output
Delete A Report In My Workspace
Delete A Report In My Workspace
MICROSOFT_POWER_BI_DELETE_A_REPORT_IN_MY_WORKSPACEDelete a report in My workspace. Deletes the specified report from My workspace. Required delegated scopes: Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_DeleteReport.Input Parameters
Output
Delete A Service Principal Profile
Delete A Service Principal Profile
MICROSOFT_POWER_BI_DELETE_A_SERVICE_PRINCIPAL_PROFILEDelete a service-principal profile owned by the calling service principal. Can only be called by a service principal. No delegated scope is declared. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_DeleteProfile.Input Parameters
Output
Delete Dashboard
Delete Dashboard
MICROSOFT_POWER_BI_DELETE_DASHBOARDDeletes the specified dashboard from My workspace. Use this action when you need to permanently remove a dashboard from a user’s Power BI workspace. This action is irreversible — once deleted, the dashboard and all its content cannot be recovered. Required Scope: Dashboard.ReadWrite.AllInput Parameters
Output
Delete Dataflow
Delete Dataflow
MICROSOFT_POWER_BI_DELETE_DATAFLOWDeletes the specified dataflow from Power BI data prep storage, including its definition file and model. Use this action when you need to permanently remove a dataflow from a Power BI workspace. This action is irreversible — once deleted, the dataflow and all its associated data cannot be recovered. Permissions: The user must have administrator rights or the caller must be a service principal.Input Parameters
Output
Delete Dataset
Delete Dataset
MICROSOFT_POWER_BI_DELETE_DATASETDeletes the specified dataset from My workspace. Use this action when you need to permanently remove a dataset from a user’s Power BI workspace. This action is irreversible — once deleted, the dataset and all its associated data cannot be recovered. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Delete Dataset from Workspace
Delete Dataset from Workspace
MICROSOFT_POWER_BI_DELETE_DATASET2Deletes the specified dataset from the specified workspace. Use this action when you need to permanently remove a dataset from a specific Power BI workspace. This action is irreversible — once deleted, the dataset and all its associated data cannot be recovered. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Delete Goal
Delete Goal
MICROSOFT_POWER_BI_DELETE_GOALDeletes a goal from a scorecard by goal ID. Use this action when you need to permanently remove a goal from a Power BI scorecard. This action is irreversible — once deleted, the goal and its associated data cannot be recovered. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Delete Goal Note by ID
Delete Goal Note by ID
MICROSOFT_POWER_BI_DELETE_GOAL_NOTE_BY_IDDeletes a goal value check-in note by its unique identifier. Use this action when you need to remove a specific check-in note from a goal value in Power BI goals. This action is irreversible — once deleted, the note cannot be recovered. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Delete Goal Status Rules
Delete Goal Status Rules
MICROSOFT_POWER_BI_DELETE_GOAL_STATUS_RULESRemoves status rule definitions from a goal. Use this action when you need to remove all status rules from a specific goal within a Power BI scorecard. This action is irreversible — once deleted, the status rules and their configuration cannot be recovered. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Delete Pipeline User
Delete Pipeline User
MICROSOFT_POWER_BI_DELETE_PIPELINE_USERRemoves user permissions from the specified deployment pipeline. Use this action when you need to revoke a user’s access to a deployment pipeline. This action is irreversible — once removed, the user loses access to the pipeline. Required Scope: Pipeline.ReadWrite.AllInput Parameters
Output
Delete Report from Workspace
Delete Report from Workspace
MICROSOFT_POWER_BI_DELETE_REPORT_IN_GROUPDeletes the specified report from the specified workspace. Use this action when you need to permanently remove a report from a specific Power BI workspace. This action is irreversible — once deleted, the report and all its content cannot be recovered. This API call can be called by a service principal profile. Required Scope: Report.ReadWrite.AllInput Parameters
Output
Delete Rows from Dataset Table
Delete Rows from Dataset Table
MICROSOFT_POWER_BI_DELETE_ROWSDeletes all rows from the specified table within the specified dataset from My workspace. Use this action when you need to clear all data from a specific table within a Power BI push dataset. This action is irreversible — once deleted, the rows cannot be recovered. This operation is commonly used to reset test data or prepare a table for fresh data ingestion. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Delete Rows from Dataset Table in Workspace
Delete Rows from Dataset Table in Workspace
MICROSOFT_POWER_BI_DELETE_ROWS_IN_GROUPDeletes all rows from the specified table within the specified dataset from the specified workspace. Use this action when you need to clear all data from a specific table within a Power BI push dataset in a specific workspace. This action is irreversible — once deleted, the rows cannot be recovered. This operation is commonly used to reset test data or prepare a table for fresh data ingestion in a workspace context. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Delete Scorecard By ID
Delete Scorecard By ID
MICROSOFT_POWER_BI_DELETE_SCORECARD_BY_IDDeletes a scorecard by its ID from the specified workspace. Use this action when you need to permanently remove a scorecard from a Power BI workspace. This action is irreversible — once deleted, the scorecard and all its data cannot be recovered. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Delete Workspace
Delete Workspace
MICROSOFT_POWER_BI_DELETE_WORKSPACEDeletes the specified workspace. Use this action when you need to permanently remove a Power BI workspace. This action is irreversible — once deleted, the workspace and all its content (reports, dashboards, datasets) cannot be recovered. Required Scope: Workspace.ReadWrite.AllInput Parameters
Output
Deploy All Supported Items From A Pipeline Stage
Deploy All Supported Items From A Pipeline Stage
MICROSOFT_POWER_BI_DEPLOY_ALL_PIPELINE_ITEMSDeploy all supported Power BI items from a pipeline stage. Requires contributor access to both source and target workspaces and delegated scope Pipeline.Deploy. Maximum 300 items per request; other Fabric item types are unsupported. Returns an accepted pipeline operation, not deployment completion; inspect its status to determine the outcome. Provider contract: https://learn.microsoft.com/en-us/rest/api/power-bi/pipelines/deploy-allInput Parameters
Output
Deploy Selected Items From A Pipeline Stage
Deploy Selected Items From A Pipeline Stage
MICROSOFT_POWER_BI_DEPLOY_SELECTED_PIPELINE_ITEMSDeploy selected Power BI items from a deployment pipeline stage (maximum 300 items). Requires contributor access to both source and target workspaces. Other Fabric item types are unsupported. Returns an accepted pipeline operation, not confirmation that deployment finished; inspect its status to verify completion. Required delegated scopes: Pipeline.Deploy Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/pipelines/selective-deploy.Input Parameters
Output
Discover Gateways for Dataset
Discover Gateways for Dataset
MICROSOFT_POWER_BI_DISCOVER_GATEWAYSReturns a list of gateways that the specified dataset from the specified workspace can be bound to. Use this action when you need to discover which on-premises data gateways are available to bind a dataset to for refresh and data source connections. This API call is only relevant for datasets that have at least one binding to an on-premises data source. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Download An Exported Workspace Report File
Download An Exported Workspace Report File
MICROSOFT_POWER_BI_DOWNLOAD_WORKSPACE_REPORT_EXPORTRetrieve the completed export-job file for a workspace report as a platform-managed downloadable file reference, with content metadata. Poll export status until Succeeded before downloading. Required delegated scope: Report.Read.All or Report.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/reports/get-file-of-export-to-file-in-groupInput Parameters
Output
Execute DAX Queries
Execute DAX Queries
MICROSOFT_POWER_BI_EXECUTE_DAX_QUERIESExecutes DAX queries against a capacity-hosted dataset in My workspace, with options for RLS, culture and custom data. Returns raw Apache Arrow data for parsing; the success flag does not rule out errors embedded in the stream.Input Parameters
Output
Execute DAX Queries on Dataset
Execute DAX Queries on Dataset
MICROSOFT_POWER_BI_EXECUTE_QUERIES_2Executes Data Analysis Expressions (DAX) queries against the specified Power BI dataset. Use this action when you need to run DAX queries to retrieve data, perform calculations, or analyze data directly from a Power BI dataset. DAX query errors (such as syntax errors or invalid references) will result in an error response. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Execute Subscription
Execute Subscription
MICROSOFT_POWER_BI_EXECUTE_SUBSCRIPTIONExecutes the Subscription specified by the Id. Use this action when you need to manually trigger a Power BI email subscription to run immediately instead of waiting for its scheduled frequency. This is useful for testing subscriptions, generating reports on-demand, or forcing an unscheduled distribution of a report. Note: The API returns 204 No Content on success with an empty body.Input Parameters
Output
Export A Dataflow Definition As Admin
Export A Dataflow Definition As Admin
MICROSOFT_POWER_BI_EXPORT_A_DATAFLOW_DEFINITION_AS_ADMINExport the specified dataflow definition as a downloadable JSON file reference. Requires a Fabric administrator or service principal. Delegated access requires Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent-required Power BI permissions configured. Maximum 200 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_ExportDataflowAsAdmin.Input Parameters
Output
Export A Dataflow Definition As Json
Export A Dataflow Definition As Json
MICROSOFT_POWER_BI_EXPORT_A_DATAFLOW_DEFINITION_AS_JSONExport a workspace dataflow definition as a platform-managed downloadable JSON file reference, with content metadata. Download the file to read its JSON definition; the response is not a parsed definition. Required delegated scope: Dataflow.Read.All or Dataflow.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/dataflows/get-dataflowInput Parameters
Output
Export A Workspace Report As Pbix Or Rdl
Export A Workspace Report As Pbix Or Rdl
MICROSOFT_POWER_BI_EXPORT_A_WORKSPACE_REPORT_AS_PBIX_OR_RDLExport a workspace report as a downloadable PBIX or RDL file reference. Required delegated scopes: Report.ReadWrite.All OR (Report.Read.All AND Dataset.Read.All). Dataset.Read.All alone does not authorize this operation. Service principal profiles are supported. PBIX download limitations apply; exporting a live-connected report after rebinding it is not supported. Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/export-report-in-groupInput Parameters
Output
Generate A Tile Embed Token
Generate A Tile Embed Token
MICROSOFT_POWER_BI_GENERATE_A_TILE_EMBED_TOKENGenerate an embed token to view the specified tile in a workspace. Only relevant to the embed-for-your-customers scenario; supports service principal profiles. Required delegated scopes: (Dashboard.Read.All or Dashboard.ReadWrite.All) AND (Report.Read.All or Report.ReadWrite.All) AND (Dataset.Read.All or Dataset.ReadWrite.All). Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Tiles_GenerateTokenInGroup.Input Parameters
Output
Generate Dashboard Embed Token
Generate Dashboard Embed Token
MICROSOFT_POWER_BI_GENERATE_DASHBOARD_EMBED_TOKENGenerates an embed token to view or edit the specified dashboard from the specified workspace. Use this action when you need to generate an embed token to embed a Power BI dashboard in your application. The token allows you to embed the dashboard with the specified access level. You can also configure row-level security (RLS) by providing identities. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
false. Only applies when you generate an embed token for report embedding.Output
Generate Embed Token for Power BI
Generate Embed Token for Power BI
MICROSOFT_POWER_BI_GENERATE_EMBED_TOKENGenerates an embed token for multiple reports, datasets, and target workspaces. Use this action when you need to generate an embed token to embed Power BI reports, dashboards, or visuals in your application. Reports and datasets do not have to be related. The token can include identities for row-level security (RLS) and single sign-on (SSO) data sources.Input Parameters
Output
Generate Report Embed Token in Group
Generate Report Embed Token in Group
MICROSOFT_POWER_BI_GENERATE_REPORT_TOKEN_IN_GROUPGenerates an embed token to view or edit the specified report from the specified workspace. Use this action when you need to generate an embed token to embed a Power BI report in your application. The token allows you to control the access level (View, Edit, or Create) for the embedded report. You can also configure row-level security (RLS) by providing identities, customize the token lifetime, and enable the allowSaveAs option for saving embedded reports as new reports. Required Scope: Report.ReadWrite.All or Report.Read.AllInput Parameters
false. Only applies when you generate an embed token for report embedding.Output
Generate Dataset Embed Token in Group
Generate Dataset Embed Token in Group
MICROSOFT_POWER_BI_GENERATE_TOKEN_IN_GROUPGenerates an embed token based on the specified dataset from the specified workspace. Use this action when you need to generate an embed token to embed Power BI reports or dashboards using a specific dataset from a workspace in your application. The token allows you to control the access level (View, Edit, or Create) for the embedded content. You can also configure row-level security (RLS) by providing identities, and customize the token lifetime. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
false. Only applies when you generate an embed token for report embedding.Output
Get A Capacity Refreshable As Admin
Get A Capacity Refreshable As Admin
MICROSOFT_POWER_BI_GET_A_CAPACITY_REFRESHABLE_AS_ADMINReturn a capacity refreshable and its refresh statistics as an admin. Requires a Fabric administrator or service principal. Delegated authentication requires Tenant.Read.All or Tenant.ReadWrite.All; these permissions must not be configured on the app for service-principal authentication. Limited to 200 requests per hour. History covers seven days, up to sixty refreshes per dataset. Returns a refreshables list even though the path identifies one item. https://learn.microsoft.com/en-us/rest/api/power-bi/admin/get-refreshable-for-capacityInput Parameters
capacities and groups.Output
Get A Capacity Workload State
Get A Capacity Workload State
MICROSOFT_POWER_BI_GET_A_CAPACITY_WORKLOAD_STATEGet a capacity workload state. Returns the current state of a workload. If the workload is enabled, the percentage of maximum memory that the workload can consume is also returned. Workload APIs aren’t relevant for Gen2 capacities. Required delegated scopes: Capacity.Read.All or Capacity.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/get-workload.Input Parameters
Output
Get A Dashboard From An App
Get A Dashboard From An App
MICROSOFT_POWER_BI_GET_A_DASHBOARD_FROM_AN_APPGet a dashboard from an app. Returns the specified dashboard from the specified app. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All. Service principal authentication isn’t supported. Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-dashboard.Input Parameters
Output
Get A Dashboard In A Workspace
Get A Dashboard In A Workspace
MICROSOFT_POWER_BI_GET_A_DASHBOARD_IN_A_WORKSPACEGet a dashboard in a workspace. Returns the specified dashboard from the specified workspace. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetDashboardInGroup.Input Parameters
Output
Get A Dashboard Tile In A Workspace
Get A Dashboard Tile In A Workspace
MICROSOFT_POWER_BI_GET_A_DASHBOARD_TILE_IN_A_WORKSPACEGet a dashboard tile in a workspace. Returns the specified tile within the specified dashboard from the specified workspace. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetTileInGroup.Input Parameters
Output
Get A Dashboard Tile In My Workspace
Get A Dashboard Tile In My Workspace
MICROSOFT_POWER_BI_GET_A_DASHBOARD_TILE_IN_MY_WORKSPACEGet a dashboard tile in My workspace. Returns the specified tile within the specified dashboard from My workspace. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetTile.Input Parameters
Output
Get A Deployment Pipeline
Get A Deployment Pipeline
MICROSOFT_POWER_BI_GET_A_DEPLOYMENT_PIPELINEGet a deployment pipeline. Returns the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipeline.Input Parameters
stages.Output
Get A Gateway Data Source
Get A Gateway Data Source
MICROSOFT_POWER_BI_GET_A_GATEWAY_DATA_SOURCEGet a gateway data source. Returns the specified data source from the specified gateway. Requires gateway admin permissions. Virtual network (VNet) gateways aren’t supported. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_GetDatasource.Input Parameters
Output
Get An Import In A Workspace
Get An Import In A Workspace
MICROSOFT_POWER_BI_GET_AN_IMPORT_IN_A_WORKSPACEGet an import in a workspace. Returns the specified import from the specified workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Imports_GetImportInGroup.Input Parameters
Output
Get An Installed App
Get An Installed App
MICROSOFT_POWER_BI_GET_AN_INSTALLED_APPGet an installed app. Returns the specified installed app. Required delegated scopes: App.Read.All. Service principal authentication isn’t supported. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetApp.Input Parameters
Output
Get An Organization Workspace As Admin
Get An Organization Workspace As Admin
MICROSOFT_POWER_BI_GET_AN_ORGANIZATION_WORKSPACE_AS_ADMINGet an organization workspace as admin. Returns a workspace for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_GetGroupAsAdmin.Input Parameters
users, reports, dashboards, datasets, dataflows, and workbooks.Output
Get A Report From An App
Get A Report From An App
MICROSOFT_POWER_BI_GET_A_REPORT_FROM_AN_APPGet a report from an app. Returns the specified report from the specified app. Service principal authentication isn’t supported. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetReport.Input Parameters
Output
Get A Report In A Workspace
Get A Report In A Workspace
MICROSOFT_POWER_BI_GET_A_REPORT_IN_A_WORKSPACEGet a report in a workspace. Returns the specified report from the specified workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetReportInGroup.Input Parameters
Output
Get A Service Principal Profile
Get A Service Principal Profile
MICROSOFT_POWER_BI_GET_A_SERVICE_PRINCIPAL_PROFILEGet a service-principal profile. Returns the specified profile if it exists and belongs to the calling service principal. Can only be called by a service principal. Required delegated scopes: No delegated scope declared; see provider authentication requirements. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_GetProfile.Input Parameters
Output
Get A Tile From An App Dashboard
Get A Tile From An App Dashboard
MICROSOFT_POWER_BI_GET_A_TILE_FROM_AN_APP_DASHBOARDGet a tile from an app dashboard. Returns the specified tile within the specified dashboard from the specified app. Supported tiles include datasets and live tiles containing an entire report page. Service principal authentication is not supported. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-tile.Input Parameters
Output
Get Available Feature By Name
Get Available Feature By Name
MICROSOFT_POWER_BI_GET_AVAILABLE_FEATURE_BY_NAMEReturns the specified available feature for the user by name. Use this action when you need to check the availability and status of a specific Power BI feature, such as embedTrial. This API call doesn’t require any scopes. Note: The featureName path parameter should be URL-encoded if it contains special characters.Input Parameters
Output
Get Capacities
Get Capacities
Get Capacity Workload States
Get Capacity Workload States
MICROSOFT_POWER_BI_GET_CAPACITY_WORKLOAD_STATESList workload states for a capacity, including the memory percentage of enabled workloads. Workload APIs are not relevant for Gen2 capacities. Required delegated scope: Capacity.Read.All or Capacity.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/get-workloadsInput Parameters
Output
Get Dashboard from My Workspace
Get Dashboard from My Workspace
MICROSOFT_POWER_BI_GET_DASHBOARD2Returns the specified dashboard from My workspace. Use when you need to retrieve details about a specific dashboard from the current user’s personal workspace in Power BI. This is useful for getting dashboard metadata, embed URLs, or user permissions. Required Scope: Dashboard.ReadWrite.All or Dashboard.Read.AllInput Parameters
Output
Get Dashboards
Get Dashboards
MICROSOFT_POWER_BI_GET_DASHBOARDSReturns a list of dashboards from the specified workspace. Use this action when you need to retrieve all dashboards within a Power BI workspace. This is useful for exploring workspace contents, finding specific dashboard IDs, or managing dashboard resources. Permissions: This API call can be called by a service principal profile.Input Parameters
Output
Get Dataflows
Get Dataflows
MICROSOFT_POWER_BI_GET_DATAFLOWSLists dataflows in a specified Power BI workspace, with optional filtering and paging; by default the request asks for the first 25 results. This API can be called by a service principal profile and requires Dataflow.Read.All or Dataflow.ReadWrite.All.Input Parameters
Output
Get Dataset
Get Dataset
MICROSOFT_POWER_BI_GET_DATASETReturns the specified dataset from My workspace. Use this action when you need to retrieve details about a specific Power BI dataset in your workspace, including its configuration, permissions, and relationships to other artifacts like dataflows and tables. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Dataset in Workspace
Get Dataset in Workspace
MICROSOFT_POWER_BI_GET_DATASET2Returns the specified dataset from the specified workspace. Use this action when you need to retrieve details about a specific Power BI dataset in a workspace, including its configuration, permissions, and relationships to other artifacts like dataflows and tables. Permissions: This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get DataSet Data
Get DataSet Data
MICROSOFT_POWER_BI_GET_DATA_SET_DATAExecutes a fixed synthetic DAX query against a specified Power BI dataset and returns the first result table’s rows and available column definitions. The query produces a status or dummy row rather than retrieving dataset table contents.Input Parameters
Output
Get Datasets from My Workspace
Get Datasets from My Workspace
MICROSOFT_POWER_BI_GET_DATASETSReturns a list of datasets from My workspace. Use when you need to retrieve all datasets available in the authenticated user’s personal workspace, including their configuration and metadata. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get DataSets from Power BI
Get DataSets from Power BI
MICROSOFT_POWER_BI_GET_DATA_SETSGets an array of DataSet CatalogItems from Power BI. Use when you need to retrieve all available datasets from the Power BI service, including their metadata such as creation date, modified date, owner, and dataset-specific properties like query timeout and parameters. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Dataset to Dataflows Links
Get Dataset to Dataflows Links
MICROSOFT_POWER_BI_GET_DATASET_TO_DATAFLOWS_LINKSReturns a list of upstream dataflows for datasets from the specified workspace. Use this action when you need to retrieve the relationships between datasets and their upstream dataflows in a Power BI workspace for dependency analysis or lineage tracking. This API call can be called by a service principal profile.Input Parameters
Output
Get Dataset Users
Get Dataset Users
MICROSOFT_POWER_BI_GET_DATASET_USERSReturns a list of principals that have access to the specified dataset. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI dataset. This is useful for auditing dataset permissions, managing access control, or understanding who can view or modify the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available.Input Parameters
Output
Get Dataset Users In Group
Get Dataset Users In Group
MICROSOFT_POWER_BI_GET_DATASET_USERS_IN_GROUPReturns a list of principals that have access to the specified dataset within a workspace. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI dataset within a workspace. This is useful for auditing dataset permissions, managing access control, or understanding who can view or modify the dataset in a group context. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available.Input Parameters
Output
Get Datasources for Dataset
Get Datasources for Dataset
MICROSOFT_POWER_BI_GET_DATASOURCESReturns a list of data sources for the specified dataset from My workspace. Use when you need to retrieve all data source connections configured for a specific Power BI dataset, such as when auditing data sources, troubleshooting refresh issues, or understanding dataset dependencies. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Datasources for Dataset in Workspace
Get Datasources for Dataset in Workspace
MICROSOFT_POWER_BI_GET_DATASOURCES_IN_GROUP3Returns a list of data sources for the specified dataset from the specified workspace. Use when you need to retrieve all data source connections configured for a specific Power BI dataset within a workspace, such as when auditing data sources, troubleshooting refresh issues, or understanding dataset dependencies. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Gateway
Get Gateway
MICROSOFT_POWER_BI_GET_GATEWAYReturns the specified gateway. Use this action when you need to retrieve details about a specific Power BI gateway, including its status, type, and public key for encryption. Permissions: The user must have gateway admin permissions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Gateway Datasources in Group
Get Gateway Datasources in Group
MICROSOFT_POWER_BI_GET_GATEWAY_DATASOURCES_IN_GROUPReturns a list of gateway data sources for the specified dataset from the specified workspace. Use this action when you need to retrieve all gateway data source connections configured for a specific Power BI dataset within a workspace. This is useful for auditing data source configurations, troubleshooting refresh issues, or understanding dataset dependencies. This API is deprecated - use Get Datasources In Group instead.Input Parameters
Output
Get Gateways
Get Gateways
MICROSOFT_POWER_BI_GET_GATEWAYSReturns a list of gateways for which the user is an admin. Use this action when you need to retrieve all Power BI gateways that you have administrative permissions for. This is useful for monitoring gateway status, managing data sources, or administering on-premises data gateway configurations. Gateway admin permissions are required to access this endpoint.Output
Get Goals from Scorecard
Get Goals from Scorecard
MICROSOFT_POWER_BI_GET_GOALSReturns a list of goals from a scorecard. Use this action when you need to retrieve all goals defined within a Power BI scorecard. This is useful for understanding the organizational objectives and key results (OKRs) tracked in Power BI, finding specific goal IDs, or monitoring progress against targets. This API call can be called by a service principal profile. Required Scope: Dataset.Read.All or Dataset.ReadWrite.AllInput Parameters
goalValues and aggregations.Output
Get Goals Refresh History
Get Goals Refresh History
MICROSOFT_POWER_BI_GET_GOALS_REFRESH_HISTORYReads refresh history of a connected goal. Use this action when you need to retrieve the refresh history for a specific Power BI goal to monitor refresh performance, identify failed refreshes, or audit refresh operations on goals. This endpoint is part of the Power BI Goals (Preview) API. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All Note: This is a preview API and may be subject to changes.Input Parameters
Output
Get Goals Status Rules
Get Goals Status Rules
MICROSOFT_POWER_BI_GET_GOALS_STATUS_RULESReturns status rules of a goal. Use this action when you need to retrieve the status rules configuration for a specific Power BI goal within a scorecard. Status rules determine how goal status is calculated based on conditions (e.g., if actual value > 50% of target, status is “On track”). This action supports reading both simple expression-based conditions and complex field comparison conditions. Required Scope: Dataset.Read.All or Dataset.ReadWrite.AllInput Parameters
Output
Get Goal Value By ID
Get Goal Value By ID
MICROSOFT_POWER_BI_GET_GOAL_VALUE_BY_IDReads a goal value check-in by a UTC date timestamp. Use this action when you need to retrieve a specific goal value check-in from a Power BI scorecard. This is useful for tracking historical goal values, reviewing notes on goal progress, or analyzing trends. The timestamp must be provided in UTC format (e.g., 2024-05-12T00:00:00Z). Required Scope: Dataset.Read.All or Dataset.ReadWrite.AllInput Parameters
notes.Output
Get Groups
Get Groups
Get Groups Capacity Assignment Status
Get Groups Capacity Assignment Status
MICROSOFT_POWER_BI_GET_GROUPS_CAPACITY_ASSIGNMENT_STATUSGets the status of the assignment-to-capacity operation for the specified workspace. Use this action when you need to check the current status of a workspace assignment operation to a capacity. This is useful for monitoring long-running workspace migrations or diagnosing failed assignments. Required Scope: Workspace.Read.All or Workspace.ReadWrite.AllInput Parameters
Output
Get Group Users
Get Group Users
MICROSOFT_POWER_BI_GET_GROUP_USERSReturns a list of users that have access to the specified workspace. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI workspace. This is useful for auditing workspace permissions, managing access control, or understanding who can view or modify the workspace contents. Permissions: This API call can be called by a service principal profile.Input Parameters
Output
Get Import
Get Import
MICROSOFT_POWER_BI_GET_IMPORTReturns the specified import from My workspace. Use this action when you need to retrieve details about a specific import in your Power BI workspace, including its status, associated datasets, and reports. This is useful for tracking import operations, checking whether an import succeeded or failed, and identifying related artifacts. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Imports from My Workspace
Get Imports from My Workspace
MICROSOFT_POWER_BI_GET_IMPORTS2Returns a list of imports from My workspace. Use this action when you need to retrieve all imports in the authenticated user’s personal workspace, including their status, associated datasets, and reports. This is useful for monitoring import operations, checking import completion status, or listing imported content in your workspace. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllOutput
Get Imports in Workspace
Get Imports in Workspace
MICROSOFT_POWER_BI_GET_IMPORTS_IN_GROUPReturns a list of imports from the specified workspace. Use this action when you need to retrieve all imports in a Power BI workspace to monitor import status, list imported datasets and reports, or check for failed imports. This API can be called by a service principal profile with appropriate workspace permissions.Input Parameters
Output
Get Linked Report History Snapshot
Get Linked Report History Snapshot
MICROSOFT_POWER_BI_GET_LINKED_REPORT_HISTORY_SNAPSHOTGets requested HistorySnapshot item specified by HistoryId of the LinkedReport specified by Id. Use this action when you need to retrieve a specific history snapshot for a Power BI LinkedReport. History snapshots capture the state of a report at a particular point in time and can be used for auditing, versioning, or recovery purposes. This is a read-only operation that returns snapshot metadata including creation date, snapshot ID, and size information.Input Parameters
Output
Get My Workspace Capacity Assignment Status
Get My Workspace Capacity Assignment Status
MICROSOFT_POWER_BI_GET_MY_WORKSPACE_CAPACITY_STATUSGet My workspace capacity assignment status. Gets the status of the My workspace assignment-to-capacity operation. Required delegated scopes: Workspace.Read.All AND Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_CapacityAssignmentStatusMyWorkspace.Output
Get Report Page
Get Report Page
MICROSOFT_POWER_BI_GET_PAGEReturns the specified page within the specified report from the specified workspace. Use this action when you need to retrieve details about a specific page within a Power BI report. This is useful for exploring report structure, getting page metadata, or identifying the order of pages in a report. Permissions: This API call can be called by a service principal profile.Input Parameters
Output
Get Pages from Report
Get Pages from Report
MICROSOFT_POWER_BI_GET_PAGESReturns a list of pages within the specified report from the specified workspace. Use this action when you need to retrieve all pages in a Power BI report to understand the report structure, navigate between pages, or manage report content. This API call can be called by a service principal profile. Required Scope: Report.ReadWrite.All or Report.Read.AllInput Parameters
Output
Get Pages from Report in My Workspace
Get Pages from Report in My Workspace
MICROSOFT_POWER_BI_GET_PAGES_IN_MY_WORKSPACEReturns a list of pages within the specified report from My workspace. Use this action when you need to retrieve all pages in a Power BI report that belongs to your personal workspace. This is useful for understanding the report structure, navigating between pages, or managing report content. Required Scope: Report.ReadWrite.All or Report.Read.AllInput Parameters
Output
Get Dataset Parameters
Get Dataset Parameters
Get Dataset Parameters in Workspace
Get Dataset Parameters in Workspace
MICROSOFT_POWER_BI_GET_PARAMETERS_IN_GROUP2Returns a list of parameters for the specified dataset from the specified workspace. Use this action when you need to retrieve all parameter definitions and their current values for a Power BI dataset within a specific workspace, including whether each parameter is required, its data type, and any suggested values. This is useful for auditing dataset configuration, understanding data source connections, or preparing to update parameter values in a workspace context. This API call can be called by a service principal profile with appropriate workspace permissions. Required Scope: Dataset.Read.All or Dataset.ReadWrite.AllInput Parameters
Output
Get Deployment Operation Details And Execution Plan
Get Deployment Operation Details And Execution Plan
MICROSOFT_POWER_BI_GET_PIPELINE_OPERATION_DETAILSGet deployment operation details and execution plan. Returns the details of the specified deploy operation performed on the specified deployment pipeline, including the deployment execution plan. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineOperation.Input Parameters
Output
Get Query Scale Out Sync Status
Get Query Scale Out Sync Status
MICROSOFT_POWER_BI_GET_QUERY_SCALE_OUT_SYNC_STATUS_2Returns the query scale-out sync status for the specified dataset from the specified workspace. Use this action when you need to check the synchronization status of read-only replicas for a dataset that supports query scale-out. This includes information about commit versions, active read timestamps, and the current sync status. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Refreshable For Capacity
Get Refreshable For Capacity
MICROSOFT_POWER_BI_GET_REFRESHABLE_CAPACITY_2Returns the specified refreshable for the specified capacity that the user has access to. Use this action when you need to retrieve details about a specific refreshable item (dataset) within a capacity, including refresh history, schedules, and status. Power BI retains a seven-day refresh history for each dataset, up to a maximum of sixty refreshes. Required Scope: Capacity.Read.All or Capacity.ReadWrite.AllInput Parameters
Output
Get refreshables for all capacities
Get refreshables for all capacities
MICROSOFT_POWER_BI_GET_REFRESHABLESReturns a list of refreshables for all capacities that the user has access to. Use when you need to retrieve information about datasets and dataflows that have refresh schedules or refresh history across all Power BI capacities. Power BI retains a seven-day refresh history for each dataset, up to a maximum of sixty refreshes. This action is useful for monitoring refresh performance, identifying failed refreshes, and auditing refresh schedules across the organization.Input Parameters
capacity and group.Output
Get Refresh Execution Details In Group
Get Refresh Execution Details In Group
MICROSOFT_POWER_BI_GET_REFRESH_EXECUTION_DETAILS_IN_GROUPReturns execution details of a refresh operation for the specified dataset from the specified workspace. Use this action when you need to retrieve detailed information about a dataset refresh operation within a workspace, including timing, status, errors, and any retry attempts. This is useful for monitoring refresh operations, troubleshooting failed refreshes, and auditing refresh history. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Refresh History for Dataset
Get Refresh History for Dataset
MICROSOFT_POWER_BI_GET_REFRESH_HISTORYReturns the refresh history for the specified dataset from My workspace. Use when you need to retrieve the refresh history of a specific Power BI dataset to monitor refresh performance, identify failed refreshes, or audit refresh operations. Power BI retains between 20-60 available refresh history entries depending on the number of refreshes in the last 3 days. The most recent 60 entries are kept if they are all less than 3 days old. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: OneDrive refresh history isn’t returned by this endpoint.Input Parameters
Output
Get Dataset Refresh Schedule
Get Dataset Refresh Schedule
MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULEReturns the refresh schedule for the specified dataset from My workspace. Use when you need to retrieve the current refresh schedule configuration for a dataset, including the days, times, and notification settings. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Refresh Schedule In Group 2
Get Refresh Schedule In Group 2
MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULE_IN_GROUP2Returns the refresh schedule for the specified dataset from the specified workspace. Use this action when you need to retrieve the current refresh schedule configuration for a dataset within a specific Power BI workspace, including the days, times, and notification settings. This action is read-only and idempotent. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: This API can be called by a service principal profile.Input Parameters
Output
Get Report from My Workspace
Get Report from My Workspace
MICROSOFT_POWER_BI_GET_REPORT3Returns the specified report from My workspace. Use this action when you need to retrieve details about a specific Power BI report from your personal workspace, including its metadata, embed URL, ownership information, and associated dataset. Required Scope: Report.ReadWrite.All or Report.Read.AllInput Parameters
Output
Get Report Page From My Workspace
Get Report Page From My Workspace
MICROSOFT_POWER_BI_GET_REPORT_PAGE2Returns the specified page within the specified report from My workspace. Use this action when you need to retrieve details about a specific page within a Power BI report in your personal workspace. This is useful for exploring report structure, getting page metadata, or identifying the order of pages in a report. Required Scope: Report.ReadWrite.All or Report.Read.AllInput Parameters
Output
Get Reports
Get Reports
Get Reports From My Workspace
Get Reports From My Workspace
MICROSOFT_POWER_BI_GET_REPORTS3Returns a list of reports from My workspace. Use this action when you need to retrieve all reports from your personal Power BI workspace. This also returns shared reports and reports from shared apps. This is useful for exploring your personal workspace contents, finding specific report IDs, or managing report resources. Required Scope: Report.ReadWrite.All or Report.Read.All Note: Service principal authentication isn’t supported.Output
Get Resources
Get Resources
Get Scorecard By ID
Get Scorecard By ID
MICROSOFT_POWER_BI_GET_SCORECARD_BY_IDRetrieves a Power BI scorecard by ID within a workspace, with optional OData expansion for related goals, goal values and aggregations. Requires Dataset.Read.All or Dataset.ReadWrite.All.Input Parameters
Output
Get Scorecards
Get Scorecards
MICROSOFT_POWER_BI_GET_SCORECARDSReturns a list of scorecards from a workspace. Use this action when you need to retrieve all scorecards within a Power BI workspace. This is useful for exploring workspace goals, finding specific scorecard IDs, or managing scorecard resources. Required Scope: Dataset.Read.All or Dataset.ReadWrite.AllInput Parameters
Output
Get Tables in Dataset
Get Tables in Dataset
MICROSOFT_POWER_BI_GET_TABLESReturns a list of tables within the specified dataset from My workspace. Use this action when you need to retrieve the schema, columns, measures, and other structural metadata of tables within a Power BI dataset. This is useful for understanding the data model, exploring available fields, or preparing to write DAX expressions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.AllInput Parameters
Output
Get Tables in Dataset within Workspace
Get Tables in Dataset within Workspace
MICROSOFT_POWER_BI_GET_TABLES_IN_GROUPReturns a list of tables within the specified dataset from the specified workspace. Use when you need to retrieve the schema, columns, measures, and other structural metadata of tables within a Power BI dataset in a specific workspace. This is useful for understanding the data model, exploring available fields, or preparing to write DAX expressions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: This API only supports push datasets.Input Parameters
Output
Get Tiles from My Workspace Dashboard
Get Tiles from My Workspace Dashboard
MICROSOFT_POWER_BI_GET_TILES2Returns a list of tiles within the specified dashboard from My workspace. Use this action when you need to retrieve all tiles (visualizations) from a specific dashboard in My workspace. Supported tiles include datasets and live tiles that contain an entire report page. This is useful for understanding what content exists in a dashboard or for enumerating dashboard elements. Required Scope: Dashboard.Read.All or Dashboard.ReadWrite.AllInput Parameters
Output
Get Tiles from Workspace Dashboard
Get Tiles from Workspace Dashboard
MICROSOFT_POWER_BI_GET_TILES3Returns a list of tiles within the specified dashboard from the specified workspace. Use this action when you need to retrieve all tiles (visualizations) from a specific dashboard within a Power BI workspace. Supported tiles include datasets and live tiles that contain an entire report page. This is useful for understanding what content exists in a dashboard or for enumerating dashboard elements. Required Scope: Dashboard.Read.All or Dashboard.ReadWrite.AllInput Parameters
Output
Get Workspace
Get Workspace
MICROSOFT_POWER_BI_GET_WORKSPACEReturns a specified workspace (group). Use this action when you need to retrieve details about a specific Power BI workspace, including its name, capacity configuration, storage settings, and Log Analytics workspace integration. Permissions: This API call can be called by a service principal profile. Required Scope: Workspace.Read.All or Workspace.ReadWrite.AllInput Parameters
Output
Get Workspace Metadata Scan Results
Get Workspace Metadata Scan Results
MICROSOFT_POWER_BI_GET_WORKSPACE_METADATA_SCAN_RESULTSGet workspace metadata scan results after GetScanStatus reports success. Results remain available for 24 hours. Requires a Fabric administrator or a service principal. Maximum 500 requests per hour. Delegated authentication requires Tenant.Read.All or Tenant.ReadWrite.All; service principals must not have admin-consent-required Power BI permissions configured in Azure. See https://learn.microsoft.com/en-us/rest/api/power-bi/admin/workspace-info-get-scan-result.Input Parameters
Output
Get Workspace Metadata Scan Status
Get Workspace Metadata Scan Status
MICROSOFT_POWER_BI_GET_WORKSPACE_METADATA_SCAN_STATUSGet workspace metadata scan status. Gets the scan status for the specified scan. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation WorkspaceInfo_GetScanStatus.Input Parameters
Output
Get Workspace Report Export Job Status
Get Workspace Report Export Job Status
MICROSOFT_POWER_BI_GET_WORKSPACE_REPORT_EXPORT_JOB_STATUSGet workspace report export job status. Returns the current status of the Export to File In Group job for the specified report from the specified workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetExportToFileStatusInGroup.Input Parameters
Output
Grant Deployment Pipeline Permissions
Grant Deployment Pipeline Permissions
MICROSOFT_POWER_BI_GRANT_DEPLOYMENT_PIPELINE_PERMISSIONSGrant deployment pipeline permissions. Grants user permissions to the specified deployment pipeline. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_UpdatePipelineUser.Input Parameters
Output
Grant Or Update Gateway Data Source User Permissions
Grant Or Update Gateway Data Source User Permissions
MICROSOFT_POWER_BI_GRANT_GATEWAY_DATASOURCE_PERMISSIONSGrant or update gateway data source user permissions. Grants or updates the permissions required to use the specified data source for the specified user. Requires gateway admin permissions. Virtual network (VNet) gateways and adding groups are not supported. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_AddDatasourceUser.Input Parameters
Output
Grant Workspace Permissions As Admin
Grant Workspace Permissions As Admin
MICROSOFT_POWER_BI_GRANT_WORKSPACE_PERMISSIONS_AS_ADMINGrant workspace permissions as admin. Grants user permissions to the specified workspace. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_AddUserAsAdmin.Input Parameters
Output
Grant Workspace Permissions To A User
Grant Workspace Permissions To A User
MICROSOFT_POWER_BI_GRANT_WORKSPACE_PERMISSIONS_TO_A_USERGrant workspace permissions to a user. Grants the specified user the specified permissions to the specified workspace. Required delegated scopes: Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_AddGroupUser.Input Parameters
Output
Import New Content Into A Workspace
Import New Content Into A Workspace
MICROSOFT_POWER_BI_IMPORT_NEW_CONTENT_INTO_A_WORKSPACEImport .pbix, .json, .xlsx or .rdl content into the specified workspace. Supply a platform file reference for multipart upload, or JSON importInfo for OneDrive for Business Excel / a pre-uploaded large PBIX temporary blob. This action resolves files through the platform adapter; ImportInfo URLs are sent to Power BI without fetching them. Large PBIX (1–10 GB) needs Premium capacity. Service principals cannot import dataflows or protected sensitivity labels; profiles can overwrite only semantic models they own. Returns an import ID (200/202); poll import status for completion. Required scope: Dataset.ReadWrite.All.Input Parameters
Output
Import New Content Into My Workspace
Import New Content Into My Workspace
MICROSOFT_POWER_BI_IMPORT_NEW_CONTENT_INTO_MY_WORKSPACEImport .pbix, .json, .xlsx or .rdl content into My workspace. Upload a platform file reference as multipart, or submit JSON ImportInfo for OneDrive for Business Excel / a pre-uploaded large PBIX temporary blob. ImportInfo URLs are sent to Power BI, never fetched; file references use the platform adapter. Large PBIX (1–10 GB) needs Premium capacity. Service principals cannot import dataflows or protected sensitivity labels. Returns an import ID (200/202); poll import status for completion. Required scope: Dataset.ReadWrite.All.Input Parameters
Output
List Accessible Dataflow Storage Accounts
List Accessible Dataflow Storage Accounts
MICROSOFT_POWER_BI_LIST_ACCESSIBLE_DATAFLOW_STORAGE_ACCOUNTSList accessible dataflow storage accounts. Returns a list of dataflow storage accounts that the user has access to. Required delegated scopes: StorageAccount.Read.All or StorageAccount.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation DataflowStorageAccounts_GetDataflowStorageAccounts.Output
List App Users As Admin
List App Users As Admin
MICROSOFT_POWER_BI_LIST_APP_USERS_AS_ADMINList app users as admin. Returns a list of users that have access to the specified app. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetAppUsersAsAdmin.Input Parameters
Output
List Available Features
List Available Features
MICROSOFT_POWER_BI_LIST_AVAILABLE_FEATURESList available features. Returns a list of available features for the user. This API call does not require any scopes and supports service principal profiles. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation AvailableFeatures_GetAvailableFeatures.Output
List Capacity Refreshables As Admin
List Capacity Refreshables As Admin
MICROSOFT_POWER_BI_LIST_CAPACITY_REFRESHABLES_AS_ADMINList capacity refreshables as admin. Returns a list of refreshables for the specified capacity that the user has access to. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetRefreshablesForCapacity.Input Parameters
capacities and groups.Output
List Capacity Users As Admin
List Capacity Users As Admin
MICROSOFT_POWER_BI_LIST_CAPACITY_USERS_AS_ADMINList users with access to the specified capacity. Requires a Fabric administrator for delegated authentication; delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent-required Power BI permissions configured in Azure. Maximum 200 requests per hour. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Capacities_GetCapacityUsersAsAdmin.Input Parameters
Output
List Dashboards From An App
List Dashboards From An App
MICROSOFT_POWER_BI_LIST_DASHBOARDS_FROM_AN_APPList dashboards from an app. Returns a list of dashboards from the specified app. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All. Service principal authentication isn’t supported. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetDashboards.Input Parameters
Output
List Dashboard Tiles As Admin
List Dashboard Tiles As Admin
MICROSOFT_POWER_BI_LIST_DASHBOARD_TILES_AS_ADMINReturns tiles within a specified dashboard as a Fabric administrator. Requires a Fabric administrator with delegated Tenant.Read.All or Tenant.ReadWrite.All, or service-principal authentication. For service principals, the app must not have admin-consent-required Power BI permissions configured in the Azure portal; delegated scopes do not apply. Limited to 200 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetTilesAsAdmin.Input Parameters
Output
List Dashboard Users As Admin
List Dashboard Users As Admin
MICROSOFT_POWER_BI_LIST_DASHBOARD_USERS_AS_ADMINList dashboard users as admin. Returns a list of users that have access to the specified dashboard. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetDashboardUsersAsAdmin.Input Parameters
Output
List Dataflow Data Sources
List Dataflow Data Sources
MICROSOFT_POWER_BI_LIST_DATAFLOW_DATA_SOURCESList dataflow data sources. Returns a list of data sources for the specified dataflow. Required delegated scopes: Dataflow.Read.All or Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowDataSources.Input Parameters
Output
List Dataflow Data Sources As Admin
List Dataflow Data Sources As Admin
MICROSOFT_POWER_BI_LIST_DATAFLOW_DATA_SOURCES_AS_ADMINReturns data sources for a dataflow, including deleted sources. Sources may include cloud and on-premises data gateways. Requires a Fabric administrator using delegated authentication, or a service principal. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent required Power BI permissions configured in the Azure portal. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowDatasourcesAsAdmin.Input Parameters
Output
List Dataflow Transactions
List Dataflow Transactions
MICROSOFT_POWER_BI_LIST_DATAFLOW_TRANSACTIONSList dataflow transactions. Returns a list of transactions for the specified dataflow. Required delegated scopes: Dataflow.Read.All or Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowTransactions.Input Parameters
Output
List Dataflow Users As Admin
List Dataflow Users As Admin
MICROSOFT_POWER_BI_LIST_DATAFLOW_USERS_AS_ADMINList dataflow users as admin. Returns a list of users that have access to the specified dataflow. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowUsersAsAdmin.Input Parameters
Output
List Dataset Data Sources As Admin
List Dataset Data Sources As Admin
MICROSOFT_POWER_BI_LIST_DATASET_DATA_SOURCES_AS_ADMINReturns the data sources for the specified dataset as an administrator. Requires a Fabric administrator or a service principal. Delegated admin tokens require Tenant.Read.All or Tenant.ReadWrite.All. Service-principal apps must not have admin-consent-required Power BI permissions configured in Azure. Limited to 300 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasourcesAsAdmin.Input Parameters
Output
List Datasets In A Workspace
List Datasets In A Workspace
MICROSOFT_POWER_BI_LIST_DATASETS_IN_A_WORKSPACEList datasets in a workspace. Returns a list of datasets from the specified workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetsInGroup.Input Parameters
Output
List Dataset To Dataflow Links As Admin
List Dataset To Dataflow Links As Admin
MICROSOFT_POWER_BI_LIST_DATASET_TO_DATAFLOW_LINKS_AS_ADMINList dataset-to-dataflow links as admin. Returns a list of upstream dataflows for datasets from the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetToDataflowsLinksInGroupAsAdmin.Input Parameters
Output
List Dataset Users As Admin
List Dataset Users As Admin
MICROSOFT_POWER_BI_LIST_DATASET_USERS_AS_ADMINReturn users that have access to the specified dataset. Requires a Fabric administrator or service principal. Delegated tokens need Tenant.Read.All or Tenant.ReadWrite.All. For service principal authentication, the app must not have admin-consent-required Power BI permissions configured. Limited to 200 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetUsersAsAdmin.Input Parameters
Output
List Deployment Pipelines
List Deployment Pipelines
List Deployment Pipeline Stage Artifacts
List Deployment Pipeline Stage Artifacts
MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINE_STAGE_ARTIFACTSList deployment pipeline stage artifacts. Returns the supported items from the workspace assigned to the specified stage of the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineStageArtifacts.Input Parameters
Output
List Deployment Pipeline Stages
List Deployment Pipeline Stages
MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINE_STAGESList deployment pipeline stages. Returns the stages of the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineStages.Input Parameters
Output
List Deployment Pipeline Users
List Deployment Pipeline Users
MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINE_USERSList deployment pipeline users. Returns a list of users that have access to the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineUsers.Input Parameters
Output
List Deployment Pipeline Users As Admin
List Deployment Pipeline Users As Admin
MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINE_USERS_AS_ADMINList users that have access to a specified deployment pipeline. Requires administrator rights or service-principal authentication. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All. Limited to 200 requests per hour. Provider documentation: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/pipelines-get-pipeline-users-as-adminInput Parameters
Output
List Gateway Data Sources
List Gateway Data Sources
MICROSOFT_POWER_BI_LIST_GATEWAY_DATA_SOURCESList gateway data sources. Returns a list of data sources from the specified gateway. Requires gateway admin permissions. Virtual network (VNet) gateways aren’t supported. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_GetDatasources.Input Parameters
Output
List Gateway Data Source Users
List Gateway Data Source Users
MICROSOFT_POWER_BI_LIST_GATEWAY_DATA_SOURCE_USERSList gateway data source users. Returns a list of users who have access to the specified data source. Requires gateway admin permissions. Virtual network (VNet) gateways aren’t supported. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_GetDatasourceUsers.Input Parameters
Output
List Installed Apps
List Installed Apps
List My Workspace Dashboards
List My Workspace Dashboards
MICROSOFT_POWER_BI_LIST_MY_WORKSPACE_DASHBOARDSList dashboards in the signed-in user’s My workspace, including shared dashboards and dashboards from shared apps. Use Get Dashboards for dashboards in a specified shared workspace. This action takes no parameters. Required scope: Dashboard.Read.All or Dashboard.ReadWrite.All.Output
List Organization Apps As Admin
List Organization Apps As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_APPS_AS_ADMINList organization apps as admin. Returns a list of apps in the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetAppsAsAdmin.Input Parameters
Output
List Organization Capacities As Admin
List Organization Capacities As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_CAPACITIES_AS_ADMINList organization capacities as admin. Returns a list of capacities for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetCapacitiesAsAdmin.Input Parameters
Output
List Organization Dashboards As Admin
List Organization Dashboards As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_DASHBOARDS_AS_ADMINList organization dashboards as admin. Returns a list of dashboards for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetDashboardsAsAdmin.Input Parameters
tiles.Output
List Organization Dataflows As Admin
List Organization Dataflows As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_DATAFLOWS_AS_ADMINList organization dataflows as admin. Returns a list of dataflows for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowsAsAdmin.Input Parameters
Output
List Organization Datasets As Admin
List Organization Datasets As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_DATASETS_AS_ADMINList organization datasets as admin. Returns a list of datasets for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetsAsAdmin.Input Parameters
Output
List Organization Imports As Admin
List Organization Imports As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_IMPORTS_AS_ADMINList organization imports as admin. Returns a list of imports for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Imports_GetImportsAsAdmin.Input Parameters
Output
List Organization Refreshables As Admin
List Organization Refreshables As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_REFRESHABLES_AS_ADMINList organization refreshables as admin. Returns a list of refreshables for the organization within a capacity. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetRefreshables.Input Parameters
capacities and groups.Output
List Organization Reports As Admin
List Organization Reports As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_REPORTS_AS_ADMINList reports across the organization, optionally filtered and paginated. Requires a Fabric administrator or service principal. Delegated tokens require Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent-required Power BI permissions configured in Azure. Limited to 50 requests per hour or 5 requests per minute per tenant. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetReportsAsAdmin.Input Parameters
Output
List Organization Workspaces As Admin
List Organization Workspaces As Admin
MICROSOFT_POWER_BI_LIST_ORGANIZATION_WORKSPACES_AS_ADMINList organization workspaces as admin. Returns a list of workspaces for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_GetGroupsAsAdmin.Input Parameters
users, reports, dashboards, datasets, dataflows, and workbooks.Output
List Recent Deployment Pipeline Operations
List Recent Deployment Pipeline Operations
MICROSOFT_POWER_BI_LIST_PIPELINE_OPERATIONSList recent deployment pipeline operations. Returns a list of the up-to-20 most recent deploy operations performed on the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineOperations.Input Parameters
Output
List Power Bi Items Accessible By A User
List Power Bi Items Accessible By A User
MICROSOFT_POWER_BI_LIST_POWER_BI_ITEMS_ACCESSIBLE_BY_A_USERList Power BI items accessible by a user. Returns a list of Power BI items (such as reports or dashboards) that the specified user has access to. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Users_GetUserArtifactAccessAsAdmin.Input Parameters
Output
List Power Bi Items Published To The Web
List Power Bi Items Published To The Web
MICROSOFT_POWER_BI_LIST_POWER_BI_ITEMS_PUBLISHED_TO_THE_WEBList Power BI items published to the web. Returns a list of Power BI items (such as reports or dashboards) that are published to the web. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation WidelySharedArtifacts_PublishedToWeb.Input Parameters
Output
List Refreshables For A Capacity
List Refreshables For A Capacity
MICROSOFT_POWER_BI_LIST_REFRESHABLES_FOR_A_CAPACITYList refreshables for a capacity. Returns a list of refreshables for the specified capacity that the user has access to. Required delegated scopes: Capacity.Read.All or Capacity.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Capacities_GetRefreshablesForCapacity.Input Parameters
capacities and groups.Output
List Reports In A Workspace
List Reports In A Workspace
MICROSOFT_POWER_BI_LIST_REPORTS_IN_A_WORKSPACEList reports in a workspace. Returns a list of reports from the specified workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetReportsInGroup.Input Parameters
Output
List Report Users As Admin
List Report Users As Admin
MICROSOFT_POWER_BI_LIST_REPORT_USERS_AS_ADMINList users that have access to the specified report. Requires a Fabric administrator or service principal. For delegated admin access, requires Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent-required Power BI permissions configured in Azure. Maximum 200 requests per hour. https://learn.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-report-users-as-adminInput Parameters
Output
List Service Principal Profiles
List Service Principal Profiles
MICROSOFT_POWER_BI_LIST_SERVICE_PRINCIPAL_PROFILESList service-principal profiles belonging to the calling service principal. Can only be called by a service principal. Required delegated scopes: No delegated scope declared; see provider authentication requirements. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_GetProfiles.Input Parameters
Output
List Tenant Audit Activity Events
List Tenant Audit Activity Events
MICROSOFT_POWER_BI_LIST_TENANT_AUDIT_ACTIVITY_EVENTSList one page of audit activity events for a tenant. Provide a continuation token or both single-quoted start and end UTC timestamps in the same day within the last 28 days. Use the returned continuationToken to retrieve subsequent pages. Requires a Fabric administrator or an authorized service principal. Maximum 200 requests per hour; Microsoft Cloud Deutschland is unsupported. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All. These scopes apply only to delegated admin tokens; service principals must not have admin-consent-required Power BI permissions configured in Azure. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetActivityEvents.Input Parameters
Output
List Tenant Encryption Keys
List Tenant Encryption Keys
MICROSOFT_POWER_BI_LIST_TENANT_ENCRYPTION_KEYSList the tenant’s encryption key metadata. Requires a Fabric administrator with delegated Tenant.Read.All or Tenant.ReadWrite.All, or service-principal authentication. A service-principal app must not have admin-consent-required Power BI permissions configured in Azure. Limited to 200 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetPowerBIEncryptionKeys.Output
List Tiles From An App Dashboard
List Tiles From An App Dashboard
MICROSOFT_POWER_BI_LIST_TILES_FROM_AN_APP_DASHBOARDList tiles from an app dashboard. Returns a list of tiles within the specified dashboard from the specified app. Service principal authentication isn’t supported. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetTiles.Input Parameters
Output
List Upstream Dataflows
List Upstream Dataflows
MICROSOFT_POWER_BI_LIST_UPSTREAM_DATAFLOWSList upstream dataflows. Returns a list of upstream dataflows for the specified dataflow. Required delegated scopes: Dataflow.Read.All or Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetUpstreamDataflowsInGroup.Input Parameters
Output
List Upstream Dataflows As Admin
List Upstream Dataflows As Admin
MICROSOFT_POWER_BI_LIST_UPSTREAM_DATAFLOWS_AS_ADMINList upstream dataflows as admin. Returns a list of upstream dataflows for the specified dataflow. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetUpstreamDataflowsInGroupAsAdmin.Input Parameters
Output
List Workspace Dashboards As Admin
List Workspace Dashboards As Admin
MICROSOFT_POWER_BI_LIST_WORKSPACE_DASHBOARDS_AS_ADMINList workspace dashboards as admin. Returns a list of dashboards from the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetDashboardsInGroupAsAdmin.Input Parameters
Output
List Workspace Dataflows As Admin
List Workspace Dataflows As Admin
MICROSOFT_POWER_BI_LIST_WORKSPACE_DATAFLOWS_AS_ADMINReturn dataflows from the specified workspace as a Fabric administrator or service principal. Supports OData filtering and top/skip pagination. Maximum 200 requests per hour. Delegated authentication requires Tenant.Read.All or Tenant.ReadWrite.All. Service principals must not have admin-consent-required Power BI permissions configured in Azure; delegated scopes do not apply to them. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowsInGroupAsAdmin.Input Parameters
Output
List Workspace Datasets As Admin
List Workspace Datasets As Admin
MICROSOFT_POWER_BI_LIST_WORKSPACE_DATASETS_AS_ADMINList workspace datasets as admin. Returns a list of datasets from the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetsInGroupAsAdmin.Input Parameters
Output
List Workspace Reports As Admin
List Workspace Reports As Admin
MICROSOFT_POWER_BI_LIST_WORKSPACE_REPORTS_AS_ADMINList workspace reports as admin. Returns a list of reports from the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetReportsInGroupAsAdmin.Input Parameters
Output
List Workspace Users As Admin
List Workspace Users As Admin
MICROSOFT_POWER_BI_LIST_WORKSPACE_USERS_AS_ADMINList workspace users as admin. Returns a list of users that have access to the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_GetGroupUsersAsAdmin.Input Parameters
Output
Trigger Query Scale Out Sync in Workspace
Trigger Query Scale Out Sync in Workspace
MICROSOFT_POWER_BI_MICROSOFT_POWER_BI_DATASETS_TRIGGER_QUERY_SCALE_OUT_SYNC_IN_GROUPTriggers a query scale-out sync of read-only replicas for the specified dataset from the specified workspace. Use this action when you need to manually synchronize read-only replicas for a dataset in a specific Power BI workspace. This is typically used for maintenance or to ensure all replicas are synchronized before performing administrative operations. The sync operation ensures that read-only replicas have the latest data from the primary dataset. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Move Power BI Scorecard Goals
Move Power BI Scorecard Goals
MICROSOFT_POWER_BI_MOVE_GOALSMoves goals within the scorecard. Changes their ranks and parents. Use when you need to reorganize the goal hierarchy in a Power BI scorecard, such as reordering goals within the same parent, moving a goal to a different parent, or repositioning a goal among its siblings. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Add Rows To A Push Dataset Table In My Workspace
Add Rows To A Push Dataset Table In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_ADD_DATASET_ROWSAdd rows to a push dataset table in My workspace. Adds new data rows to the specified table within the specified dataset from My workspace. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_PostRows.Input Parameters
Output
Bind A Dataset In My Workspace To A Gateway
Bind A Dataset In My Workspace To A Gateway
MICROSOFT_POWER_BI_MY_WORKSPACE_BIND_DATASET_TO_GATEWAYBind a dataset in My workspace to a gateway. Binds the specified dataset from My workspace to the specified gateway, optionally with a given set of data source IDs. If you don’t supply a specific data source ID, the dataset will be bound to the first matching data source in the gateway. Only supports the on-premises data gateway. Add the API caller principal as a data source user on the gateway before calling. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_BindToGateway.Input Parameters
Output
Bind A Paginated Report Data Source In My Workspace To A Gateway
Bind A Paginated Report Data Source In My Workspace To A Gateway
MICROSOFT_POWER_BI_MY_WORKSPACE_BIND_RDL_REPORT_TO_GATEWAYBind a paginated report data source in My workspace to a gateway. Binds the specified data source of the paginated report from My workspace to the specified gateway, optionally with a given data source ID. If you don’t supply a specific data source ID, the data source will be bound to the first matching data source in the gateway. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_BindToGateway.Input Parameters
Output
Discover Gateways For A Dataset In My Workspace
Discover Gateways For A Dataset In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_DISCOVER_DATASET_GATEWAYSDiscover gateways for a dataset in My workspace. Returns a list of gateways that the specified dataset from My workspace can be bound to. Only relevant to datasets with at least one on-premises connection; cloud-only datasets return an empty list. Required delegated scopes: Dataset.Read.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_DiscoverGateways.Input Parameters
Output
Download An Exported Report File In My Workspace
Download An Exported Report File In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_DOWNLOAD_REPORT_EXPORTRetrieve the completed export-job file for a report in My workspace as a platform-managed downloadable file reference, with content metadata. Poll export status until Succeeded before downloading. Required delegated scope: Report.Read.All or Report.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/reports/get-file-of-export-to-fileInput Parameters
Output
Export A Report In My Workspace As Pbix Or Rdl
Export A Report In My Workspace As Pbix Or Rdl
MICROSOFT_POWER_BI_MY_WORKSPACE_EXPORT_REPORT_SOURCEExport a report from My workspace as a downloadable PBIX or RDL file reference. Requires Report.ReadWrite.All or both Report.Read.All and Dataset.Read.All. PBIX export is unsupported after rebinding a report with a Power BI service live connection. Large exports may contain a temporary blob URL in the file; this action stores the downloaded file without following that URL. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_ExportReport.Input Parameters
Output
Get Dataset Refresh Execution Details In My Workspace
Get Dataset Refresh Execution Details In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_GET_DATASET_REFRESH_DETAILSGet dataset refresh execution details in My workspace. Returns execution details of a refresh operation for the specified dataset from My workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetRefreshExecutionDetails.Input Parameters
Output
Get A Direct Query Refresh Schedule In My Workspace
Get A Direct Query Refresh Schedule In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_GET_DIRECT_QUERY_SCHEDULEGet a DirectQuery refresh schedule in My workspace. Returns the refresh schedule for a specified DirectQuery or LiveConnection dataset from My workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDirectQueryRefreshSchedule.Input Parameters
Output
Get Report Export Job Status In My Workspace
Get Report Export Job Status In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_GET_REPORT_EXPORT_STATUSGet report export job status in My workspace. Returns the current status of the Export to File job for the specified report from My workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetExportToFileStatus.Input Parameters
Output
Get Dataset Query Scale Out Synchronization Status In My Workspace
Get Dataset Query Scale Out Synchronization Status In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_GET_SCALEOUT_SYNC_STATUSGet dataset query scale-out synchronization status in My workspace. Returns the query scale-out sync status for the specified dataset from My workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetQueryScaleOutSyncStatus.Input Parameters
Output
List Paginated Report Data Sources In My Workspace
List Paginated Report Data Sources In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_LIST_RDL_REPORT_DATASOURCESList paginated report data sources in My workspace. Returns a list of data sources for the specified paginated report (RDL) from My workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetDatasources.Input Parameters
Output
Rebind A Report In My Workspace To A Dataset
Rebind A Report In My Workspace To A Dataset
MICROSOFT_POWER_BI_MY_WORKSPACE_REBIND_REPORT_DATASETRebind a report in My workspace to a dataset. A target dataset in another workspace creates a shared dataset in My workspace. A live-connected report loses its live connection and receives a direct dataset binding. Requires Write on the report and Build on the target dataset. This does not copy or refresh the report. Required scope: Report.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/reports/rebind-reportInput Parameters
Output
Start A Report File Export In My Workspace
Start A Report File Export In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_START_REPORT_FILE_EXPORTStart an asynchronous file export of a report from My workspace. Returns the accepted export job, not the exported file. Use the export job ID with GetExportToFileStatus to track completion before retrieving the file. Required delegated scopes: (Report.Read.All or Report.ReadWrite.All) AND (Dataset.Read.All or Dataset.ReadWrite.All). Supported formats and limitations depend on whether the report is a Power BI report or a paginated report. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_ExportToFile.Input Parameters
Output
Update Dataset Data Sources In My Workspace
Update Dataset Data Sources In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_UPDATE_DATASET_DATASOURCESUpdate data source connections for a dataset in My workspace as its owner. Original and replacement sources must have the same schema and source type. Supports SQL Server, Azure SQL Server, Azure Analysis Services, Azure Synapse, OData, SharePoint, Teradata, and SAP HANA. XMLA-created/modified datasets and connection strings containing parameters are unsupported. With enhanced dataset metadata, refresh after updating; otherwise wait 30 minutes before refreshing. This operation does not itself refresh the dataset. Required delegated scope: Dataset.ReadWrite.All. Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/update-datasourcesInput Parameters
Output
Update An Existing Users Dataset Permissions In My Workspace
Update An Existing Users Dataset Permissions In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_UPDATE_DATASET_PERMISSIONSUpdate existing direct dataset permissions in My workspace; App principals are unsupported. Cannot add or remove write permission or remove inherited workspace permissions. Set datasetUserAccessRight to None to revoke direct access. Caller needs ReadWriteReshare permission. Permission propagation may require Refresh User Permissions. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/put-dataset-userInput Parameters
Output
Update A Direct Query Refresh Schedule In My Workspace
Update A Direct Query Refresh Schedule In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_UPDATE_DIRECT_QUERY_SCHEDULEUpdate a DirectQuery or LiveConnection dataset’s refresh schedule in My workspace. The caller must own the dataset. Supply either days and times or a frequency, not both. Days without times use a default single time per day; setting a frequency overwrites the days and times setting. Supported frequency values are 15, 30, 60, 120, and 180 minutes. Required delegated scope: Dataset.ReadWrite.All. Provider documentation: https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/update-direct-query-refresh-scheduleInput Parameters
Output
Update Paginated Report Data Sources In My Workspace
Update Paginated Report Data Sources In My Workspace
MICROSOFT_POWER_BI_MY_WORKSPACE_UPDATE_RDL_DATASOURCESUpdate paginated report data sources in My workspace. Updates the data sources of the specified paginated report (RDL) from My workspace. Required delegated scope: Report.ReadWrite.All. The caller must own the data source; replacement sources must preserve schema and source type. Service-principal authentication does not support My workspace. Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/update-datasources.Input Parameters
Output
Patch Goal Note
Patch Goal Note
MICROSOFT_POWER_BI_PATCH_GOAL_NOTEUpdates a goal value check-in note by ID. Use this action when you need to update the content of an existing goal check-in note in Power BI goals. This action modifies the note body while preserving other note metadata like timestamps and IDs. This is useful for correcting errors, adding additional context, or updating progress notes on goals. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Patch Goal Value By ID
Patch Goal Value By ID
MICROSOFT_POWER_BI_PATCH_GOAL_VALUE_BY_IDUpdates a goal value check-in by a UTC date timestamp. Use this action when you need to update the value, status, target, or other properties of a specific goal value check-in within a Power BI scorecard. This allows you to record progress updates for goals at specific timestamps. Requires the Dataset.ReadWrite.All scope. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Patch Scorecard By ID
Patch Scorecard By ID
MICROSOFT_POWER_BI_PATCH_SCORECARD_BY_IDUpdates a scorecard by its ID. Use this action when you need to modify properties of an existing Power BI scorecard, such as updating its name, description, permissions, or associated settings. This action requires the Dataset.ReadWrite.All scope. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Create Push Dataset in Workspace
Create Push Dataset in Workspace
MICROSOFT_POWER_BI_POST_DATASET_IN_GROUPCreates a new push dataset in the specified Power BI workspace. Use this action when you need to create a new push dataset in a specific workspace to store and manage data that can be pushed programmatically via the Power BI REST API. This API call only supports push datasets (Push, Streaming, or PushStreaming mode). This action is irreversible once the dataset is created. The dataset name must be unique within the workspace.Input Parameters
Output
Grant Dataset User Permissions
Grant Dataset User Permissions
MICROSOFT_POWER_BI_POST_DATASET_USERGrants the specified user’s permissions to the specified dataset. Use this action when you need to assign access rights to a Power BI dataset for a specific user, group, or app. This is useful for managing dataset permissions and controlling who can access or interact with the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available.Input Parameters
Output
Grant Dataset User Permissions In Group
Grant Dataset User Permissions In Group
MICROSOFT_POWER_BI_POST_DATASET_USER_IN_GROUPGrants the specified user’s permissions to the specified dataset in a workspace. Use this action when you need to assign access rights to a Power BI dataset for a specific user, group, or app within a workspace context. This is useful for managing dataset permissions and controlling who can access or interact with the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Post Goal
Post Goal
MICROSOFT_POWER_BI_POST_GOALAdds a new goal to a Power BI scorecard. Use this action when you need to create a new goal within an existing scorecard to track objectives, KPIs, or other metrics. Goals can be organized in a parent-child hierarchy and support various formatting options for dates and values. Requires the Dataset.ReadWrite.All scope. Note: The goal will be created with default values that may need to be updated via additional API calls for detailed configuration.Input Parameters
Output
Post Goal Note
Post Goal Note
MICROSOFT_POWER_BI_POST_GOAL_NOTEAdds a new note to a goal value check-in for a Power BI scorecard goal. Use this action when you need to add a note or comment to a specific goal value check-in within a Power BI scorecard. This allows you to provide additional context or explanations for goal progress updates. The timestamp parameter identifies the specific goal value check-in to attach the note to. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Add Rows to Dataset Table in Workspace
Add Rows to Dataset Table in Workspace
MICROSOFT_POWER_BI_POST_ROWS_IN_GROUPAdds data rows to a table in a Power BI push dataset within a workspace. Repeated submissions may add duplicate rows; requires the Dataset.ReadWrite.All scope.Input Parameters
Output
Post Goal Status Rules
Post Goal Status Rules
MICROSOFT_POWER_BI_POST_STATUS_RULESCreates or updates status rules of a goal in Power BI. Use this action when you need to define custom status rules that automatically set a goal’s status based on conditions such as current value, threshold comparisons, or state values. The defaultOutput is used when no rule conditions are met. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Update Table Schema
Update Table Schema
MICROSOFT_POWER_BI_PUT_TABLEUpdates the metadata and schema for the specified table within the specified dataset from My workspace. Use this action when you need to modify the schema or metadata of an existing table in a Power BI push dataset. This includes updating columns, adding measures, or changing table properties. The table must already exist in the dataset. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Update Table Schema in Workspace
Update Table Schema in Workspace
MICROSOFT_POWER_BI_PUT_TABLE_IN_GROUPUpdates the metadata and schema for the specified table within the specified dataset from the specified workspace. Use this action when you need to modify the schema or metadata of an existing table in a Power BI push dataset within a workspace. This includes updating columns, adding measures, or changing table properties. The table must already exist in the dataset. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Rebind Report to Dataset
Rebind Report to Dataset
MICROSOFT_POWER_BI_REBIND_REPORTRebinds a Power BI report in a specified workspace to another dataset, changing the data source used by the report. If the dataset is in a different workspace, a shared dataset is created in the report’s workspace. Requires Report.ReadWrite.All.Input Parameters
Output
Refresh A Dataflow
Refresh A Dataflow
MICROSOFT_POWER_BI_REFRESH_A_DATAFLOWRefresh a dataflow. Triggers a refresh for the specified dataflow. Supported notification options are MailOnFailure and NoNotification; MailOnCompletion is unsupported. A successful response acknowledges the refresh request, not refresh completion. Required delegated scopes: Dataflow.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/dataflows/refresh-dataflow.Input Parameters
Output
Refresh A Dataset In My Workspace
Refresh A Dataset In My Workspace
MICROSOFT_POWER_BI_REFRESH_A_DATASET_IN_MY_WORKSPACERefresh a dataset in My workspace. Triggers a refresh for the specified dataset from My workspace. An enhanced refresh is triggered only if a request payload other than notifyOption is set. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_RefreshDataset.Input Parameters
Output
Trigger Dataset Refresh in Workspace
Trigger Dataset Refresh in Workspace
MICROSOFT_POWER_BI_REFRESH_DATASET_IN_GROUPTriggers a refresh for the specified dataset from the specified workspace. Use this action when you need to manually trigger a dataset refresh in a Power BI workspace. An enhanced refresh is triggered only if a request payload other than notifyOption is set (e.g., when specifying specific tables, commit mode, or timeout). Note: This action is asynchronous - it initiates the refresh and returns immediately. Use GetRefreshHistory or GetRefreshExecutionDetails to monitor the refresh status. Required Scope: Dataset.ReadWrite.All This action is not destructive - it initiates a refresh operation that can be monitored and cancelled if needed.Input Parameters
Output
Refresh User Permissions In Power Bi
Refresh User Permissions In Power Bi
MICROSOFT_POWER_BI_REFRESH_USER_PERMISSIONS_IN_POWER_BIRefresh user permissions after access to a workspace, app, or item changes. Call before other Power BI API calls, then wait about two minutes for the refreshed permissions to become available. Limited to one call per user per hour. Supports service principal profiles. Returns an empty success response; it does not wait for permission propagation. Required delegated scopes: Workspace.Read.All or Workspace.ReadWrite.All. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Users_RefreshUserPermissions.Output
Remove A Gateway Data Source User
Remove A Gateway Data Source User
MICROSOFT_POWER_BI_REMOVE_A_GATEWAY_DATA_SOURCE_USERRemove a gateway data source user. Removes the specified user from the specified data source. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_DeleteDatasourceUser.Input Parameters
Output
Remove A Users Workspace Permissions
Remove A Users Workspace Permissions
MICROSOFT_POWER_BI_REMOVE_A_USERS_WORKSPACE_PERMISSIONSRemove a user’s workspace permissions. Deletes the specified user permissions from the specified workspace. Required delegated scopes: Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_DeleteUserInGroup.Input Parameters
Output
Remove Workspace Permissions As Admin
Remove Workspace Permissions As Admin
MICROSOFT_POWER_BI_REMOVE_WORKSPACE_PERMISSIONS_AS_ADMINRemove workspace permissions as admin. Removes user, security group, M365 group, or service principal permissions from the specified workspace. The caller must be a Fabric administrator. Maximum 200 requests per hour. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_DeleteUserAsAdmin.Input Parameters
Output
Generate Report Embed Token for Create in Group
Generate Report Embed Token for Create in Group
MICROSOFT_POWER_BI_REPORTS_GENERATE_TOKEN_CREATE_IN_GROUPGenerates an embed token to allow report creation in the specified workspace based on the specified dataset. Use this action when you need to generate an embed token to create a new Power BI report within a specific workspace. The token is based on a dataset and allows programmatic report creation through the Power BI API. You can configure row-level security (RLS) by providing identities, and customize the token lifetime. Required Scope: Report.ReadWrite.All or Report.Read.AllInput Parameters
false. Only applies when you generate an embed token for report embedding.Output
Restore A Deleted Workspace
Restore A Deleted Workspace
MICROSOFT_POWER_BI_RESTORE_A_DELETED_WORKSPACERestore a deleted workspace with the specified owner and optional name. The caller must be a Fabric administrator. Maximum 200 requests per hour. Required delegated scope: Tenant.ReadWrite.All. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_RestoreDeletedGroupAsAdmin.Input Parameters
Output
Rotate A Tenant Encryption Key
Rotate A Tenant Encryption Key
MICROSOFT_POWER_BI_ROTATE_A_TENANT_ENCRYPTION_KEYRotate a tenant encryption key. Rotate the encryption key for Power BI workspaces assigned to a capacity. Requires a Fabric administrator. Limited to 600 requests per hour. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_RotatePowerBIEncryptionKey.Input Parameters
Output
Create Or Update A Dataflow Refresh Schedule
Create Or Update A Dataflow Refresh Schedule
MICROSOFT_POWER_BI_SET_DATAFLOW_REFRESH_SCHEDULECreate or update a dataflow refresh schedule. Creates or updates the refresh schedule for a specified dataflow. Required delegated scopes: Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_UpdateRefreshSchedule.Input Parameters
Output
Set Linked Report Cache Options
Set Linked Report Cache Options
MICROSOFT_POWER_BI_SET_LINKED_REPORT_CACHE_OPTIONSReplaces the CacheOption’s content for a given LinkedReport using the provided definition. Use this action when you need to configure or update the cache settings for a Power BI linked report. This includes setting the execution type (Live, Cache, or Snapshot) and optionally configuring cache expiration. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Report.ReadWrite.AllInput Parameters
Output
Set Sensitivity Labels On Power Bi Items
Set Sensitivity Labels On Power Bi Items
MICROSOFT_POWER_BI_SET_SENSITIVITY_LABELS_ON_POWER_BI_ITEMSSet sensitivity labels on Power BI items by item ID. Requires a Fabric administrator and delegated scope Tenant.ReadWrite.All. The administrator and delegated user (if supplied) need sufficient label usage rights, and the label must be included in their label policy. Updates at most 2,000 items per request, with a limit of 25 requests per hour. Inspect each item’s returned status: HTTP success does not mean every label was set. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation InformationProtection_SetLabelsAsAdmin.Input Parameters
Output
Start A Report File Export In A Workspace
Start A Report File Export In A Workspace
MICROSOFT_POWER_BI_START_A_REPORT_FILE_EXPORT_IN_A_WORKSPACEStart an asynchronous report file export in a workspace. Returns the accepted export job, not the exported file. Poll the workspace report export status using the returned export ID, then retrieve the file when the job succeeds. Supports service principal profiles. Required delegated scopes: (Report.Read.All or Report.ReadWrite.All) AND (Dataset.Read.All or Dataset.ReadWrite.All). Provider permissions and export limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/export-to-file-in-groupInput Parameters
Output
Start A Workspace Metadata Scan
Start A Workspace Metadata Scan
MICROSOFT_POWER_BI_START_A_WORKSPACE_METADATA_SCANStart an asynchronous metadata scan for 1–100 workspace IDs. Poll scan status with the returned scan ID, then retrieve scan results after success; acceptance is not scan completion. Requires a Fabric administrator or an authorized service principal. Required delegated scope: Tenant.Read.All or Tenant.ReadWrite.All; delegated scopes do not apply to service-principal authentication. https://learn.microsoft.com/en-us/rest/api/power-bi/admin/workspace-info-post-workspace-infoInput Parameters
true, you must fully enable metadata scanning in order for data to be returned. For more information, see Enable tenant settings for metadata scanning.true, you must fully enable metadata scanning in order for data to be returned. For more information, see Enable tenant settings for metadata scanning.Output
Take Over Dataset
Take Over Dataset
MICROSOFT_POWER_BI_TAKE_OVER_DATASETTransfers ownership over the specified dataset to the current authorized user. Use this action when you need to take over ownership of a dataset in a Power BI workspace. This is useful when the original owner has left the organization or is unavailable, and another user needs to manage the dataset. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Take Over Paginated Report Ownership
Take Over Paginated Report Ownership
MICROSOFT_POWER_BI_TAKE_OVER_REPORT_IN_GROUPTransfers ownership of the data sources for the specified paginated report (RDL) to the current authorized user. Use this action when you need to take ownership of a paginated report’s data sources in a Power BI workspace. This is useful when the previous owner is no longer available or you need administrative control over the report’s data connections. This operation affects all data sources associated with the report. Required Scope: Report.ReadWrite.AllInput Parameters
Output
Trigger Query Scale Out Sync
Trigger Query Scale Out Sync
MICROSOFT_POWER_BI_TRIGGER_QUERY_SCALE_OUT_SYNCTriggers a query scale-out sync of read-only replicas for the specified dataset from My workspace. Use this action when you need to manually synchronize read-only replicas for a dataset that supports query scale-out. This is typically used for maintenance or to ensure all replicas are synchronized before performing administrative operations. The sync operation ensures that read-only replicas have the latest data from the primary dataset. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Unassign A Workspace From A Deployment Pipeline Stage
Unassign A Workspace From A Deployment Pipeline Stage
MICROSOFT_POWER_BI_UNASSIGN_WORKSPACE_FROM_PIPELINE_STAGEUnassign a workspace from a deployment pipeline stage. Unassigns the workspace from the specified stage in the specified deployment pipeline. Fails if there is an active deployment operation. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_UnassignWorkspace.Input Parameters
Output
Update A Deployment Pipeline
Update A Deployment Pipeline
MICROSOFT_POWER_BI_UPDATE_A_DEPLOYMENT_PIPELINEUpdate a deployment pipeline. Updates the specified deployment pipeline. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_UpdatePipeline.Input Parameters
Output
Update A Service Principal Profile Name
Update A Service Principal Profile Name
MICROSOFT_POWER_BI_UPDATE_A_SERVICE_PRINCIPAL_PROFILE_NAMEUpdate the name of a profile owned by the calling service principal. Can only be called by a service principal. Provider documentation: https://learn.microsoft.com/en-us/rest/api/power-bi/profiles/update-profile.Input Parameters
Output
Update A Users Workspace Permissions
Update A Users Workspace Permissions
MICROSOFT_POWER_BI_UPDATE_A_USERS_WORKSPACE_PERMISSIONSUpdate a user’s workspace permissions. Updates the specified user permissions to the specified workspace. Required delegated scopes: Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_UpdateGroupUser.Input Parameters
Output
Enable Or Disable A Capacity Workload And Set Its Memory Limit
Enable Or Disable A Capacity Workload And Set Its Memory Limit
MICROSOFT_POWER_BI_UPDATE_CAPACITY_WORKLOADEnable or disable a capacity workload and set its memory limit. Changes the state of a specific workload to Enabled or Disabled. When enabling a workload, specify the percentage of maximum memory that the workload can consume. Workload APIs are not relevant for Gen2 capacities. Unsupported is a read-only workload state and cannot be set by this operation. Required delegated scopes: Capacity.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/patch-workload.Input Parameters
Output
Update Dataflow Properties Capabilities And Settings
Update Dataflow Properties Capabilities And Settings
MICROSOFT_POWER_BI_UPDATE_DATAFLOW_SETTINGSUpdate dataflow properties, capabilities, and settings. Updates dataflow properties, capabilities and settings. Required delegated scopes: Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_UpdateDataflow.Input Parameters
Output
Update Dataset
Update Dataset
MICROSOFT_POWER_BI_UPDATE_DATASETUpdates the properties for the specified dataset from My workspace. Use this action when you need to modify dataset settings such as query scale-out configuration or storage mode. The user must be the dataset owner to perform this operation. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Update Dataset In Workspace
Update Dataset In Workspace
MICROSOFT_POWER_BI_UPDATE_DATASET_IN_GROUPUpdates the properties for the specified dataset from the specified workspace. Use this action when you need to modify dataset settings in a workspace, such as configuring query scale-out settings or changing the storage mode. The user must be the dataset owner to perform this operation. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Update Dataset Parameters In My Workspace
Update Dataset Parameters In My Workspace
MICROSOFT_POWER_BI_UPDATE_DATASET_PARAMETERS_IN_MY_WORKSPACEUpdate parameter values for a dataset in My workspace as its owner. With enhanced metadata refresh afterward to apply the values; otherwise wait 30 minutes, then refresh. This call does not refresh data. Supply at most 100 existing, case-sensitive, nonduplicate parameters of the expected type; Any/Binary parameters and XMLA-created/modified datasets are unsupported. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/update-parametersInput Parameters
Output
Update Paginated Report Data Sources
Update Paginated Report Data Sources
MICROSOFT_POWER_BI_UPDATE_DATASOURCES3Updates the data sources of the specified paginated report (RDL) from the specified workspace. Use this action when you need to update the connection details (server, database) for one or more data sources in a Power BI paginated report within a specific workspace. This is useful for migrating paginated reports between environments (e.g., from development to production) or updating connection strings without republishing the report. [!IMPORTANT] Both the original data source and the new data source must have the exact same schema. Important notes: - Only supports paginated reports (RDL). - Both the original and new data sources must have the exact same schema. - Changing the data source type is not supported. - Open Database Connectivity (ODBC) data sources are not supported. - The user must be the data source owner. Required scope: Reports.ReadWrite.AllInput Parameters
Output
Update Gateway Data Source Credentials
Update Gateway Data Source Credentials
MICROSOFT_POWER_BI_UPDATE_GATEWAY_DATA_SOURCE_CREDENTIALSReplace data source credentials. On-premises gateways require gateway-admin permission and RSA-OAEP credentials encrypted with the gateway public key; cloud sources require source ownership and JSON-encoded credentialData. When leaving SSO, set useEndUserOAuth2Credentials=false. Supplied OAuth tokens have no automatic refresh and typically last one hour; Extension sources cannot use useCallerAADIdentity=true. VNet gateways are unsupported; SAS is limited to AzureBlobStorage/AzureDataLakeStorage. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/update-datasourceInput Parameters
Output
Patch Goal By ID
Patch Goal By ID
MICROSOFT_POWER_BI_UPDATE_GOAL_BY_IDUpdates a goal by its ID within a Power BI scorecard. Use this action when you need to modify properties of an existing goal in a Power BI scorecard, such as updating its name, description, dates, permissions, or associated settings. This action requires the Dataset.ReadWrite.All scope. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Update Dataset Parameters in Workspace
Update Dataset Parameters in Workspace
MICROSOFT_POWER_BI_UPDATE_PARAMETERS_IN_GROUP2Updates the parameters values for the specified dataset from the specified workspace. Use this action when you need to change one or more parameter values in a Power BI dataset that resides in a specific workspace. This is commonly used after updating underlying data sources or to modify dataset configuration without redeploying. [!NOTE] We recommend using enhanced dataset metadata with this API call.Input Parameters
Output
Update Refresh Schedule
Update Refresh Schedule
MICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULEUpdates the refresh schedule for the specified dataset from My workspace. Use this action when you need to configure or modify the automatic refresh schedule for a Power BI dataset, such as enabling/disabling scheduled refresh, setting refresh days and times, or configuring failure notifications. A request that disables the refresh schedule should contain no other changes. This action is idempotent. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Update Refresh Schedule In Group
Update Refresh Schedule In Group
MICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULE_IN_GROUP3Updates the refresh schedule for the specified dataset from the specified workspace. Use this action when you need to configure or modify the automatic refresh schedule for a Power BI dataset within a workspace, such as enabling/disabling scheduled refresh, setting refresh days and times, or configuring failure notifications. A request that disables the refresh schedule should contain no other changes. This action is idempotent. Required Scope: Dataset.ReadWrite.AllInput Parameters
Output
Update Report Content
Update Report Content
MICROSOFT_POWER_BI_UPDATE_REPORT_CONTENTUpdates the content of the specified report from My workspace with the content of a specified source report. Use this action when you need to replace the content of a report in My workspace with content from another report. The target report must be in My workspace. The source report can be from My workspace or another workspace (in which case a share is required). This operation overwrites the target report’s content while keeping its ID, name, and other properties. Required Scope: Report.ReadWrite.AllInput Parameters
Output
Update Workspace
Update Workspace
MICROSOFT_POWER_BI_UPDATE_WORKSPACEUpdates the properties for the specified workspace. Use this action when you need to modify workspace settings such as renaming the workspace or changing the default dataset storage format. This action can be called by a service principal profile with appropriate permissions. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Workspace.ReadWrite.AllInput Parameters
Output
Update Workspace Properties As Admin
Update Workspace Properties As Admin
MICROSOFT_POWER_BI_UPDATE_WORKSPACE_PROPERTIES_AS_ADMINUpdate workspace name/description as a Fabric administrator; Premium workspaces also support defaultDatasetStorageFormat and logAnalyticsWorkspace. Names must be unique in the organization. Explicit logAnalyticsWorkspace:null unassigns Log Analytics. Does not update capacity assignments, users or artifact collections. Required delegated scope: Tenant.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/admin/groups-update-group-as-adminInput Parameters
Output
Bind A Workspace Paginated Report Data Source To A Gateway
Bind A Workspace Paginated Report Data Source To A Gateway
MICROSOFT_POWER_BI_WORKSPACE_BIND_RDL_REPORT_TO_GATEWAYBind a workspace paginated report data source to a gateway. Binds the specified data source of the paginated report from the specified workspace to the specified gateway, optionally with a given data source ID. If you don’t supply a specific data source ID, the data source will be bound to the first matching data source in the gateway. Required delegated scopes: Workspace.Read.All or Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_BindToGatewayInGroup.Input Parameters
Output
Execute Dax Queries Returning Apache Arrow Streams In A Workspace
Execute Dax Queries Returning Apache Arrow Streams In A Workspace
MICROSOFT_POWER_BI_WORKSPACE_EXECUTE_DAX_QUERIESExecute DAX against a dataset in a workspace and return base64 Arrow streams. Requires dataset read/build permissions and the Dataset Execute Queries tenant setting. Dataset.Read.All or Dataset.ReadWrite.All authorizes this operation. Supports one query with multiple EVALUATE statements. The binary response may contain error rowsets even with HTTP 200. Query success is explicitly unverified; decode data_base64 and inspect IsError in every Arrow stream’s schema metadata.Input Parameters
Output
Get Dataset Refresh History In A Workspace
Get Dataset Refresh History In A Workspace
MICROSOFT_POWER_BI_WORKSPACE_GET_DATASET_REFRESH_HISTORYGet dataset refresh history in a workspace. Returns the refresh history for the specified dataset from the specified workspace. OneDrive refresh history is not returned. Caller must have Write permissions on the dataset. Supports service principal profiles. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetRefreshHistoryInGroup.Input Parameters
Output
Get A Direct Query Refresh Schedule In A Workspace
Get A Direct Query Refresh Schedule In A Workspace
MICROSOFT_POWER_BI_WORKSPACE_GET_DIRECT_QUERY_SCHEDULEGet a DirectQuery refresh schedule in a workspace. Returns the refresh schedule for a specified DirectQuery or LiveConnection dataset from the specified workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDirectQueryRefreshScheduleInGroup.Input Parameters
Output
List Paginated Report Data Sources In A Workspace
List Paginated Report Data Sources In A Workspace
MICROSOFT_POWER_BI_WORKSPACE_LIST_RDL_REPORT_DATASOURCESList paginated report data sources in a workspace. Returns a list of data sources for the specified paginated report (RDL) from the specified workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetDatasourcesInGroup.Input Parameters
Output
Update Dataset Data Sources In A Workspace
Update Dataset Data Sources In A Workspace
MICROSOFT_POWER_BI_WORKSPACE_UPDATE_DATASET_DATASOURCESUpdate a workspace dataset’s data source connections as its owner. Original and replacement sources must have the same schema and type. Supports SQL Server, Azure SQL Server, Azure Analysis Services, Azure Synapse, OData, SharePoint, Teradata and SAP HANA. XMLA-created/modified datasets and parameterized connection strings are unsupported. With enhanced metadata refresh after updating; otherwise wait 30 minutes, then refresh. This call does not refresh data. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/update-datasources-in-groupInput Parameters
Output
Update An Existing Users Dataset Permissions In A Workspace
Update An Existing Users Dataset Permissions In A Workspace
MICROSOFT_POWER_BI_WORKSPACE_UPDATE_DATASET_PERMISSIONSUpdate existing direct dataset permissions in a workspace; App principals are unsupported. Cannot add or remove write permission or remove inherited workspace permissions. Set datasetUserAccessRight to None to revoke direct access. Caller needs ReadWriteReshare permission. Permission propagation may require Refresh User Permissions. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/put-dataset-user-in-groupInput Parameters
Output
Update A Direct Query Refresh Schedule In A Workspace
Update A Direct Query Refresh Schedule In A Workspace
MICROSOFT_POWER_BI_WORKSPACE_UPDATE_DIRECT_QUERY_SCHEDULEUpdate a DirectQuery or LiveConnection dataset’s refresh schedule in a workspace. The caller must own the dataset. Service principal profiles are supported. Supply either days/times or frequency, not both. Days without times use a default single time per day; frequency overwrites existing days/times. Supported frequencies in minutes: 15, 30, 60, 120, 180. Required delegated scopes: Dataset.ReadWrite.All. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_UpdateDirectQueryRefreshScheduleInGroup.Input Parameters
Output
Update Workspace Report Content From A Source Report
Update Workspace Report Content From A Source Report
MICROSOFT_POWER_BI_WORKSPACE_UPDATE_REPORT_CONTENTUpdate workspace report content from a source report. Updates the content of the specified report from the specified workspace with the content of a specified source report. Required delegated scopes: Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_UpdateReportContentInGroup.