Your AI team, working in Microsoft Power Bi
Microsoft Power BI is a business analytics service that provides interactive visualizations and business intelligence capabilities with an interface simple enough for end users to create their own reports and dashboards.
Start your companyWhat your team can do in Microsoft Power Bi
279 tools to work with, connected with your account.
Add 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.
Creates 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.
Add 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.
Adds 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.
Assign 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.
Assign 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.
Assign 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.
Assigns 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).
Assign workspaces to a Premium capacity as admin. Assigns the specified workspaces to the specified Premium 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 Capacities_AssignWorkspacesToCapacity.
Bind 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.
Bind 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.
Bind 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.
Bind 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.
Cancel 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.
Cancel 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.
Cancels 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.All
Change 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.
Check 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.
Clone 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.
Clone 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.
Clones 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.All
Clones 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.All
Create 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.
Create 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.
Create 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-profile
Creates 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.All
Create 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.
Create 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.
Creates 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.
Creates 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.
Creates 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.
Creates a temporary blob storage upload location for importing large Power BI .pbix files between 1 GB and 10 GB. It returns a SAS URL for uploading the file before import, using the organization-level endpoint.
Creates a temporary blob storage upload location in a specified workspace for importing large Power BI .pbix files between 1 GB and 10 GB. It returns a SAS URL for uploading the file before import.
Creates 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.
Delete 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.
Delete 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.
Delete 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-datasource
Delete 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.
Delete 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.
Delete 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.
Deletes 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.All
Deletes 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.
Deletes 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.All
Deletes 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.All
Deletes 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.All
Deletes 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.All
Removes 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.All
Removes 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.All
Deletes 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.All
Deletes 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.All
Deletes 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.All
Deletes 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.All
Deletes 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.All
Deploy 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-all
Deploy 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.
Discover 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.
Returns 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.All
Retrieve 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-file
Retrieve 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-group
Enable 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.
Executes 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.
Executes 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.All
Execute 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.
Executes 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.
Export 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.
Export 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-dataflow
Export 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.
Export 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-group
Generate 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.
Generate 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-ticket
Generates 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.All
Generates 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.All
Generates 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.
Generates 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.All
Generates 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.All
Return 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-capacity
Get 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.
Get 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.
Get 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.
Get 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.
Get 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.
Get 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.
Get a DirectQuery refresh schedule in a workspace. Returns the refresh schedule for a specified [DirectQuery](/power-bi/connect-data/desktop-directquery-about) or [LiveConnection](/power-bi/connect-data/desktop-directquery-about#live-connections) 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.
Get a DirectQuery refresh schedule in My workspace. Returns the refresh schedule for a specified [DirectQuery](/power-bi/connect-data/desktop-directquery-about) or [LiveConnection](/power-bi/connect-data/desktop-directquery-about#live-connections) 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.
Get 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.
Get 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.
Get 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.
Get 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.
Get 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.
Get 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.
Get 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.
Get 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.
Returns 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.
Lists the Power BI capacities accessible to the authenticated user, with information such as state, SKU, region, and access rights when available. Requires Capacity.Read.All or Capacity.ReadWrite.All and can be called by a service principal profile.
List 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-workloads
Returns 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.All
Returns 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.
Lists 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.
Returns 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.All
Executes 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.
Returns 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.All
Returns the parameters of a specified Power BI dataset in My workspace, including current values, types, required status, and suggested values when available. Requires Dataset.Read.All or Dataset.ReadWrite.All.
Returns 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.All
Get 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.
Get 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.
Get 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.
Returns 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.All
Returns 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.
Returns 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.
Returns 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.
Returns 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.All
Gets 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.All
Returns 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.All
Returns 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.All
Get 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.
Returns 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.All
Returns 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.
Returns 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.
Reads 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.All
Returns 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.All
Reads 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.
Returns 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.All
Returns 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.
Lists Power BI workspaces accessible to the authenticated user, with optional filtering and pagination. The API can be called by a service principal profile and requires Workspace.Read.All or Workspace.ReadWrite.All scope.
Gets 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.All
Returns 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.All
Returns 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.All
Returns 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.
Gets 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.
Get 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.
Returns 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.All
Returns 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.All
Returns 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.All
Returns 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.All
Returns 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.
Returns 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.
Returns 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.All
Returns 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.
Get report export job status in My workspace. Returns the current status of the [Export to File](/rest/api/power-bi/reports/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.
Returns 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.All
Returns 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.
Returns 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.All
Gets reports from the configured Power BI endpoint, with optional OData filtering, sorting, selection, and pagination parameters. Requires Report.Read.All or Report.ReadWrite.All.
Returns 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.
Returns 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.
Lists Power BI datasets in My workspace, with optional query parameters for filtering and pagination.
Retrieves 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.
Returns 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.All
Returns 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.All
Returns 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.
Returns 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.All
Returns 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.All
Returns 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.All
Get 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.
Get 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.
Get workspace report export job status. Returns the current status of the [Export to File In Group](/rest/api/power-bi/reports/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.
Grants 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.
Grants 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.All
Grant 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.
Grant 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.
Grant 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.
Grant 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.
Grant 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.
Import .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.
Import .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.
List 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.
List 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.
List 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.
List 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.
List 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.
Returns 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.
List 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.
List 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.
List 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.
Returns 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.
List 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.
List 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.
Returns 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.
List 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.
Return 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.
List 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.
List 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.
List 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.
List 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.
List 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-admin
List deployment pipelines that the signed-in user has access to. This action takes no parameters. Required scope: Pipeline.Read.All or Pipeline.ReadWrite.All.
List 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.
List 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.
List apps installed by the signed-in user. This action takes no parameters. Required scope: App.Read.All. Service principal authentication isn't supported.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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-admin
List 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.
List reports shared to the whole organization through links. Returns a list of Power BI reports that are shared with the whole organization through links. 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_LinksSharedToWholeOrganization.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
List 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.
Return 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.
List 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.
List 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.
List 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.
Moves 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.All
Updates 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.All
Updates 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.All
Updates 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.All
Updates 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.All
Adds 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.
Adds 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.All
Creates 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.All
Rebind 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-report
Rebinds 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.
Refresh 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.
Refresh a dataset in My workspace. Triggers a refresh for the specified dataset from **My workspace**. An [enhanced refresh](/power-bi/connect-data/asynchronous-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.
Refresh 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.
Remove 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.
Remove 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.
Remove 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.
Remove 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.
Remove 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.
Restore 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.
Rotate 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.
Replaces 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.All
Set 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.
Start 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-group
Start 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.
Start 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-info
Transfers 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.All
Transfers 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.All
Triggers 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.
Triggers 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.All
Triggers 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.All
Unassign 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.
Unassign 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.
Update 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.
Update 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.
Update 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-schedule
Update 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.
Update 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.
Update 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-group
Update 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-user
Update 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.
Updates 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.All
Update 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-group
Update 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-datasources
Updates 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.All
Update 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-parameters
Updates 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.
Replace 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-datasource
Updates 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.All
Update 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.
Updates 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.All
Updates 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.All
Updates 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.All
Updates 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.All
Updates 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.All
Updates 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.All
Update 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-admin
Update 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.
Nothing matches that.
More in Business intelligence
See them all βKlipfolio is a cloud-based business intelligence platform that enables users to create and share real-time dashboards and reports.
50 toolsβ 221RISK is a web application that simplifies working with checklists, audits, and actions, facilitating compliance and risk management processes.
8 toolsβ AAlion provides company, job, people, investor, market, and hiring intelligence through its REST API.
40 toolsβ BBigPicture.io provides APIs and datasets for accessing comprehensive company data, including information on over 20 million profiles, used inβ¦
4 toolsβ BBSC Designer helps organizations create balanced scorecards, manage KPIs, visualize strategy maps, and track strategic performance.
10 toolsβ CCB Insights provides company intelligence, financial transactions, business relationships, predictive analytics, and generated market research throughβ¦
17 toolsβ