Skip to main content
Microsoft Power Bi logo
  • Category: business intelligence
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 116
  • Triggers: 0
  • Slug: MICROSOFT_POWER_BI
  • Version: 20261101_00

Tools

Slug: MICROSOFT_POWER_BI_ADD_A_TENANT_ENCRYPTION_KEYAdd a tenant encryption key. Adds an encryption key for Power BI workspaces assigned to a capacity. Requires a Fabric administrator. Maximum 600 requests per hour. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_AddPowerBIEncryptionKey.

Input Parameters

object
required
Tenant key information

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADD_DASHBOARD2Creates a new empty dashboard in the specified workspace. Use this action when you need to create a new dashboard in a Power BI workspace. The API call can be called by a service principal profile. Requires the Workspace.ReadWrite.All scope. Note: The created dashboard will be empty and can be populated with tiles afterward using other APIs.

Input Parameters

string
required
The name of the new dashboard
string
required
The workspace ID (also known as group ID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_ASSIGN_WORKSPACES_TO_CAPACITYAssign 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.

Input Parameters

object
required
Admin assign workspaces capacity parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_DELETE_SERVICE_PRINCIPAL_PROFILEDelete a service-principal profile as admin. Deletes the specified service principal profile. The user must be a Fabric administrator. Maximum 200 requests per hour. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_DeleteProfileAsAdmin.

Input Parameters

string
required
The service principal profile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_GRANT_PIPELINE_PERMISSIONSGrant deployment pipeline permissions as admin. Grants user permissions to a specified deployment pipeline. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_UpdateUserAsAdmin.

Input Parameters

string
required
The deployment pipeline ID
object
required
Details of user access right

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_LIST_MODIFIED_WORKSPACESList organization workspace IDs, optionally filtered by modification date. Gets a list of workspace IDs in the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation WorkspaceInfo_GetModifiedWorkspaces.

Input Parameters

string
Last modified date (must be in ISO 8601 compliant UTC format)
boolean
Whether to exclude inactive workspaces
boolean
Whether to exclude personal workspaces

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_LIST_PIPELINESList organization deployment pipelines as admin. Returns a list of deployment pipelines for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelinesAsAdmin.

Input Parameters

integer
Returns only the first n results. This parameter must be in the range of 1-5000.
integer
Skips the first n results. Use with top to fetch results beyond the first 5000.
string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports users and stages.
string
Filters the results based on a boolean condition. This API only supports filtering for orphaned deployment pipelines. Unsupported filters will return unfiltered results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_LIST_SERVICE_PRINCIPAL_PROFILESList organization service-principal profiles. Returns a list of service principal profiles for the organization. Requires a Fabric administrator or service principal. Limited to 200 requests per hour. Use $top and $skip to page through results. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_GetProfilesAsAdmin.

Input Parameters

integer
Returns only the first n results. This parameter must be in the range of 1-5000.
integer
Skips the first n results. Use with top to fetch results beyond the first 5000.
string
Filters the results based on a boolean condition, using ‘id’, ‘displayName’, or ‘servicePrincipalId’. Supports only ‘eq’ operator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_REMOVE_PIPELINE_USERRemove deployment pipeline permissions as admin. Removes user permissions from a specified deployment pipeline. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_DeleteUserAsAdmin.

Input Parameters

string
required
For the principal type User, provide the user principal name (UPN). Otherwise, provide the Object ID of the principal.
string
required
The deployment pipeline ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_REMOVE_SENSITIVITY_LABELSRemove sensitivity labels from Power BI items. Remove sensitivity labels from Power BI items (such as reports or dashboards) by item ID. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation InformationProtection_RemoveLabelsAsAdmin.

Input Parameters

object
required
A composite of artifact ID lists for each type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ADMIN_UNASSIGN_WORKSPACES_FROM_CAPACITYUnassign workspaces from capacity as admin. Migrates the specified workspaces to shared capacity. Requires a Fabric administrator; maximum 200 requests per hour. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/capacities-unassign-workspaces-from-capacity.

Input Parameters

object
required
Admin assign workspaces to shared capacity parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_APPS_GET_REPORTSReturns a list of reports from the specified app. Use this action when you need to retrieve all reports that belong to a specific Power BI app. This is useful for exploring app contents, finding specific reports within apps, or managing app resources. Required Scope: Report.ReadWrite.All or Report.Read.All Limitations: Service principal authentication isn’t supported.

Input Parameters

string
required
The app ID of the Power BI app whose reports to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ASSIGN_MY_WORKSPACE_TO_A_CAPACITYAssign My workspace to a capacity. Use an empty GUID (00000000-0000-0000-0000-000000000000) as capacityId to unassign it. Requires administrator rights or Assign permission on the capacity. Required delegated scopes: Capacity.ReadWrite.All and Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_AssignMyWorkspaceToCapacity.

Input Parameters

object
required
Assign to capacity parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_CAPACITYAssigns the specified workspace to the specified capacity. Use this action when you need to assign a Power BI workspace to a dedicated capacity or unassign My workspace from a capacity by providing an empty GUID (00000000-0000-0000-0000-000000000000). This operation is typically performed by Fabric administrators to manage workspace capacity assignments. Note: The user must have appropriate permissions (Capacity.ReadWrite.All or workspace admin rights).

Input Parameters

string
required
The workspace (group) ID. This is a path parameter identifying the target workspace.
string
required
The capacity ID. Use an empty GUID (00000000-0000-0000-0000-000000000000) to unassign My workspace from a capacity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_DATAFLOW_STORAGEAssign a workspace to a dataflow storage account. Requires workspace admin permissions and an enabled dataflow storage account. To unassign, use dataflowStorageId 00000000-0000-0000-0000-000000000000. Required delegated scopes: StorageAccount.ReadWrite.All and Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_AssignToDataflowStorage.

Input Parameters

string
required
The workspace ID
object
required
Assign to Power BI dataflow storage account parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_PIPELINE_STAGEAssign a workspace to the specified deployment pipeline stage. Requires both Pipeline.ReadWrite.All and Workspace.ReadWrite.All delegated scopes. You must be an admin of the workspace. The stage must be unassigned, the workspace must not belong to another deployment pipeline, and no deployment operation may be active. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_AssignWorkspace.

Input Parameters

string
required
The deployment pipeline ID
integer ("0" | "1" | "2")
required
The deployment pipeline stage order. Development (0), Test (1), Production (2).
object
required
The assign workspace request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_BIND_A_WORKSPACE_DATASET_TO_A_GATEWAYBind a workspace dataset to a gateway. Binds the specified dataset from the specified workspace to the specified gateway, optionally with a given set of data source IDs. If you don’t supply a specific data source ID, the dataset will be bound to the first matching data source in the gateway. Only supports the on-premises data gateway. The API caller principal must be a data source user on the gateway. Service principal profiles are supported. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_BindToGatewayInGroup.

Input Parameters

string
required
The workspace ID
string
required
The dataset ID
object
required
The bind to gateway request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CANCEL_A_DATAFLOW_TRANSACTIONCancel a dataflow transaction. Attempts to cancel the specified transactions. Required delegated scopes: Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_CancelDataflowTransaction.

Input Parameters

string
required
The workspace ID
string
required
The transaction ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CANCEL_A_DATASET_REFRESH_IN_MY_WORKSPACECancel a dataset refresh in My workspace. Cancels the specified refresh operation for the specified dataset from My workspace. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_CancelRefresh.

Input Parameters

string
required
The dataset ID
string
required
The refresh ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CANCEL_REFRESH2Cancels the specified refresh operation for the specified dataset from the specified workspace. Use this action when you need to cancel an in-progress dataset refresh operation within a specific Power BI workspace. This is useful for stopping long-running refreshes that are no longer needed or that appear to be stuck. Note that only refresh operations with status of Unknown or Queued can be canceled. Once a refresh has started processing, it cannot be cancelled. This action is irreversible - once a refresh is successfully cancelled, it cannot be resumed and must be triggered again manually. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The workspace ID. Use GetGroups to find the workspace ID.
string
required
The dataset ID. Use GetDatasetsInGroup to find the dataset ID within a workspace.
string
required
The refresh ID to cancel. This is the unique identifier of a refresh operation from the dataset refresh history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CHANGE_A_CAPACITY_ENCRYPTION_KEYChange a capacity encryption key. Changes specific capacity information. Currently, this API call only supports changing the capacity’s encryption key. The user must be a Fabric administrator. Maximum 200 requests per hour. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_PatchCapacityAsAdmin.

Input Parameters

string
required
The capacity ID
object
required
Patch capacity information

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CHECK_GATEWAY_DATA_SOURCE_CONNECTIVITYCheck gateway data source connectivity. Checks the connectivity status of the specified data source from the specified gateway. Requires gateway admin permissions; VNet gateways are unsupported. Success returns no response body; connectivity failures raise provider errors. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_GetDatasourceStatus.

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.
string
required
The data source ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CLONE_A_DASHBOARD_TILE_IN_A_WORKSPACEClone a tile from a workspace dashboard to a target dashboard. Returns the cloned tile. For cross-workspace clones, provide target report and model IDs to preserve working report/dataset links; omitting them removes those links and leaves the tile broken. Same-workspace clones retain source links when those IDs are omitted. Rebinding preserves the original report filters in the tile’s underlying query. Required delegated scope: Dashboard.ReadWrite.All. Service principal profiles are supported. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_CloneTileInGroup.

Input Parameters

string
required
The tile ID
string
required
The workspace ID
string
required
The dashboard ID
object
required
Clone tile parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CLONE_A_DASHBOARD_TILE_IN_MY_WORKSPACEClone the specified dashboard tile from My workspace. Cloning preserves the underlying query’s original report filters. If target report and dataset IDs are omitted, same-workspace clones retain the source links; cross-workspace clones lose those links and the tile will be broken. Supply targetReportId and targetModelId to rebind a linked tile. Required delegated scope: Dashboard.ReadWrite.All. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_CloneTile.

Input Parameters

string
required
The tile ID
string
required
The dashboard ID
object
required
Clone tile parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CLONE_REPORT2Clones the specified report from My workspace. If the dataset for a cloned report resides in two different workspaces or in My workspace, then a shared dataset is created. Use when you need to duplicate a report within My workspace or to another workspace. This is useful for creating backup copies of reports, testing modifications without affecting the original, or preparing reports for different audiences. Required Scope: Report.ReadWrite.All

Input Parameters

string
required
The name for the cloned report
string
required
The report ID of the source report to clone
string
Optional. The target dataset ID to associate with the cloned report. If not provided, the new report will be associated with the same dataset as the source report.
string
Optional. The target workspace ID. An empty GUID (00000000-0000-0000-0000-000000000000) indicates My workspace. If not provided, the new report will be cloned within the same workspace as the source report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CLONE_REPORT_IN_GROUPClones the specified report from the specified workspace. Use this action when you need to duplicate a Power BI report within the same workspace or to a different workspace. If the dataset for a cloned report resides in two different workspaces or in My workspace, then a share is required. The API returns the cloned report with a new ID. Required Scope: Report.ReadWrite.All

Input Parameters

string
required
The name for the cloned report
string
required
The workspace ID (group ID)
string
required
The report ID
string
The target dataset ID. If not provided, the new report will be associated with the same dataset as the source report
string
The target workspace ID. An empty GUID (00000000-0000-0000-0000-000000000000) indicates My workspace. If not provided, the new report will be cloned within the same workspace as the source report

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_A_DEPLOYMENT_PIPELINECreate a deployment pipeline. Creates a new deployment pipeline. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_CreatePipeline.

Input Parameters

object
required
The create pipeline request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_A_GATEWAY_DATA_SOURCECreate a gateway data source. Creates a new data source on the specified on-premises gateway. Requires gateway admin permissions. Set encryptedConnection to Encrypted and encrypt credentials using the gateway public key. VNet and cloud gateways and OAuth2 credential types are not supported. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/create-datasource.

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.
object
required
A request to create a new data source on a gateway

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_A_SERVICE_PRINCIPAL_PROFILECreate a profile owned by the calling service principal. Only service-principal authentication is supported. A service principal can own at most 100,000 profiles. https://learn.microsoft.com/en-us/rest/api/power-bi/profiles/create-profile

Input Parameters

object
required
The create profile request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_GOAL_VALUECreates a new goal value check-in for a Power BI scorecard goal. Use this action when you need to record a new value check-in for a specific goal within a Power BI scorecard. This action allows you to update the current value, target, status, trend, and forecast of a goal. The timestamp is required and represents the UTC time of the check-in. Required Scope: Dataset.ReadWrite.All

Input Parameters

string ("0" | "1" | "2")
Goal trend values.
number
The current value of the goal.
string ("0" | "1" | "2" | "3" | "4" | "5")
Goal status ID values.
number
The target value of the goal.
string
required
The unique identifier of the goal
number
The value trend forecast of the goal.
string
required
The unique identifier of the workspace containing the scorecard
string
required
The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
string
required
The unique identifier of the scorecard containing the goal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_GROUPCreates a new workspace in Power BI. Use this action when you need to create a new Power BI workspace to organize reports, dashboards, datasets, and other Power BI content. This API call can be called by a service principal profile. Requires the Workspace.ReadWrite.All scope. Note: The created workspace will be empty and may require additional configuration such as assigning capacity or adding members.

Input Parameters

string
required
The name of the workspace to create
boolean
(Preview feature) Whether to create a workspace V2. The only supported value is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_MY_WORKSPACE_DASHBOARDCreate a new empty dashboard in the signed-in user’s My workspace. Returns the dashboard ID and available dashboard properties. Use Add Dashboard in a specified workspace to create a dashboard in a shared workspace instead. Required scope: Content.Create.

Input Parameters

string
required
The name of the new dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_PUSH_DATASETCreates a new dataset on My workspace in Power BI. Use this action when you need to create a new push dataset to store and manage data that can be pushed programmatically via the Power BI REST API. This API call only supports push datasets (Push, Streaming, or PushStreaming mode). This action is irreversible once the dataset is created. The dataset name must be unique within the workspace.

Input Parameters

string
required
The name of the dataset to create.
array
required
The list of tables to create in the dataset.
array
The data sources associated with this dataset.
string
The dataset mode or type. For push datasets, use ‘Push’.
array
The relationships between tables in this dataset.
string ("None" | "basicFIFO")
Default retention policy for the dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_SCORECARDCreates a new scorecard in the specified Power BI workspace. Use this action when you need to create a new scorecard to track business objectives and key results in a specific Power BI workspace. Scorecards help organizations monitor progress toward goals with customizable metrics, status rules, and reporting. Requires the Dataset.ReadWrite.All scope. This action is irreversible once the scorecard is created. The scorecard name must be unique within the workspace.

Input Parameters

string
required
The scorecard name.
string
required
The workspace ID (group ID) that identifies the workspace.
string
Optional. The scorecard description.
string
Optional. The GUID of a sensitivity label. If you don’t want to select a sensitivity label, use a null or empty GUID (00000000-0000-0000-0000-000000000000). If default labels are enabled and/or enforced, they will be applied on the scorecard and dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_TEMPLATE_APP_INSTALL_TICKETGenerate an installation ticket for an automated template-app install using service-principal authentication. The tenant must own the app; the app must be on AppSource or both the ticket creator and installing user must have explicit access. Configure every required query parameter. Supply single-app appId/packageKey/ownerTenantId/config fields, or a batch installDetails array. No delegated scopes apply. https://learn.microsoft.com/en-us/rest/api/power-bi/template-apps/create-install-ticket

Input Parameters

string
required
Single-app installation details (appId, packageKey, ownerTenantId, config), or a batch object containing installDetails. Include all required template-app query parameter values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_TEMPORARY_UPLOAD_LOCATIONCreates 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_CREATE_TEMPORARY_UPLOAD_LOCATION_IN_GROUPCreates 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.

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_A_DASHBOARD_IN_A_WORKSPACEDelete a dashboard in a workspace. Deletes the specified dashboard from the specified workspace. Required delegated scopes: Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_DeleteDashboardInGroup.

Input Parameters

string
required
The workspace ID
string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_A_DEPLOYMENT_PIPELINEDelete a deployment pipeline. Deletes the specified deployment pipeline. Fails if there is an active deployment operation. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_DeletePipeline.

Input Parameters

string
required
The deployment pipeline ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_A_GATEWAY_DATA_SOURCEDelete the specified data source from the specified gateway. Requires gateway admin permissions and delegated scope Dataset.ReadWrite.All. Virtual network (VNet) gateways aren’t supported. Provider documentation: https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/delete-datasource

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.
string
required
The data source ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_A_REPORT_IN_MY_WORKSPACEDelete a report in My workspace. Deletes the specified report from My workspace. Required delegated scopes: Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_DeleteReport.

Input Parameters

string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_A_SERVICE_PRINCIPAL_PROFILEDelete a service-principal profile owned by the calling service principal. Can only be called by a service principal. No delegated scope is declared. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_DeleteProfile.

Input Parameters

string
required
The service principal profile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_DASHBOARDDeletes the specified dashboard from My workspace. Use this action when you need to permanently remove a dashboard from a user’s Power BI workspace. This action is irreversible — once deleted, the dashboard and all its content cannot be recovered. Required Scope: Dashboard.ReadWrite.All

Input Parameters

string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_DATAFLOWDeletes the specified dataflow from Power BI data prep storage, including its definition file and model. Use this action when you need to permanently remove a dataflow from a Power BI workspace. This action is irreversible — once deleted, the dataflow and all its associated data cannot be recovered. Permissions: The user must have administrator rights or the caller must be a service principal.

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_DATASETDeletes the specified dataset from My workspace. Use this action when you need to permanently remove a dataset from a user’s Power BI workspace. This action is irreversible — once deleted, the dataset and all its associated data cannot be recovered. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_DATASET2Deletes the specified dataset from the specified workspace. Use this action when you need to permanently remove a dataset from a specific Power BI workspace. This action is irreversible — once deleted, the dataset and all its associated data cannot be recovered. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_GOALDeletes a goal from a scorecard by goal ID. Use this action when you need to permanently remove a goal from a Power BI scorecard. This action is irreversible — once deleted, the goal and its associated data cannot be recovered. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The unique identifier of the goal
string
required
The unique identifier of the workspace
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_GOAL_NOTE_BY_IDDeletes a goal value check-in note by its unique identifier. Use this action when you need to remove a specific check-in note from a goal value in Power BI goals. This action is irreversible — once deleted, the note cannot be recovered. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The unique identifier of the goal
string
required
The unique identifier of the goal check-in note
string
required
The unique identifier of the workspace
string
required
The timestamp for the value of the goal (ISO 8601 format)
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_GOAL_STATUS_RULESRemoves status rule definitions from a goal. Use this action when you need to remove all status rules from a specific goal within a Power BI scorecard. This action is irreversible — once deleted, the status rules and their configuration cannot be recovered. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The unique identifier of the goal
string
required
The unique identifier of the workspace
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_PIPELINE_USERRemoves user permissions from the specified deployment pipeline. Use this action when you need to revoke a user’s access to a deployment pipeline. This action is irreversible — once removed, the user loses access to the pipeline. Required Scope: Pipeline.ReadWrite.All

Input Parameters

string
required
The user principal name (UPN) of the user. To delete a service principal or a security group, provide the Object ID.
string
required
The deployment pipeline ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_REPORT_IN_GROUPDeletes the specified report from the specified workspace. Use this action when you need to permanently remove a report from a specific Power BI workspace. This action is irreversible — once deleted, the report and all its content cannot be recovered. This API call can be called by a service principal profile. Required Scope: Report.ReadWrite.All

Input Parameters

string
required
The workspace ID
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_ROWSDeletes all rows from the specified table within the specified dataset from My workspace. Use this action when you need to clear all data from a specific table within a Power BI push dataset. This action is irreversible — once deleted, the rows cannot be recovered. This operation is commonly used to reset test data or prepare a table for fresh data ingestion. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The dataset ID
string
required
The table name from which to delete all rows

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_ROWS_IN_GROUPDeletes all rows from the specified table within the specified dataset from the specified workspace. Use this action when you need to clear all data from a specific table within a Power BI push dataset in a specific workspace. This action is irreversible — once deleted, the rows cannot be recovered. This operation is commonly used to reset test data or prepare a table for fresh data ingestion in a workspace context. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace
string
required
The dataset ID
string
required
The table name from which to delete all rows

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_SCORECARD_BY_IDDeletes a scorecard by its ID from the specified workspace. Use this action when you need to permanently remove a scorecard from a Power BI workspace. This action is irreversible — once deleted, the scorecard and all its data cannot be recovered. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The unique identifier of the workspace (group)
string
required
The unique identifier of the scorecard to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DELETE_WORKSPACEDeletes the specified workspace. Use this action when you need to permanently remove a Power BI workspace. This action is irreversible — once deleted, the workspace and all its content (reports, dashboards, datasets) cannot be recovered. Required Scope: Workspace.ReadWrite.All

Input Parameters

string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DEPLOY_ALL_PIPELINE_ITEMSDeploy all supported Power BI items from a pipeline stage. Requires contributor access to both source and target workspaces and delegated scope Pipeline.Deploy. Maximum 300 items per request; other Fabric item types are unsupported. Returns an accepted pipeline operation, not deployment completion; inspect its status to determine the outcome. Provider contract: https://learn.microsoft.com/en-us/rest/api/power-bi/pipelines/deploy-all

Input Parameters

string
required
The deployment pipeline ID
object
required
The deploy request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DEPLOY_SELECTED_PIPELINE_ITEMSDeploy selected Power BI items from a deployment pipeline stage (maximum 300 items). Requires contributor access to both source and target workspaces. Other Fabric item types are unsupported. Returns an accepted pipeline operation, not confirmation that deployment finished; inspect its status to verify completion. Required delegated scopes: Pipeline.Deploy Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/pipelines/selective-deploy.

Input Parameters

string
required
The deployment pipeline ID
object
required
The selective deploy request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DISCOVER_GATEWAYSReturns a list of gateways that the specified dataset from the specified workspace can be bound to. Use this action when you need to discover which on-premises data gateways are available to bind a dataset to for refresh and data source connections. This API call is only relevant for datasets that have at least one binding to an on-premises data source. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The dataset ID that identifies the dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_DOWNLOAD_WORKSPACE_REPORT_EXPORTRetrieve the completed export-job file for a workspace report as a platform-managed downloadable file reference, with content metadata. Poll export status until Succeeded before downloading. Required delegated scope: Report.Read.All or Report.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/reports/get-file-of-export-to-file-in-group

Input Parameters

string
required
The workspace ID
string
required
The export ID
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_EXECUTE_DAX_QUERIESExecutes DAX queries against a capacity-hosted dataset in My workspace, with options for RLS, culture and custom data. Returns raw Apache Arrow data for parsing; the success flag does not rule out errors embedded in the stream.

Input Parameters

string
required
The DAX query text to execute. Supports single or multiple EVALUATE statements.
array
Roles assigned to the user for Row-Level Security (RLS).
string
Culture code that controls locale-specific query formatting, such as ‘en-US’. For more information about supported culture codes, see Supported languages and countries/regions for Power BI.
string
required
The dataset ID
string
Custom data for use in Dynamic RLS. Can be referenced by the model’s CUSTOMDATA() function.
boolean
Whether the query must return only the schema without data.
integer
Memory limit in KB for the query execution.
integer
Query timeout in seconds.
string
Effective username for the query. Used for RLS and audit purposes.
integer
Maximum number of rows to return. Default is 1,000,000 rows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_EXECUTE_QUERIES_2Executes Data Analysis Expressions (DAX) queries against the specified Power BI dataset. Use this action when you need to run DAX queries to retrieve data, perform calculations, or analyze data directly from a Power BI dataset. DAX query errors (such as syntax errors or invalid references) will result in an error response. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

array
required
The list of DAX queries to execute against the dataset. Each query will return its own result set.
string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The dataset ID to execute queries against.
object
Serialization settings for query results.
string
The UPN of a user to be impersonated. If the model is not Row-Level Security (RLS) enabled, this will be ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_EXECUTE_SUBSCRIPTIONExecutes the Subscription specified by the Id. Use this action when you need to manually trigger a Power BI email subscription to run immediately instead of waiting for its scheduled frequency. This is useful for testing subscriptions, generating reports on-demand, or forcing an unscheduled distribution of a report. Note: The API returns 204 No Content on success with an empty body.

Input Parameters

string
required
The key (GUID) that uniquely identifies the subscription. GUID example: 01234567-89ab-cdef-0123-456789abcdef

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_EXPORT_A_DATAFLOW_DEFINITION_AS_ADMINExport the specified dataflow definition as a downloadable JSON file reference. Requires a Fabric administrator or service principal. Delegated access requires Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent-required Power BI permissions configured. Maximum 200 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_ExportDataflowAsAdmin.

Input Parameters

string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_EXPORT_A_DATAFLOW_DEFINITION_AS_JSONExport a workspace dataflow definition as a platform-managed downloadable JSON file reference, with content metadata. Download the file to read its JSON definition; the response is not a parsed definition. Required delegated scope: Dataflow.Read.All or Dataflow.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/dataflows/get-dataflow

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_EXPORT_A_WORKSPACE_REPORT_AS_PBIX_OR_RDLExport a workspace report as a downloadable PBIX or RDL file reference. Required delegated scopes: Report.ReadWrite.All OR (Report.Read.All AND Dataset.Read.All). Dataset.Read.All alone does not authorize this operation. Service principal profiles are supported. PBIX download limitations apply; exporting a live-connected report after rebinding it is not supported. Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/export-report-in-group

Input Parameters

string
required
The workspace ID
string
required
The report ID
string ("IncludeModel" | "LiveConnect")
The type of download. Valid values are LiveConnect and IncludeModel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GENERATE_A_TILE_EMBED_TOKENGenerate an embed token to view the specified tile in a workspace. Only relevant to the embed-for-your-customers scenario; supports service principal profiles. Required delegated scopes: (Dashboard.Read.All or Dashboard.ReadWrite.All) AND (Report.Read.All or Report.ReadWrite.All) AND (Dataset.Read.All or Dataset.ReadWrite.All). Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Tiles_GenerateTokenInGroup.

Input Parameters

string
required
The tile ID
string
required
The workspace ID
string
required
The dashboard ID
object
required
Generate token parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GENERATE_DASHBOARD_EMBED_TOKENGenerates an embed token to view or edit the specified dashboard from the specified workspace. Use this action when you need to generate an embed token to embed a Power BI dashboard in your application. The token allows you to embed the dashboard with the specified access level. You can also configure row-level security (RLS) by providing identities. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The workspace ID
string
The dataset ID used for report creation. Only applies when you generate an embed token for report creation.
array
A list of identities to use for row-level security rules.
string ("View" | "Edit" | "Create")
required
The required access level for embed token generation.
boolean
Whether an embedded report can be saved as a new report. The default value is false. Only applies when you generate an embed token for report embedding.
string
required
The dashboard ID
integer
The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the expiration time of a token, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will be ignored, resulting in the default expiration time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GENERATE_EMBED_TOKENGenerates an embed token for multiple reports, datasets, and target workspaces. Use this action when you need to generate an embed token to embed Power BI reports, dashboards, or visuals in your application. Reports and datasets do not have to be related. The token can include identities for row-level security (RLS) and single sign-on (SSO) data sources.

Input Parameters

array
A list of reports to include in the embed token. Reports and datasets do not have to be related.
array
A list of datasets to include in the embed token. Datasets and reports do not have to be related.
array
The list of identities to use for row-level security rules.
array
The list of workspaces that the embed token will allow saving to.
integer
The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the token’s expiration time, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will set the default expiration time.
array
List of identities to use when connecting to data sources with Single Sign-On (SSO) enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GENERATE_REPORT_TOKEN_IN_GROUPGenerates an embed token to view or edit the specified report from the specified workspace. Use this action when you need to generate an embed token to embed a Power BI report in your application. The token allows you to control the access level (View, Edit, or Create) for the embedded report. You can also configure row-level security (RLS) by providing identities, customize the token lifetime, and enable the allowSaveAs option for saving embedded reports as new reports. Required Scope: Report.ReadWrite.All or Report.Read.All

Input Parameters

string
required
The workspace ID
string
required
The report ID
string
The dataset ID used for report creation. Only applies when you generate an embed token for report creation.
array
A list of identities to use for row-level security rules.
string ("View" | "Edit" | "Create")
required
The required access level for embed token generation.
boolean
Whether an embedded report can be saved as a new report. The default value is false. Only applies when you generate an embed token for report embedding.
integer
The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the expiration time of a token, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will be ignored, resulting in the default expiration time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GENERATE_TOKEN_IN_GROUPGenerates an embed token based on the specified dataset from the specified workspace. Use this action when you need to generate an embed token to embed Power BI reports or dashboards using a specific dataset from a workspace in your application. The token allows you to control the access level (View, Edit, or Create) for the embedded content. You can also configure row-level security (RLS) by providing identities, and customize the token lifetime. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The workspace ID
string
required
The dataset ID
array
A list of identities to use for row-level security rules.
string ("View" | "Edit" | "Create")
required
The required access level for embed token generation.
boolean
Whether an embedded report can be saved as a new report. The default value is false. Only applies when you generate an embed token for report embedding.
string
The dataset ID used for report creation. Only applies when you generate an embed token for report creation.
integer
The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the expiration time of a token, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will be ignored, resulting in the default expiration time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_CAPACITY_REFRESHABLE_AS_ADMINReturn a capacity refreshable and its refresh statistics as an admin. Requires a Fabric administrator or service principal. Delegated authentication requires Tenant.Read.All or Tenant.ReadWrite.All; these permissions must not be configured on the app for service-principal authentication. Limited to 200 requests per hour. History covers seven days, up to sixty refreshes per dataset. Returns a refreshables list even though the path identifies one item. https://learn.microsoft.com/en-us/rest/api/power-bi/admin/get-refreshable-for-capacity

Input Parameters

string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports capacities and groups.
string
required
The capacity ID
string
required
The refreshable ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_CAPACITY_WORKLOAD_STATEGet a capacity workload state. Returns the current state of a workload. If the workload is enabled, the percentage of maximum memory that the workload can consume is also returned. Workload APIs aren’t relevant for Gen2 capacities. Required delegated scopes: Capacity.Read.All or Capacity.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/get-workload.

Input Parameters

string
required
The capacity ID
string
required
The name of the workload

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_DASHBOARD_FROM_AN_APPGet a dashboard from an app. Returns the specified dashboard from the specified app. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All. Service principal authentication isn’t supported. Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-dashboard.

Input Parameters

string
required
The app ID
string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_DASHBOARD_IN_A_WORKSPACEGet a dashboard in a workspace. Returns the specified dashboard from the specified workspace. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetDashboardInGroup.

Input Parameters

string
required
The workspace ID
string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_DASHBOARD_TILE_IN_A_WORKSPACEGet a dashboard tile in a workspace. Returns the specified tile within the specified dashboard from the specified workspace. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetTileInGroup.

Input Parameters

string
required
The tile ID
string
required
The workspace ID
string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_DASHBOARD_TILE_IN_MY_WORKSPACEGet a dashboard tile in My workspace. Returns the specified tile within the specified dashboard from My workspace. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetTile.

Input Parameters

string
required
The tile ID
string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_DEPLOYMENT_PIPELINEGet a deployment pipeline. Returns the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipeline.

Input Parameters

string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports stages.
string
required
The deployment pipeline ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_GATEWAY_DATA_SOURCEGet a gateway data source. Returns the specified data source from the specified gateway. Requires gateway admin permissions. Virtual network (VNet) gateways aren’t supported. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_GetDatasource.

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.
string
required
The data source ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_AN_IMPORT_IN_A_WORKSPACEGet an import in a workspace. Returns the specified import from the specified workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Imports_GetImportInGroup.

Input Parameters

string
required
The workspace ID
string
required
The import ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_AN_INSTALLED_APPGet an installed app. Returns the specified installed app. Required delegated scopes: App.Read.All. Service principal authentication isn’t supported. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetApp.

Input Parameters

string
required
The app ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_AN_ORGANIZATION_WORKSPACE_AS_ADMINGet an organization workspace as admin. Returns a workspace for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_GetGroupAsAdmin.

Input Parameters

string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports users, reports, dashboards, datasets, dataflows, and workbooks.
string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_REPORT_FROM_AN_APPGet a report from an app. Returns the specified report from the specified app. Service principal authentication isn’t supported. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetReport.

Input Parameters

string
required
The app ID
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_REPORT_IN_A_WORKSPACEGet a report in a workspace. Returns the specified report from the specified workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetReportInGroup.

Input Parameters

string
required
The workspace ID
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_SERVICE_PRINCIPAL_PROFILEGet a service-principal profile. Returns the specified profile if it exists and belongs to the calling service principal. Can only be called by a service principal. Required delegated scopes: No delegated scope declared; see provider authentication requirements. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_GetProfile.

Input Parameters

string
required
The service principal profile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_A_TILE_FROM_AN_APP_DASHBOARDGet a tile from an app dashboard. Returns the specified tile within the specified dashboard from the specified app. Supported tiles include datasets and live tiles containing an entire report page. Service principal authentication is not supported. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-tile.

Input Parameters

string
required
The app ID
string
required
The tile ID
string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_AVAILABLE_FEATURE_BY_NAMEReturns the specified available feature for the user by name. Use this action when you need to check the availability and status of a specific Power BI feature, such as embedTrial. This API call doesn’t require any scopes. Note: The featureName path parameter should be URL-encoded if it contains special characters.

Input Parameters

string
required
The feature name to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_CAPACITIESLists 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_CAPACITY_WORKLOAD_STATESList workload states for a capacity, including the memory percentage of enabled workloads. Workload APIs are not relevant for Gen2 capacities. Required delegated scope: Capacity.Read.All or Capacity.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/get-workloads

Input Parameters

string
required
The capacity ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DASHBOARD2Returns the specified dashboard from My workspace. Use when you need to retrieve details about a specific dashboard from the current user’s personal workspace in Power BI. This is useful for getting dashboard metadata, embed URLs, or user permissions. Required Scope: Dashboard.ReadWrite.All or Dashboard.Read.All

Input Parameters

string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DASHBOARDSReturns a list of dashboards from the specified workspace. Use this action when you need to retrieve all dashboards within a Power BI workspace. This is useful for exploring workspace contents, finding specific dashboard IDs, or managing dashboard resources. Permissions: This API call can be called by a service principal profile.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Returns a subset of results based on OData filter query parameter condition
string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATAFLOWSLists dataflows in a specified Power BI workspace, with optional filtering and paging; by default the request asks for the first 25 results. This API can be called by a service principal profile and requires Dataflow.Read.All or Dataflow.ReadWrite.All.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Returns a subset of results based on OData filter query parameter condition.
string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATASETReturns the specified dataset from My workspace. Use this action when you need to retrieve details about a specific Power BI dataset in your workspace, including its configuration, permissions, and relationships to other artifacts like dataflows and tables. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATASET2Returns the specified dataset from the specified workspace. Use this action when you need to retrieve details about a specific Power BI dataset in a workspace, including its configuration, permissions, and relationships to other artifacts like dataflows and tables. Permissions: This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATA_SET_DATAExecutes a fixed synthetic DAX query against a specified Power BI dataset and returns the first result table’s rows and available column definitions. The query produces a status or dummy row rather than retrieving dataset table contents.

Input Parameters

string
required
The key (GUID or path) that uniquely identifies the DataSet. GUID example: 01234567-89ab-cdef-0123-456789abcdef. Path example: path=‘/folder1/folder2/item’. If the path contains single quotes, escape them by adding another single quote.
integer
Specifies the maximum number of rows to return from the query.
array
An array of DataSet parameters to use when executing the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATASETSReturns a list of datasets from My workspace. Use when you need to retrieve all datasets available in the authenticated user’s personal workspace, including their configuration and metadata. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

integer
Returns only the first n results. Use with skip for pagination.
integer
Skips the first n results. Use with top for pagination.
string
Expands related entities inline (e.g., ‘schema,tables,relationships’).
string
Returns a subset of results based on OData filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATA_SETSGets an array of DataSet CatalogItems from Power BI. Use when you need to retrieve all available datasets from the Power BI service, including their metadata such as creation date, modified date, owner, and dataset-specific properties like query timeout and parameters. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

integer
Show only the first n items. See OData Paging - Top.
integer
Skip the first n items. See OData Paging - Skip.
string
Include count of items. See OData Count.
string
Filter items by property values. See OData Filtering.
string
Select properties to be returned. See OData Select.
string
Order items by property values. See OData Sorting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATASET_USERSReturns a list of principals that have access to the specified dataset. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI dataset. This is useful for auditing dataset permissions, managing access control, or understanding who can view or modify the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available.

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATASET_USERS_IN_GROUPReturns a list of principals that have access to the specified dataset within a workspace. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI dataset within a workspace. This is useful for auditing dataset permissions, managing access control, or understanding who can view or modify the dataset in a group context. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available.

Input Parameters

string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATASOURCESReturns a list of data sources for the specified dataset from My workspace. Use when you need to retrieve all data source connections configured for a specific Power BI dataset, such as when auditing data sources, troubleshooting refresh issues, or understanding dataset dependencies. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_DATASOURCES_IN_GROUP3Returns a list of data sources for the specified dataset from the specified workspace. Use when you need to retrieve all data source connections configured for a specific Power BI dataset within a workspace, such as when auditing data sources, troubleshooting refresh issues, or understanding dataset dependencies. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GATEWAYReturns the specified gateway. Use this action when you need to retrieve details about a specific Power BI gateway, including its status, type, and public key for encryption. Permissions: The user must have gateway admin permissions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GATEWAY_DATASOURCES_IN_GROUPReturns a list of gateway data sources for the specified dataset from the specified workspace. Use this action when you need to retrieve all gateway data source connections configured for a specific Power BI dataset within a workspace. This is useful for auditing data source configurations, troubleshooting refresh issues, or understanding dataset dependencies. This API is deprecated - use Get Datasources In Group instead.

Input Parameters

string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GATEWAYSReturns a list of gateways for which the user is an admin. Use this action when you need to retrieve all Power BI gateways that you have administrative permissions for. This is useful for monitoring gateway status, managing data sources, or administering on-premises data gateway configurations. Gateway admin permissions are required to access this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GOALSReturns a list of goals from a scorecard. Use this action when you need to retrieve all goals defined within a Power BI scorecard. This is useful for understanding the organizational objectives and key results (OKRs) tracked in Power BI, finding specific goal IDs, or monitoring progress against targets. This API call can be called by a service principal profile. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All

Input Parameters

string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports goalValues and aggregations.
string
Allows the clients to select specific properties from the server.
string
required
The unique identifier of the workspace
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GOALS_REFRESH_HISTORYReads refresh history of a connected goal. Use this action when you need to retrieve the refresh history for a specific Power BI goal to monitor refresh performance, identify failed refreshes, or audit refresh operations on goals. This endpoint is part of the Power BI Goals (Preview) API. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All Note: This is a preview API and may be subject to changes.

Input Parameters

string
required
The unique identifier of the goal to get refresh history for
string
required
The unique identifier of the workspace (group) containing the scorecard and goal
string
required
The unique identifier of the scorecard containing the goal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GOALS_STATUS_RULESReturns status rules of a goal. Use this action when you need to retrieve the status rules configuration for a specific Power BI goal within a scorecard. Status rules determine how goal status is calculated based on conditions (e.g., if actual value > 50% of target, status is “On track”). This action supports reading both simple expression-based conditions and complex field comparison conditions. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All

Input Parameters

string
required
The unique identifier of the goal
string
required
The unique identifier of the workspace
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GOAL_VALUE_BY_IDReads a goal value check-in by a UTC date timestamp. Use this action when you need to retrieve a specific goal value check-in from a Power BI scorecard. This is useful for tracking historical goal values, reviewing notes on goal progress, or analyzing trends. The timestamp must be provided in UTC format (e.g., 2024-05-12T00:00:00Z). Required Scope: Dataset.Read.All or Dataset.ReadWrite.All

Input Parameters

string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports notes.
string
required
The unique identifier of the goal
string
required
The unique identifier of the workspace
string
required
The timestamp for the value of the goal. Use UTC format (e.g., 2024-05-12T00:00:00Z)
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GROUPSLists 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.

Input Parameters

integer
Returns only the first n results. Defaults to 25 if not specified.
integer
Skips the first n results.
string
Returns a subset of results based on OData filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GROUPS_CAPACITY_ASSIGNMENT_STATUSGets the status of the assignment-to-capacity operation for the specified workspace. Use this action when you need to check the current status of a workspace assignment operation to a capacity. This is useful for monitoring long-running workspace migrations or diagnosing failed assignments. Required Scope: Workspace.Read.All or Workspace.ReadWrite.All

Input Parameters

string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_GROUP_USERSReturns a list of users that have access to the specified workspace. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI workspace. This is useful for auditing workspace permissions, managing access control, or understanding who can view or modify the workspace contents. Permissions: This API call can be called by a service principal profile.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_IMPORTReturns the specified import from My workspace. Use this action when you need to retrieve details about a specific import in your Power BI workspace, including its status, associated datasets, and reports. This is useful for tracking import operations, checking whether an import succeeded or failed, and identifying related artifacts. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The import ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_IMPORTS2Returns a list of imports from My workspace. Use this action when you need to retrieve all imports in the authenticated user’s personal workspace, including their status, associated datasets, and reports. This is useful for monitoring import operations, checking import completion status, or listing imported content in your workspace. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_IMPORTS_IN_GROUPReturns a list of imports from the specified workspace. Use this action when you need to retrieve all imports in a Power BI workspace to monitor import status, list imported datasets and reports, or check for failed imports. This API can be called by a service principal profile with appropriate workspace permissions.

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_LINKED_REPORT_HISTORY_SNAPSHOTGets requested HistorySnapshot item specified by HistoryId of the LinkedReport specified by Id. Use this action when you need to retrieve a specific history snapshot for a Power BI LinkedReport. History snapshots capture the state of a report at a particular point in time and can be used for auditing, versioning, or recovery purposes. This is a read-only operation that returns snapshot metadata including creation date, snapshot ID, and size information.

Input Parameters

string
required
The key (GUID or path) that uniquely identifies the LinkedReport. GUID example: 01234567-89ab-cdef-0123-456789abcdef. Path example: path=‘/folder1/folder2/item’. If the path contains a single quote, escape it by adding another single quote.
string
required
The Id property of the HistorySnapshot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_MY_WORKSPACE_CAPACITY_STATUSGet My workspace capacity assignment status. Gets the status of the My workspace assignment-to-capacity operation. Required delegated scopes: Workspace.Read.All AND Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_CapacityAssignmentStatusMyWorkspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_PAGEReturns the specified page within the specified report from the specified workspace. Use this action when you need to retrieve details about a specific page within a Power BI report. This is useful for exploring report structure, getting page metadata, or identifying the order of pages in a report. Permissions: This API call can be called by a service principal profile.

Input Parameters

string
required
The workspace ID
string
required
The page name
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_PAGESReturns a list of pages within the specified report from the specified workspace. Use this action when you need to retrieve all pages in a Power BI report to understand the report structure, navigate between pages, or manage report content. This API call can be called by a service principal profile. Required Scope: Report.ReadWrite.All or Report.Read.All

Input Parameters

string
required
The workspace ID
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_PAGES_IN_MY_WORKSPACEReturns a list of pages within the specified report from My workspace. Use this action when you need to retrieve all pages in a Power BI report that belongs to your personal workspace. This is useful for understanding the report structure, navigating between pages, or managing report content. Required Scope: Report.ReadWrite.All or Report.Read.All

Input Parameters

string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_PARAMETERSReturns 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.

Input Parameters

string
required
The unique identifier of the Power BI dataset in My Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_PARAMETERS_IN_GROUP2Returns a list of parameters for the specified dataset from the specified workspace. Use this action when you need to retrieve all parameter definitions and their current values for a Power BI dataset within a specific workspace, including whether each parameter is required, its data type, and any suggested values. This is useful for auditing dataset configuration, understanding data source connections, or preparing to update parameter values in a workspace context. This API call can be called by a service principal profile with appropriate workspace permissions. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The unique identifier of the Power BI dataset in the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_PIPELINE_OPERATION_DETAILSGet deployment operation details and execution plan. Returns the details of the specified deploy operation performed on the specified deployment pipeline, including the deployment execution plan. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineOperation.

Input Parameters

string
required
The deployment pipeline ID
string
required
The operation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_QUERY_SCALE_OUT_SYNC_STATUS_2Returns the query scale-out sync status for the specified dataset from the specified workspace. Use this action when you need to check the synchronization status of read-only replicas for a dataset that supports query scale-out. This includes information about commit versions, active read timestamps, and the current sync status. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REFRESHABLE_CAPACITY_2Returns the specified refreshable for the specified capacity that the user has access to. Use this action when you need to retrieve details about a specific refreshable item (dataset) within a capacity, including refresh history, schedules, and status. Power BI retains a seven-day refresh history for each dataset, up to a maximum of sixty refreshes. Required Scope: Capacity.Read.All or Capacity.ReadWrite.All

Input Parameters

array
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports ‘capacities’ and ‘groups’.
string
required
The capacity ID
string
required
The refreshable ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REFRESHABLESReturns a list of refreshables for all capacities that the user has access to. Use when you need to retrieve information about datasets and dataflows that have refresh schedules or refresh history across all Power BI capacities. Power BI retains a seven-day refresh history for each dataset, up to a maximum of sixty refreshes. This action is useful for monitoring refresh performance, identifying failed refreshes, and auditing refresh schedules across the organization.

Input Parameters

integer
Returns only the first n results.
integer
Skips the first n results. Use with top to fetch results beyond the first 1000.
string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports capacity and group.
string
Returns a subset of results based on OData filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REFRESH_EXECUTION_DETAILS_IN_GROUPReturns execution details of a refresh operation for the specified dataset from the specified workspace. Use this action when you need to retrieve detailed information about a dataset refresh operation within a workspace, including timing, status, errors, and any retry attempts. This is useful for monitoring refresh operations, troubleshooting failed refreshes, and auditing refresh history. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The dataset ID.
string
required
The refresh ID that identifies the specific refresh operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REFRESH_HISTORYReturns the refresh history for the specified dataset from My workspace. Use when you need to retrieve the refresh history of a specific Power BI dataset to monitor refresh performance, identify failed refreshes, or audit refresh operations. Power BI retains between 20-60 available refresh history entries depending on the number of refreshes in the last 3 days. The most recent 60 entries are kept if they are all less than 3 days old. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: OneDrive refresh history isn’t returned by this endpoint.

Input Parameters

integer
The requested number of entries in the refresh history. If not provided, the default is the last available 60 entries.
string
required
The dataset ID of the dataset to get refresh history for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULEReturns the refresh schedule for the specified dataset from My workspace. Use when you need to retrieve the current refresh schedule configuration for a dataset, including the days, times, and notification settings. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULE_IN_GROUP2Returns the refresh schedule for the specified dataset from the specified workspace. Use this action when you need to retrieve the current refresh schedule configuration for a dataset within a specific Power BI workspace, including the days, times, and notification settings. This action is read-only and idempotent. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: This API can be called by a service principal profile.

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The dataset ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REPORT3Returns the specified report from My workspace. Use this action when you need to retrieve details about a specific Power BI report from your personal workspace, including its metadata, embed URL, ownership information, and associated dataset. Required Scope: Report.ReadWrite.All or Report.Read.All

Input Parameters

string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REPORT_PAGE2Returns the specified page within the specified report from My workspace. Use this action when you need to retrieve details about a specific page within a Power BI report in your personal workspace. This is useful for exploring report structure, getting page metadata, or identifying the order of pages in a report. Required Scope: Report.ReadWrite.All or Report.Read.All

Input Parameters

string
required
The page name
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REPORTSGets reports from the configured Power BI endpoint, with optional OData filtering, sorting, selection, and pagination parameters. Requires Report.Read.All or Report.ReadWrite.All.

Input Parameters

integer
Show only the first n items. See OData Paging - Top.
integer
Skip the first n items. See OData Paging - Skip.
string
Include count of items. See OData Count.
string
Filter items by property values. See OData Filtering.
string
Select properties to be returned. See OData Select.
string
Order items by property values. See OData Sorting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_REPORTS3Returns a list of reports from My workspace. Use this action when you need to retrieve all reports from your personal Power BI workspace. This also returns shared reports and reports from shared apps. This is useful for exploring your personal workspace contents, finding specific report IDs, or managing report resources. Required Scope: Report.ReadWrite.All or Report.Read.All Note: Service principal authentication isn’t supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_RESOURCESLists Power BI datasets in My workspace, with optional query parameters for filtering and pagination.

Input Parameters

integer
Show only the first n items, see OData Paging - Top
integer
Skip the first n items, see OData Paging - Skip
boolean
Include count of items, see OData Count
string
Filter items by property values, see OData Filtering

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_SCORECARD_BY_IDRetrieves a Power BI scorecard by ID within a workspace, with optional OData expansion for related goals, goal values and aggregations. Requires Dataset.Read.All or Dataset.ReadWrite.All.

Input Parameters

string
Accepts a comma-separated list of data types to expand inline in the response. Supports: goals, goalValues, aggregations, notes
string
required
The unique identifier of the workspace
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_SCORECARDSReturns a list of scorecards from a workspace. Use this action when you need to retrieve all scorecards within a Power BI workspace. This is useful for exploring workspace goals, finding specific scorecard IDs, or managing scorecard resources. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All

Input Parameters

integer
Returns only the first n results.
string
required
The unique identifier of the workspace (group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_TABLESReturns a list of tables within the specified dataset from My workspace. Use this action when you need to retrieve the schema, columns, measures, and other structural metadata of tables within a Power BI dataset. This is useful for understanding the data model, exploring available fields, or preparing to write DAX expressions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_TABLES_IN_GROUPReturns a list of tables within the specified dataset from the specified workspace. Use when you need to retrieve the schema, columns, measures, and other structural metadata of tables within a Power BI dataset in a specific workspace. This is useful for understanding the data model, exploring available fields, or preparing to write DAX expressions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: This API only supports push datasets.

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_TILES2Returns a list of tiles within the specified dashboard from My workspace. Use this action when you need to retrieve all tiles (visualizations) from a specific dashboard in My workspace. Supported tiles include datasets and live tiles that contain an entire report page. This is useful for understanding what content exists in a dashboard or for enumerating dashboard elements. Required Scope: Dashboard.Read.All or Dashboard.ReadWrite.All

Input Parameters

string
required
The dashboard ID (UUID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_TILES3Returns a list of tiles within the specified dashboard from the specified workspace. Use this action when you need to retrieve all tiles (visualizations) from a specific dashboard within a Power BI workspace. Supported tiles include datasets and live tiles that contain an entire report page. This is useful for understanding what content exists in a dashboard or for enumerating dashboard elements. Required Scope: Dashboard.Read.All or Dashboard.ReadWrite.All

Input Parameters

string
required
The workspace (group) ID
string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_WORKSPACEReturns a specified workspace (group). Use this action when you need to retrieve details about a specific Power BI workspace, including its name, capacity configuration, storage settings, and Log Analytics workspace integration. Permissions: This API call can be called by a service principal profile. Required Scope: Workspace.Read.All or Workspace.ReadWrite.All

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_WORKSPACE_METADATA_SCAN_RESULTSGet workspace metadata scan results after GetScanStatus reports success. Results remain available for 24 hours. Requires a Fabric administrator or a service principal. Maximum 500 requests per hour. Delegated authentication requires Tenant.Read.All or Tenant.ReadWrite.All; service principals must not have admin-consent-required Power BI permissions configured in Azure. See https://learn.microsoft.com/en-us/rest/api/power-bi/admin/workspace-info-get-scan-result.

Input Parameters

string
required
The scan ID, which is included in the response from the workspaces or the Admin - WorkspaceInfo PostWorkspaceInfo API call that triggered the scan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_WORKSPACE_METADATA_SCAN_STATUSGet workspace metadata scan status. Gets the scan status for the specified scan. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation WorkspaceInfo_GetScanStatus.

Input Parameters

string
required
The scan ID, which is included in the response from the workspaces or the Admin - WorkspaceInfo PostWorkspaceInfo API call that triggered the scan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GET_WORKSPACE_REPORT_EXPORT_JOB_STATUSGet workspace report export job status. Returns the current status of the Export to File In Group job for the specified report from the specified workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetExportToFileStatusInGroup.

Input Parameters

string
required
The workspace ID
string
required
The export ID
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GRANT_DEPLOYMENT_PIPELINE_PERMISSIONSGrant deployment pipeline permissions. Grants user permissions to the specified deployment pipeline. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_UpdatePipelineUser.

Input Parameters

string
required
The deployment pipeline ID
object
required
Details of user access right

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GRANT_GATEWAY_DATASOURCE_PERMISSIONSGrant or update gateway data source user permissions. Grants or updates the permissions required to use the specified data source for the specified user. Requires gateway admin permissions. Virtual network (VNet) gateways and adding groups are not supported. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_AddDatasourceUser.

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.
string
required
The data source ID
object
required
The add user to data source request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GRANT_WORKSPACE_PERMISSIONS_AS_ADMINGrant workspace permissions as admin. Grants user permissions to the specified workspace. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_AddUserAsAdmin.

Input Parameters

string
required
The workspace ID
object
required
Workspace right and identity: supply emailAddress or both identifier and principalType (UPN for User, object ID for Group/App).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_GRANT_WORKSPACE_PERMISSIONS_TO_A_USERGrant workspace permissions to a user. Grants the specified user the specified permissions to the specified workspace. Required delegated scopes: Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_AddGroupUser.

Input Parameters

string
required
The workspace ID
object
required
Workspace right and identity: supply emailAddress or both identifier and principalType (UPN for User, object ID for Group/App).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_IMPORT_NEW_CONTENT_INTO_A_WORKSPACEImport .pbix, .json, .xlsx or .rdl content into the specified workspace. Supply a platform file reference for multipart upload, or JSON importInfo for OneDrive for Business Excel / a pre-uploaded large PBIX temporary blob. This action resolves files through the platform adapter; ImportInfo URLs are sent to Power BI without fetching them. Large PBIX (1–10 GB) needs Premium capacity. Service principals cannot import dataflows or protected sensitivity labels; profiles can overwrite only semantic models they own. Returns an import ID (200/202); poll import status for completion. Required scope: Dataset.ReadWrite.All.

Input Parameters

object
File to upload as multipart/form-data; mutually exclusive with importInfo.
string
required
Destination workspace ID.
object
JSON ImportInfo body (not wrapped in an importInfo key); mutually exclusive with file.
boolean
If supplied, must be true. Only supported for .pbix files.
string ("Ignore" | "Abort" | "Overwrite" | "CreateOrOverwrite" | "GenerateUniqueName")
Conflict mode; service default Ignore. RDL supports only Abort or Overwrite.
string
ID of the destination subfolder.
string
Required for file/blob import; include extension (.rdl for paginated reports, model.json for dataflows). Omit for OneDrive for Business.
boolean
Override model sensitivity label when republishing .pbix; service default true.
boolean
Override report sensitivity label when republishing .pbix; service default true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_IMPORT_NEW_CONTENT_INTO_MY_WORKSPACEImport .pbix, .json, .xlsx or .rdl content into My workspace. Upload a platform file reference as multipart, or submit JSON ImportInfo for OneDrive for Business Excel / a pre-uploaded large PBIX temporary blob. ImportInfo URLs are sent to Power BI, never fetched; file references use the platform adapter. Large PBIX (1–10 GB) needs Premium capacity. Service principals cannot import dataflows or protected sensitivity labels. Returns an import ID (200/202); poll import status for completion. Required scope: Dataset.ReadWrite.All.

Input Parameters

object
File to upload as multipart/form-data; mutually exclusive with importInfo.
object
JSON ImportInfo body (not wrapped in an importInfo key); mutually exclusive with file.
boolean
If supplied, must be true. Only supported for .pbix files.
string ("Ignore" | "Abort" | "Overwrite" | "CreateOrOverwrite" | "GenerateUniqueName")
Conflict mode; service default Ignore. RDL supports only Abort or Overwrite.
string
ID of the destination subfolder.
string
Required for file/blob import; include extension (.rdl for paginated reports, model.json for dataflows). Omit for OneDrive for Business.
boolean
Override model sensitivity label when republishing .pbix; service default true.
boolean
Override report sensitivity label when republishing .pbix; service default true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ACCESSIBLE_DATAFLOW_STORAGE_ACCOUNTSList accessible dataflow storage accounts. Returns a list of dataflow storage accounts that the user has access to. Required delegated scopes: StorageAccount.Read.All or StorageAccount.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation DataflowStorageAccounts_GetDataflowStorageAccounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_APP_USERS_AS_ADMINList app users as admin. Returns a list of users that have access to the specified app. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetAppUsersAsAdmin.

Input Parameters

string
required
The app ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_AVAILABLE_FEATURESList available features. Returns a list of available features for the user. This API call does not require any scopes and supports service principal profiles. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation AvailableFeatures_GetAvailableFeatures.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_CAPACITY_REFRESHABLES_AS_ADMINList capacity refreshables as admin. Returns a list of refreshables for the specified capacity that the user has access to. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetRefreshablesForCapacity.

Input Parameters

integer
required
Returns only the first n results.
integer
Skips the first n results. Use with top to fetch results beyond the first 1000.
string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports capacities and groups.
string
Returns a subset of a results based on Odata filter query parameter condition.
string
required
The capacity ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_CAPACITY_USERS_AS_ADMINList users with access to the specified capacity. Requires a Fabric administrator for delegated authentication; delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent-required Power BI permissions configured in Azure. Maximum 200 requests per hour. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Capacities_GetCapacityUsersAsAdmin.

Input Parameters

string
required
The capacity ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DASHBOARDS_FROM_AN_APPList dashboards from an app. Returns a list of dashboards from the specified app. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All. Service principal authentication isn’t supported. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetDashboards.

Input Parameters

string
required
The app ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DASHBOARD_TILES_AS_ADMINReturns tiles within a specified dashboard as a Fabric administrator. Requires a Fabric administrator with delegated Tenant.Read.All or Tenant.ReadWrite.All, or service-principal authentication. For service principals, the app must not have admin-consent-required Power BI permissions configured in the Azure portal; delegated scopes do not apply. Limited to 200 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetTilesAsAdmin.

Input Parameters

string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DASHBOARD_USERS_AS_ADMINList dashboard users as admin. Returns a list of users that have access to the specified dashboard. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetDashboardUsersAsAdmin.

Input Parameters

string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DATAFLOW_DATA_SOURCESList dataflow data sources. Returns a list of data sources for the specified dataflow. Required delegated scopes: Dataflow.Read.All or Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowDataSources.

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DATAFLOW_DATA_SOURCES_AS_ADMINReturns data sources for a dataflow, including deleted sources. Sources may include cloud and on-premises data gateways. Requires a Fabric administrator using delegated authentication, or a service principal. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent required Power BI permissions configured in the Azure portal. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowDatasourcesAsAdmin.

Input Parameters

string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DATAFLOW_TRANSACTIONSList dataflow transactions. Returns a list of transactions for the specified dataflow. Required delegated scopes: Dataflow.Read.All or Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowTransactions.

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DATAFLOW_USERS_AS_ADMINList dataflow users as admin. Returns a list of users that have access to the specified dataflow. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowUsersAsAdmin.

Input Parameters

string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DATASET_DATA_SOURCES_AS_ADMINReturns the data sources for the specified dataset as an administrator. Requires a Fabric administrator or a service principal. Delegated admin tokens require Tenant.Read.All or Tenant.ReadWrite.All. Service-principal apps must not have admin-consent-required Power BI permissions configured in Azure. Limited to 300 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasourcesAsAdmin.

Input Parameters

string
required
The dataset ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DATASETS_IN_A_WORKSPACEList datasets in a workspace. Returns a list of datasets from the specified workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetsInGroup.

Input Parameters

string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DATASET_USERS_AS_ADMINReturn users that have access to the specified dataset. Requires a Fabric administrator or service principal. Delegated tokens need Tenant.Read.All or Tenant.ReadWrite.All. For service principal authentication, the app must not have admin-consent-required Power BI permissions configured. Limited to 200 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetUsersAsAdmin.

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINESList deployment pipelines that the signed-in user has access to. This action takes no parameters. Required scope: Pipeline.Read.All or Pipeline.ReadWrite.All.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINE_STAGE_ARTIFACTSList deployment pipeline stage artifacts. Returns the supported items from the workspace assigned to the specified stage of the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineStageArtifacts.

Input Parameters

string
required
The deployment pipeline ID
integer ("0" | "1" | "2")
required
The deployment pipeline stage order. Development (0), Test (1), Production (2).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINE_STAGESList deployment pipeline stages. Returns the stages of the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineStages.

Input Parameters

string
required
The deployment pipeline ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINE_USERSList deployment pipeline users. Returns a list of users that have access to the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineUsers.

Input Parameters

string
required
The deployment pipeline ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_DEPLOYMENT_PIPELINE_USERS_AS_ADMINList users that have access to a specified deployment pipeline. Requires administrator rights or service-principal authentication. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All. Limited to 200 requests per hour. Provider documentation: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/pipelines-get-pipeline-users-as-admin

Input Parameters

string
required
The deployment pipeline ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_GATEWAY_DATA_SOURCESList gateway data sources. Returns a list of data sources from the specified gateway. Requires gateway admin permissions. Virtual network (VNet) gateways aren’t supported. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_GetDatasources.

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_GATEWAY_DATA_SOURCE_USERSList gateway data source users. Returns a list of users who have access to the specified data source. Requires gateway admin permissions. Virtual network (VNet) gateways aren’t supported. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_GetDatasourceUsers.

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.
string
required
The data source ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_INSTALLED_APPSList apps installed by the signed-in user. This action takes no parameters. Required scope: App.Read.All. Service principal authentication isn’t supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_MY_WORKSPACE_DASHBOARDSList dashboards in the signed-in user’s My workspace, including shared dashboards and dashboards from shared apps. Use Get Dashboards for dashboards in a specified shared workspace. This action takes no parameters. Required scope: Dashboard.Read.All or Dashboard.ReadWrite.All.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_APPS_AS_ADMINList organization apps as admin. Returns a list of apps in the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetAppsAsAdmin.

Input Parameters

integer
required
The requested number of apps.
integer
The number entries to be skipped.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_CAPACITIES_AS_ADMINList organization capacities as admin. Returns a list of capacities for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetCapacitiesAsAdmin.

Input Parameters

string
Expands related entities inline

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_DASHBOARDS_AS_ADMINList organization dashboards as admin. Returns a list of dashboards for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetDashboardsAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports tiles.
string
Returns a subset of a results based on Odata filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_DATAFLOWS_AS_ADMINList organization dataflows as admin. Returns a list of dataflows for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowsAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Returns a subset of a results based on Odata filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_DATASETS_AS_ADMINList organization datasets as admin. Returns a list of datasets for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetsAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Returns a subset of a results based on Odata filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_IMPORTS_AS_ADMINList organization imports as admin. Returns a list of imports for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Imports_GetImportsAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Expands related entities inline
string
Returns a subset of a results based on Odata filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_REFRESHABLES_AS_ADMINList organization refreshables as admin. Returns a list of refreshables for the organization within a capacity. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetRefreshables.

Input Parameters

integer
required
Returns only the first n results.
integer
Skips the first n results. Use with top to fetch results beyond the first 1000.
string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports capacities and groups.
string
Returns a subset of a results based on Odata filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_REPORTS_AS_ADMINList reports across the organization, optionally filtered and paginated. Requires a Fabric administrator or service principal. Delegated tokens require Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent-required Power BI permissions configured in Azure. Limited to 50 requests per hour or 5 requests per minute per tenant. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetReportsAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Returns a subset of a results based on Odata filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_ORGANIZATION_WORKSPACES_AS_ADMINList organization workspaces as admin. Returns a list of workspaces for the organization. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_GetGroupsAsAdmin.

Input Parameters

integer
required
Returns only the first n results. This parameter is mandatory and must be in the range of 1-5000.
integer
Skips the first n results. Use with top to fetch results beyond the first 5000.
string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports users, reports, dashboards, datasets, dataflows, and workbooks.
string
Returns a subset of a results based on Odata filter query parameter condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_PIPELINE_OPERATIONSList recent deployment pipeline operations. Returns a list of the up-to-20 most recent deploy operations performed on the specified deployment pipeline. Required delegated scopes: Pipeline.Read.All or Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_GetPipelineOperations.

Input Parameters

string
required
The deployment pipeline ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_POWER_BI_ITEMS_ACCESSIBLE_BY_A_USERList Power BI items accessible by a user. Returns a list of Power BI items (such as reports or dashboards) that the specified user has access to. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Users_GetUserArtifactAccessAsAdmin.

Input Parameters

string
required
The graph ID or user principal name (UPN) of the user
string
Comma separated list of artifact types.
string
Token required to get the next chunk of the result set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_POWER_BI_ITEMS_PUBLISHED_TO_THE_WEBList Power BI items published to the web. Returns a list of Power BI items (such as reports or dashboards) that are published to the web. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation WidelySharedArtifacts_PublishedToWeb.

Input Parameters

string
Token required to get the next chunk of the result set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_REFRESHABLES_FOR_A_CAPACITYList refreshables for a capacity. Returns a list of refreshables for the specified capacity that the user has access to. Required delegated scopes: Capacity.Read.All or Capacity.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Capacities_GetRefreshablesForCapacity.

Input Parameters

integer
required
Returns only the first n results.
integer
Skips the first n results. Use with top to fetch results beyond the first 1000.
string
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports capacities and groups.
string
Returns a subset of a results based on Odata filter query parameter condition.
string
required
The capacity ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_REPORTS_IN_A_WORKSPACEList reports in a workspace. Returns a list of reports from the specified workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetReportsInGroup.

Input Parameters

string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_REPORT_USERS_AS_ADMINList users that have access to the specified report. Requires a Fabric administrator or service principal. For delegated admin access, requires Tenant.Read.All or Tenant.ReadWrite.All. For service-principal authentication, the app must not have admin-consent-required Power BI permissions configured in Azure. Maximum 200 requests per hour. https://learn.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-report-users-as-admin

Input Parameters

string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_SERVICE_PRINCIPAL_PROFILESList service-principal profiles belonging to the calling service principal. Can only be called by a service principal. Required delegated scopes: No delegated scope declared; see provider authentication requirements. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Profiles_GetProfiles.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Get a profile by DisplayName

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_TENANT_AUDIT_ACTIVITY_EVENTSList one page of audit activity events for a tenant. Provide a continuation token or both single-quoted start and end UTC timestamps in the same day within the last 28 days. Use the returned continuationToken to retrieve subsequent pages. Requires a Fabric administrator or an authorized service principal. Maximum 200 requests per hour; Microsoft Cloud Deutschland is unsupported. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All. These scopes apply only to delegated admin tokens; service principals must not have admin-consent-required Power BI permissions configured in Azure. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetActivityEvents.

Input Parameters

string
Filters the results based on a boolean condition, using ‘Activity’, ‘UserId’, or both properties. Supports only ‘eq’ and ‘and’ operators.
string
End of the audit window as a single-quoted ISO 8601 UTC timestamp. Must be in the same UTC day as startDateTime, within the last 28 days.
string
Start of the audit window as a single-quoted ISO 8601 UTC timestamp. Supply both start and end, in the same UTC day within the last 28 days, or use continuationToken.
string
Token required to get the next chunk of the result set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_TENANT_ENCRYPTION_KEYSList the tenant’s encryption key metadata. Requires a Fabric administrator with delegated Tenant.Read.All or Tenant.ReadWrite.All, or service-principal authentication. A service-principal app must not have admin-consent-required Power BI permissions configured in Azure. Limited to 200 requests per hour. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_GetPowerBIEncryptionKeys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_TILES_FROM_AN_APP_DASHBOARDList tiles from an app dashboard. Returns a list of tiles within the specified dashboard from the specified app. Service principal authentication isn’t supported. Required delegated scopes: Dashboard.Read.All or Dashboard.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Apps_GetTiles.

Input Parameters

string
required
The app ID
string
required
The dashboard ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_UPSTREAM_DATAFLOWSList upstream dataflows. Returns a list of upstream dataflows for the specified dataflow. Required delegated scopes: Dataflow.Read.All or Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetUpstreamDataflowsInGroup.

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_UPSTREAM_DATAFLOWS_AS_ADMINList upstream dataflows as admin. Returns a list of upstream dataflows for the specified dataflow. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetUpstreamDataflowsInGroupAsAdmin.

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_WORKSPACE_DASHBOARDS_AS_ADMINList workspace dashboards as admin. Returns a list of dashboards from the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dashboards_GetDashboardsInGroupAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Returns a subset of a results based on Odata filter query parameter condition.
string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_WORKSPACE_DATAFLOWS_AS_ADMINReturn dataflows from the specified workspace as a Fabric administrator or service principal. Supports OData filtering and top/skip pagination. Maximum 200 requests per hour. Delegated authentication requires Tenant.Read.All or Tenant.ReadWrite.All. Service principals must not have admin-consent-required Power BI permissions configured in Azure; delegated scopes do not apply to them. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_GetDataflowsInGroupAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Returns a subset of a results based on Odata filter query parameter condition.
string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_WORKSPACE_DATASETS_AS_ADMINList workspace datasets as admin. Returns a list of datasets from the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDatasetsInGroupAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Expands related entities inline
string
Returns a subset of a results based on Odata filter query parameter condition.
string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_WORKSPACE_REPORTS_AS_ADMINList workspace reports as admin. Returns a list of reports from the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetReportsInGroupAsAdmin.

Input Parameters

integer
Returns only the first n results
integer
Skips the first n results
string
Returns a subset of a results based on Odata filter query parameter condition.
string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_LIST_WORKSPACE_USERS_AS_ADMINList workspace users as admin. Returns a list of users that have access to the specified workspace. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_GetGroupUsersAsAdmin.

Input Parameters

string
required
The workspace ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MICROSOFT_POWER_BI_DATASETS_TRIGGER_QUERY_SCALE_OUT_SYNC_IN_GROUPTriggers a query scale-out sync of read-only replicas for the specified dataset from the specified workspace. Use this action when you need to manually synchronize read-only replicas for a dataset in a specific Power BI workspace. This is typically used for maintenance or to ensure all replicas are synchronized before performing administrative operations. The sync operation ensures that read-only replicas have the latest data from the primary dataset. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MOVE_GOALSMoves goals within the scorecard. Changes their ranks and parents. Use when you need to reorganize the goal hierarchy in a Power BI scorecard, such as reordering goals within the same parent, moving a goal to a different parent, or repositioning a goal among its siblings. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The unique identifier of the workspace (group)
object
Rank validation information for a Power BI goal. The caller provides validation information to confirm that they know the existing position of the goal within the hierarchy of goals.
object
Rank validation information for a Power BI goal. The caller provides validation information to confirm that they know the existing position of the goal within the hierarchy of goals.
object
required
The goal to move and its current position validation information
object
Rank validation information for a Power BI goal. The caller provides validation information to confirm that they know the existing position of the goal within the hierarchy of goals.
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_ADD_DATASET_ROWSAdd rows to a push dataset table in My workspace. Adds new data rows to the specified table within the specified dataset from My workspace. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_PostRows.

Input Parameters

string
required
The dataset ID
string
required
The table name
object
required
The request message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_BIND_DATASET_TO_GATEWAYBind a dataset in My workspace to a gateway. Binds the specified dataset from My workspace to the specified gateway, optionally with a given set of data source IDs. If you don’t supply a specific data source ID, the dataset will be bound to the first matching data source in the gateway. Only supports the on-premises data gateway. Add the API caller principal as a data source user on the gateway before calling. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_BindToGateway.

Input Parameters

string
required
The dataset ID
object
required
The bind to gateway request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_BIND_RDL_REPORT_TO_GATEWAYBind a paginated report data source in My workspace to a gateway. Binds the specified data source of the paginated report from My workspace to the specified gateway, optionally with a given data source ID. If you don’t supply a specific data source ID, the data source will be bound to the first matching data source in the gateway. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_BindToGateway.

Input Parameters

string
required
The report ID
object
required
The bind to gateway request payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_DISCOVER_DATASET_GATEWAYSDiscover gateways for a dataset in My workspace. Returns a list of gateways that the specified dataset from My workspace can be bound to. Only relevant to datasets with at least one on-premises connection; cloud-only datasets return an empty list. Required delegated scopes: Dataset.Read.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_DiscoverGateways.

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_DOWNLOAD_REPORT_EXPORTRetrieve the completed export-job file for a report in My workspace as a platform-managed downloadable file reference, with content metadata. Poll export status until Succeeded before downloading. Required delegated scope: Report.Read.All or Report.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/reports/get-file-of-export-to-file

Input Parameters

string
required
The export ID
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_EXPORT_REPORT_SOURCEExport a report from My workspace as a downloadable PBIX or RDL file reference. Requires Report.ReadWrite.All or both Report.Read.All and Dataset.Read.All. PBIX export is unsupported after rebinding a report with a Power BI service live connection. Large exports may contain a temporary blob URL in the file; this action stores the downloaded file without following that URL. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_ExportReport.

Input Parameters

string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_GET_DATASET_REFRESH_DETAILSGet dataset refresh execution details in My workspace. Returns execution details of a refresh operation for the specified dataset from My workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetRefreshExecutionDetails.

Input Parameters

string
required
The dataset ID
string
required
The refresh ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_GET_DIRECT_QUERY_SCHEDULEGet a DirectQuery refresh schedule in My workspace. Returns the refresh schedule for a specified DirectQuery or LiveConnection dataset from My workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDirectQueryRefreshSchedule.

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_GET_REPORT_EXPORT_STATUSGet report export job status in My workspace. Returns the current status of the Export to File job for the specified report from My workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetExportToFileStatus.

Input Parameters

string
required
The export ID
string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_GET_SCALEOUT_SYNC_STATUSGet dataset query scale-out synchronization status in My workspace. Returns the query scale-out sync status for the specified dataset from My workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetQueryScaleOutSyncStatus.

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_LIST_RDL_REPORT_DATASOURCESList paginated report data sources in My workspace. Returns a list of data sources for the specified paginated report (RDL) from My workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetDatasources.

Input Parameters

string
required
The report ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_REBIND_REPORT_DATASETRebind a report in My workspace to a dataset. A target dataset in another workspace creates a shared dataset in My workspace. A live-connected report loses its live connection and receives a direct dataset binding. Requires Write on the report and Build on the target dataset. This does not copy or refresh the report. Required scope: Report.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/reports/rebind-report

Input Parameters

string
required
The report ID
object
required
Rebind report parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_START_REPORT_FILE_EXPORTStart an asynchronous file export of a report from My workspace. Returns the accepted export job, not the exported file. Use the export job ID with GetExportToFileStatus to track completion before retrieving the file. Required delegated scopes: (Report.Read.All or Report.ReadWrite.All) AND (Dataset.Read.All or Dataset.ReadWrite.All). Supported formats and limitations depend on whether the report is a Power BI report or a paginated report. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_ExportToFile.

Input Parameters

string
required
The report ID
object
required
Export to file request parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_UPDATE_DATASET_DATASOURCESUpdate data source connections for a dataset in My workspace as its owner. Original and replacement sources must have the same schema and source type. Supports SQL Server, Azure SQL Server, Azure Analysis Services, Azure Synapse, OData, SharePoint, Teradata, and SAP HANA. XMLA-created/modified datasets and connection strings containing parameters are unsupported. With enhanced dataset metadata, refresh after updating; otherwise wait 30 minutes before refreshing. This operation does not itself refresh the dataset. Required delegated scope: Dataset.ReadWrite.All. Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/update-datasources

Input Parameters

string
required
The dataset ID
object
required
Data source connection updates. Supply datasourceSelector for datasets with multiple data sources. Original and replacement sources must have the same schema and source type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_UPDATE_DATASET_PERMISSIONSUpdate existing direct dataset permissions in My workspace; App principals are unsupported. Cannot add or remove write permission or remove inherited workspace permissions. Set datasetUserAccessRight to None to revoke direct access. Caller needs ReadWriteReshare permission. Permission propagation may require Refresh User Permissions. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/put-dataset-user

Input Parameters

string
required
The dataset ID
object
required
Existing direct dataset permission to replace. App principals are unsupported; cannot add/remove write permission or remove inherited workspace access. None revokes direct access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_UPDATE_DIRECT_QUERY_SCHEDULEUpdate a DirectQuery or LiveConnection dataset’s refresh schedule in My workspace. The caller must own the dataset. Supply either days and times or a frequency, not both. Days without times use a default single time per day; setting a frequency overwrites the days and times setting. Supported frequency values are 15, 30, 60, 120, and 180 minutes. Required delegated scope: Dataset.ReadWrite.All. Provider documentation: https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/update-direct-query-refresh-schedule

Input Parameters

string
required
The dataset ID
object
required
Patch DirectQuery or LiveConnection Refresh Schedule parameters, by specifying all or some of the parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_MY_WORKSPACE_UPDATE_RDL_DATASOURCESUpdate paginated report data sources in My workspace. Updates the data sources of the specified paginated report (RDL) from My workspace. Required delegated scope: Report.ReadWrite.All. The caller must own the data source; replacement sources must preserve schema and source type. Service-principal authentication does not support My workspace. Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/update-datasources.

Input Parameters

string
required
The report ID
object
required
Connection updates by paginated-report datasourceName. Replacement sources must keep the original schema and source type. ODBC sources are unsupported; caller must own the data source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_PATCH_GOAL_NOTEUpdates a goal value check-in note by ID. Use this action when you need to update the content of an existing goal check-in note in Power BI goals. This action modifies the note body while preserving other note metadata like timestamps and IDs. This is useful for correcting errors, adding additional context, or updating progress notes on goals. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The note text content to be updated
string
required
The unique identifier of the goal
string
required
The unique identifier of the goal check-in note
string
required
The unique identifier of the workspace
string
required
The timestamp for the value of the goal (e.g., 2024-05-12T00:00:00Z)
string
required
The unique identifier of the scorecard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_PATCH_GOAL_VALUE_BY_IDUpdates a goal value check-in by a UTC date timestamp. Use this action when you need to update the value, status, target, or other properties of a specific goal value check-in within a Power BI scorecard. This allows you to record progress updates for goals at specific timestamps. Requires the Dataset.ReadWrite.All scope. Required Scope: Dataset.ReadWrite.All

Input Parameters

integer
The goal value trend.
number
The goal current value.
string
required
The unique identifier of the goal.
integer
The ID of the goal status. 0=Not started, 1=On track, 2=At risk, 3=Behind, 4=Overdue, 5=Completed.
number
The goal target value.
string
required
The unique identifier of the workspace (group).
number
The goal value trend forecast.
string
required
The UTC timestamp for the value of the goal (e.g., 2026-05-12T00:00:00Z).
string
The UTC time at creation.
string
required
The unique identifier of the scorecard.
string
The UTC time at last modification.
string
The textual representation of the current goal value.
string
The textual representation of the goal target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_PATCH_SCORECARD_BY_IDUpdates a scorecard by its ID. Use this action when you need to modify properties of an existing Power BI scorecard, such as updating its name, description, permissions, or associated settings. This action requires the Dataset.ReadWrite.All scope. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
The scorecard name
array
The scorecard goals
string
required
The unique identifier of the workspace (group)
string
The ID of the internal report associated with the scorecard
string
The ID of the dataset associated with the scorecard
string
The scorecard description
string ("None" | "Read" | "Write" | "ReadWrite")
The scorecard permissions.
string
required
The unique identifier of the scorecard
array
The display settings for columns on a scorecard
string ("Initialized" | "Completed" | "Failed" | "Deprovisioning" | "Deleted")
The provisioning status of the scorecard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_POST_DATASET_IN_GROUPCreates a new push dataset in the specified Power BI workspace. Use this action when you need to create a new push dataset in a specific workspace to store and manage data that can be pushed programmatically via the Power BI REST API. This API call only supports push datasets (Push, Streaming, or PushStreaming mode). This action is irreversible once the dataset is created. The dataset name must be unique within the workspace.

Input Parameters

string
required
The name of the dataset to create.
array
required
The list of tables to create in the dataset.
string
required
The workspace ID (group ID) that identifies the workspace.
array
The data sources associated with this dataset.
string ("AsAzure" | "AsOnPrem" | "Push" | "Streaming" | "PushStreaming")
Dataset mode or type.
array
The relationships between tables in this dataset.
string ("None" | "basicFIFO")
Default retention policy for the dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_POST_DATASET_USERGrants the specified user’s permissions to the specified dataset. Use this action when you need to assign access rights to a Power BI dataset for a specific user, group, or app. This is useful for managing dataset permissions and controlling who can access or interact with the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available.

Input Parameters

string
required
The dataset ID.
string
required
Identifier of the user (email address for User principalType, group ID for Group, app ID for App).
string ("User" | "Group" | "App")
required
The type of principal (User, Group, or App).
string ("Read" | "ReadReshare" | "ReadExplore" | "ReadReshareExplore")
required
The access right to grant to the user for the dataset. Read allows viewing, ReadReshare adds resharing capability, ReadExplore enables explore mode, ReadReshareExplore combines reshare and explore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_POST_DATASET_USER_IN_GROUPGrants the specified user’s permissions to the specified dataset in a workspace. Use this action when you need to assign access rights to a Power BI dataset for a specific user, group, or app within a workspace context. This is useful for managing dataset permissions and controlling who can access or interact with the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The workspace ID
string
required
The dataset ID
string
required
Identifier of the user (email address for User principalType, group ID for Group, app ID for App).
string ("User" | "Group" | "App")
required
The type of principal (User, Group, or App).
string ("Read" | "ReadReshare" | "ReadExplore" | "ReadReshareExplore")
required
The access right to grant to the user for the dataset. Read allows viewing, ReadReshare adds resharing capability, ReadExplore enables explore mode, ReadReshareExplore combines reshare and explore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_POST_GOALAdds a new goal to a Power BI scorecard. Use this action when you need to create a new goal within an existing scorecard to track objectives, KPIs, or other metrics. Goals can be organized in a parent-child hierarchy and support various formatting options for dates and values. Requires the Dataset.ReadWrite.All scope. Note: The goal will be created with default values that may need to be updated via additional API calls for detailed configuration.

Input Parameters

string
required
The goal name.
string
required
The unique identifier of the workspace (group).
string
Optional. The ID of the parent goal, if defined.
string
Optional. The UTC timestamp for the start date of the goal. The time portion is zero.
string
required
The unique identifier of the scorecard.
string
Optional. The UTC timestamp for the completion date of the goal. The time portion is zero.
string
Optional. The custom format string for dates.
string
Optional. The custom format string for values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_POST_GOAL_NOTEAdds a new note to a goal value check-in for a Power BI scorecard goal. Use this action when you need to add a note or comment to a specific goal value check-in within a Power BI scorecard. This allows you to provide additional context or explanations for goal progress updates. The timestamp parameter identifies the specific goal value check-in to attach the note to. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The note text to be added to the goal value check-in
string
required
The unique identifier of the goal
string
required
The unique identifier of the workspace (group) containing the scorecard
string
required
The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
string
required
The unique identifier of the scorecard containing the goal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_POST_ROWS_IN_GROUPAdds data rows to a table in a Power BI push dataset within a workspace. Repeated submissions may add duplicate rows; requires the Dataset.ReadWrite.All scope.

Input Parameters

array
required
An array of data rows to push to the dataset table. Each element is a collection of properties represented using key-value format.
string
required
The workspace ID
string
required
The dataset ID
string
required
The table name within the dataset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_POST_STATUS_RULESCreates or updates status rules of a goal in Power BI. Use this action when you need to define custom status rules that automatically set a goal’s status based on conditions such as current value, threshold comparisons, or state values. The defaultOutput is used when no rule conditions are met. Required Scope: Dataset.ReadWrite.All

Input Parameters

array
Optional. The list of status rules to apply.
string
required
The unique identifier of the goal
string
required
The unique identifier of the workspace
string
required
The unique identifier of the scorecard
integer
required
The default status ID when no rule matches. Values: 0=Not started, 1=On track, 2=At risk, 3=Behind, 4=Overdue, 5=Completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_PUT_TABLEUpdates the metadata and schema for the specified table within the specified dataset from My workspace. Use this action when you need to modify the schema or metadata of an existing table in a Power BI push dataset. This includes updating columns, adding measures, or changing table properties. The table must already exist in the dataset. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The table name (must match the tableName path parameter).
array
The list of sources for this table (used for streaming datasets).
array
required
The list of column definitions for this table. This replaces existing columns.
array
The list of measure definitions for this table.
boolean
Whether the table is hidden from client tools.
string
required
The dataset ID containing the table to update.
string
required
The name of the table to update.
string
The table description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_PUT_TABLE_IN_GROUPUpdates the metadata and schema for the specified table within the specified dataset from the specified workspace. Use this action when you need to modify the schema or metadata of an existing table in a Power BI push dataset within a workspace. This includes updating columns, adding measures, or changing table properties. The table must already exist in the dataset. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The table name (must match the tableName path parameter).
array
The list of sources for this table (used for streaming datasets).
array
required
The list of column definitions for this table. This replaces existing columns.
string
required
The workspace (group) ID containing the dataset.
array
The list of measure definitions for this table.
boolean
Whether the table is hidden from client tools.
string
required
The dataset ID containing the table to update.
string
required
The name of the table to update.
string
The table description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REBIND_REPORTRebinds a Power BI report in a specified workspace to another dataset, changing the data source used by the report. If the dataset is in a different workspace, a shared dataset is created in the report’s workspace. Requires Report.ReadWrite.All.

Input Parameters

string
required
The workspace ID. The report must belong to this workspace.
string
required
The report ID to rebind.
string
required
The dataset ID to rebind the report to. If the dataset resides in a different workspace than the report, a shared dataset will be created in the report’s workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REFRESH_A_DATAFLOWRefresh a dataflow. Triggers a refresh for the specified dataflow. Supported notification options are MailOnFailure and NoNotification; MailOnCompletion is unsupported. A successful response acknowledges the refresh request, not refresh completion. Required delegated scopes: Dataflow.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/dataflows/refresh-dataflow.

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID
string ("default" | "processFull")
Type of refresh process to use.
object
Optional refresh notification body. Supported choices are NoNotification and MailOnFailure; acceptance is not refresh completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REFRESH_A_DATASET_IN_MY_WORKSPACERefresh a dataset in My workspace. Triggers a refresh for the specified dataset from My workspace. An enhanced refresh is triggered only if a request payload other than notifyOption is set. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_RefreshDataset.

Input Parameters

string
required
The dataset ID
object
Optional refresh body. For shared capacity, specify only notifyOption (maximum eight refreshes per day including scheduled refreshes). Enhanced refresh requires Premium capacity, at least one enhanced parameter, and omission of notifyOption. A successful response accepts the request; it does not confirm refresh completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REFRESH_DATASET_IN_GROUPTriggers a refresh for the specified dataset from the specified workspace. Use this action when you need to manually trigger a dataset refresh in a Power BI workspace. An enhanced refresh is triggered only if a request payload other than notifyOption is set (e.g., when specifying specific tables, commit mode, or timeout). Note: This action is asynchronous - it initiates the refresh and returns immediately. Use GetRefreshHistory or GetRefreshExecutionDetails to monitor the refresh status. Required Scope: Dataset.ReadWrite.All This action is not destructive - it initiates a refresh operation that can be monitored and cancelled if needed.

Input Parameters

string
required
The workspace ID (group ID) that contains the dataset.
string
required
The dataset ID to refresh.
object
Power BI dataset refresh request payload. An enhanced refresh is triggered only if a request payload other than notifyOption is set. If only notifyOption is provided, a standard refresh is triggered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REFRESH_USER_PERMISSIONS_IN_POWER_BIRefresh user permissions after access to a workspace, app, or item changes. Call before other Power BI API calls, then wait about two minutes for the refreshed permissions to become available. Limited to one call per user per hour. Supports service principal profiles. Returns an empty success response; it does not wait for permission propagation. Required delegated scopes: Workspace.Read.All or Workspace.ReadWrite.All. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Users_RefreshUserPermissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REMOVE_A_GATEWAY_DATA_SOURCE_USERRemove a gateway data source user. Removes the specified user from the specified data source. Required delegated scopes: Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Gateways_DeleteDatasourceUser.

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.
string
The service principal profile ID to delete
string
required
The user’s email address or the object ID of the service principal
string
required
The data source ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REMOVE_A_USERS_WORKSPACE_PERMISSIONSRemove a user’s workspace permissions. Deletes the specified user permissions from the specified workspace. Required delegated scopes: Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_DeleteUserInGroup.

Input Parameters

string
required
The email address of the user or object ID of the service principal to delete
string
required
The workspace ID
string
The service principal profile ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REMOVE_WORKSPACE_PERMISSIONS_AS_ADMINRemove workspace permissions as admin. Removes user, security group, M365 group, or service principal permissions from the specified workspace. The caller must be a Fabric administrator. Maximum 200 requests per hour. Required delegated scopes: Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_DeleteUserAsAdmin.

Input Parameters

string
required
The user principal name (UPN) of the user or group object Id of the group or app object Id of the service principal to delete.
string
required
The workspace ID.
boolean
Whether a given user is a group or not. This parameter is required when user to delete is group.
string
The service principal profile ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_REPORTS_GENERATE_TOKEN_CREATE_IN_GROUPGenerates an embed token to allow report creation in the specified workspace based on the specified dataset. Use this action when you need to generate an embed token to create a new Power BI report within a specific workspace. The token is based on a dataset and allows programmatic report creation through the Power BI API. You can configure row-level security (RLS) by providing identities, and customize the token lifetime. Required Scope: Report.ReadWrite.All or Report.Read.All

Input Parameters

string
required
The workspace ID
string
The dataset ID used for report creation. Only applies when you generate an embed token for report creation.
array
A list of identities to use for row-level security rules.
string ("View" | "Edit" | "Create")
required
The required access level for embed token generation.
boolean
Whether an embedded report can be saved as a new report. The default value is false. Only applies when you generate an embed token for report embedding.
integer
The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the expiration time of a token, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will be ignored, resulting in the default expiration time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_RESTORE_A_DELETED_WORKSPACERestore a deleted workspace with the specified owner and optional name. The caller must be a Fabric administrator. Maximum 200 requests per hour. Required delegated scope: Tenant.ReadWrite.All. Provider contract: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_RestoreDeletedGroupAsAdmin.

Input Parameters

string
required
The workspace ID
object
required
Details of the group restore request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_ROTATE_A_TENANT_ENCRYPTION_KEYRotate a tenant encryption key. Rotate the encryption key for Power BI workspaces assigned to a capacity. Requires a Fabric administrator. Limited to 600 requests per hour. Required delegated scopes: Tenant.Read.All or Tenant.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Admin_RotatePowerBIEncryptionKey.

Input Parameters

string
required
The tenant key ID
object
required
Tenant key information

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_SET_DATAFLOW_REFRESH_SCHEDULECreate or update a dataflow refresh schedule. Creates or updates the refresh schedule for a specified dataflow. Required delegated scopes: Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_UpdateRefreshSchedule.

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID
object
required
The dataflow refresh schedule to create or update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_SET_LINKED_REPORT_CACHE_OPTIONSReplaces the CacheOption’s content for a given LinkedReport using the provided definition. Use this action when you need to configure or update the cache settings for a Power BI linked report. This includes setting the execution type (Live, Cache, or Snapshot) and optionally configuring cache expiration. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Report.ReadWrite.All

Input Parameters

string
required
The key (GUID or path) that uniquely identifies the linked report. GUID example: 01234567-89ab-cdef-0123-456789abcdef. Path example: path=‘/folder1/folder2/item’. If the path contains a single quote, escape it by adding another single quote.
object
required
The cache options configuration to apply to the linked report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_SET_SENSITIVITY_LABELS_ON_POWER_BI_ITEMSSet sensitivity labels on Power BI items by item ID. Requires a Fabric administrator and delegated scope Tenant.ReadWrite.All. The administrator and delegated user (if supplied) need sufficient label usage rights, and the label must be included in their label policy. Updates at most 2,000 items per request, with a limit of 25 requests per hour. Inspect each item’s returned status: HTTP success does not mean every label was set. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation InformationProtection_SetLabelsAsAdmin.

Input Parameters

object
required
Set label details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_START_A_REPORT_FILE_EXPORT_IN_A_WORKSPACEStart an asynchronous report file export in a workspace. Returns the accepted export job, not the exported file. Poll the workspace report export status using the returned export ID, then retrieve the file when the job succeeds. Supports service principal profiles. Required delegated scopes: (Report.Read.All or Report.ReadWrite.All) AND (Dataset.Read.All or Dataset.ReadWrite.All). Provider permissions and export limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/export-to-file-in-group

Input Parameters

string
required
The workspace ID
string
required
The report ID
object
required
Export to file request parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_START_A_WORKSPACE_METADATA_SCANStart an asynchronous metadata scan for 1–100 workspace IDs. Poll scan status with the returned scan ID, then retrieve scan results after success; acceptance is not scan completion. Requires a Fabric administrator or an authorized service principal. Required delegated scope: Tenant.Read.All or Tenant.ReadWrite.All; delegated scopes do not apply to service-principal authentication. https://learn.microsoft.com/en-us/rest/api/power-bi/admin/workspace-info-post-workspace-info

Input Parameters

boolean
Whether to return lineage info (upstream dataflows, tiles, data source IDs)
boolean
Whether to return dataset schema (tables, columns and measures). If you set this parameter to true, you must fully enable metadata scanning in order for data to be returned. For more information, see Enable tenant settings for metadata scanning.
boolean
Whether to return user details for a Power BI item (such as a report or a dashboard)
boolean
Whether to return data source details
boolean
Whether to return dataset expressions (DAX and Mashup queries). If you set this parameter to true, you must fully enable metadata scanning in order for data to be returned. For more information, see Enable tenant settings for metadata scanning.
object
required
Scan targets: workspaces is required and contains 1–100 workspace IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_TAKE_OVER_DATASETTransfers ownership over the specified dataset to the current authorized user. Use this action when you need to take over ownership of a dataset in a Power BI workspace. This is useful when the original owner has left the organization or is unavailable, and another user needs to manage the dataset. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The workspace ID (group ID) that contains the dataset
string
required
The dataset ID to take over

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_TAKE_OVER_REPORT_IN_GROUPTransfers ownership of the data sources for the specified paginated report (RDL) to the current authorized user. Use this action when you need to take ownership of a paginated report’s data sources in a Power BI workspace. This is useful when the previous owner is no longer available or you need administrative control over the report’s data connections. This operation affects all data sources associated with the report. Required Scope: Report.ReadWrite.All

Input Parameters

string
required
The workspace ID
string
required
The report ID of the paginated report (RDL)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_TRIGGER_QUERY_SCALE_OUT_SYNCTriggers a query scale-out sync of read-only replicas for the specified dataset from My workspace. Use this action when you need to manually synchronize read-only replicas for a dataset that supports query scale-out. This is typically used for maintenance or to ensure all replicas are synchronized before performing administrative operations. The sync operation ensures that read-only replicas have the latest data from the primary dataset. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UNASSIGN_WORKSPACE_FROM_PIPELINE_STAGEUnassign a workspace from a deployment pipeline stage. Unassigns the workspace from the specified stage in the specified deployment pipeline. Fails if there is an active deployment operation. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_UnassignWorkspace.

Input Parameters

string
required
The deployment pipeline ID
integer ("0" | "1" | "2")
required
The deployment pipeline stage order. Development (0), Test (1), Production (2).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_A_DEPLOYMENT_PIPELINEUpdate a deployment pipeline. Updates the specified deployment pipeline. Required delegated scopes: Pipeline.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Pipelines_UpdatePipeline.

Input Parameters

string
required
The deployment pipeline ID
object
required
Supply an updated displayName, description, or both. An empty description clears it. An empty object is invalid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_A_SERVICE_PRINCIPAL_PROFILE_NAMEUpdate the name of a profile owned by the calling service principal. Can only be called by a service principal. Provider documentation: https://learn.microsoft.com/en-us/rest/api/power-bi/profiles/update-profile.

Input Parameters

string
required
The service principal profile ID
object
required
The update profile request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_A_USERS_WORKSPACE_PERMISSIONSUpdate a user’s workspace permissions. Updates the specified user permissions to the specified workspace. Required delegated scopes: Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Groups_UpdateGroupUser.

Input Parameters

string
required
The workspace ID
object
required
Workspace right and identity: supply emailAddress or both identifier and principalType (UPN for User, object ID for Group/App).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_CAPACITY_WORKLOADEnable or disable a capacity workload and set its memory limit. Changes the state of a specific workload to Enabled or Disabled. When enabling a workload, specify the percentage of maximum memory that the workload can consume. Workload APIs are not relevant for Gen2 capacities. Unsupported is a read-only workload state and cannot be set by this operation. Required delegated scopes: Capacity.ReadWrite.All Provider permissions and limitations: https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/patch-workload.

Input Parameters

object
required
Patch workload parameters
string
required
The capacity ID
string
required
The name of the workload

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_DATAFLOW_SETTINGSUpdate dataflow properties, capabilities, and settings. Updates dataflow properties, capabilities and settings. Required delegated scopes: Dataflow.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Dataflows_UpdateDataflow.

Input Parameters

string
required
The workspace ID
string
required
The dataflow ID
object
required
Patch dataflow properties, capabilities and settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_DATASETUpdates the properties for the specified dataset from My workspace. Use this action when you need to modify dataset settings such as query scale-out configuration or storage mode. The user must be the dataset owner to perform this operation. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The dataset ID.
string
The dataset storage mode. Values: Abf, PremiumFiles, SmallSemanticModel.
object
Query scale out settings for the dataset update request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_DATASET_IN_GROUPUpdates the properties for the specified dataset from the specified workspace. Use this action when you need to modify dataset settings in a workspace, such as configuring query scale-out settings or changing the storage mode. The user must be the dataset owner to perform this operation. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The dataset ID.
string
The dataset storage mode. Values: Abf, PremiumFiles, SmallSemanticModel.
object
Query scale out settings for the dataset update request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_DATASET_PARAMETERS_IN_MY_WORKSPACEUpdate parameter values for a dataset in My workspace as its owner. With enhanced metadata refresh afterward to apply the values; otherwise wait 30 minutes, then refresh. This call does not refresh data. Supply at most 100 existing, case-sensitive, nonduplicate parameters of the expected type; Any/Binary parameters and XMLA-created/modified datasets are unsupported. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/update-parameters

Input Parameters

string
required
The dataset ID
object
required
Updates for 1–100 existing case-sensitive parameter names, without duplicates. Values must have the expected type. Any/Binary parameters and duplicate names are unsupported. Refresh afterward to apply the values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_DATASOURCES3Updates the data sources of the specified paginated report (RDL) from the specified workspace. Use this action when you need to update the connection details (server, database) for one or more data sources in a Power BI paginated report within a specific workspace. This is useful for migrating paginated reports between environments (e.g., from development to production) or updating connection strings without republishing the report. [!IMPORTANT] Both the original data source and the new data source must have the exact same schema. Important notes: - Only supports paginated reports (RDL). - Both the original and new data sources must have the exact same schema. - Changing the data source type is not supported. - Open Database Connectivity (ODBC) data sources are not supported. - The user must be the data source owner. Required scope: Reports.ReadWrite.All

Input Parameters

string
required
The workspace ID.
string
required
The paginated report ID.
array
required
The update details for the data sources of the paginated report. Each item specifies the data source name and new connection details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_GATEWAY_DATA_SOURCE_CREDENTIALSReplace data source credentials. On-premises gateways require gateway-admin permission and RSA-OAEP credentials encrypted with the gateway public key; cloud sources require source ownership and JSON-encoded credentialData. When leaving SSO, set useEndUserOAuth2Credentials=false. Supplied OAuth tokens have no automatic refresh and typically last one hour; Extension sources cannot use useCallerAADIdentity=true. VNet gateways are unsupported; SAS is limited to AzureBlobStorage/AzureDataLakeStorage. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/update-datasource

Input Parameters

string
required
The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.
string
required
The data source ID
object
required
The update data source request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_GOAL_BY_IDUpdates a goal by its ID within a Power BI scorecard. Use this action when you need to modify properties of an existing goal in a Power BI scorecard, such as updating its name, description, dates, permissions, or associated settings. This action requires the Dataset.ReadWrite.All scope. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All

Input Parameters

string
The goal ID
string
The goal name
integer
The rank of the goal within the ordered set of sibling goals
integer
The nested level of the goal in the parent-child hierarchy of scorecard goals
string
required
The unique identifier of the goal
string
required
The unique identifier of the workspace (group)
string
The ID of the parent goal, if defined.
string
The UTC timestamp for the start date of the goal. The time portion of the timestamp is zero.
array
The list of goal value check-ins
integer
The number of notes
string
The UTC time at creation
string
The goal description
string ("None" | "View" | "UpdateCurrentValue" | "UpdateTargetValue" | "UpdateNotes" | "UpdateStatus" | "UpdateValues" | "All")
The goal permissions.
string
required
The unique identifier of the scorecard
object
A container for JSON definitions of status rules on a Power BI goal.
array
The list of aggregated properties of the goal
string
The UTC timestamp for the completion date of the goal. The time portion of the timestamp is zero.
boolean
Whether the goal has status rules defined
string
The UTC time at last modification
string
The format string for dates
string
The format string for values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_PARAMETERS_IN_GROUP2Updates the parameters values for the specified dataset from the specified workspace. Use this action when you need to change one or more parameter values in a Power BI dataset that resides in a specific workspace. This is commonly used after updating underlying data sources or to modify dataset configuration without redeploying. [!NOTE] We recommend using enhanced dataset metadata with this API call.

Input Parameters

string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The unique identifier of the Power BI dataset.
array
required
A list of dataset parameters to update. At least one parameter update is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULEUpdates the refresh schedule for the specified dataset from My workspace. Use this action when you need to configure or modify the automatic refresh schedule for a Power BI dataset, such as enabling/disabling scheduled refresh, setting refresh days and times, or configuring failure notifications. A request that disables the refresh schedule should contain no other changes. This action is idempotent. Required Scope: Dataset.ReadWrite.All

Input Parameters

object
The refresh schedule configuration for a dataset.
string
required
The dataset ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULE_IN_GROUP3Updates the refresh schedule for the specified dataset from the specified workspace. Use this action when you need to configure or modify the automatic refresh schedule for a Power BI dataset within a workspace, such as enabling/disabling scheduled refresh, setting refresh days and times, or configuring failure notifications. A request that disables the refresh schedule should contain no other changes. This action is idempotent. Required Scope: Dataset.ReadWrite.All

Input Parameters

object
The refresh schedule configuration for a dataset in a workspace.
string
required
The workspace ID (group ID) that identifies the workspace.
string
required
The dataset ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_REPORT_CONTENTUpdates the content of the specified report from My workspace with the content of a specified source report. Use this action when you need to replace the content of a report in My workspace with content from another report. The target report must be in My workspace. The source report can be from My workspace or another workspace (in which case a share is required). This operation overwrites the target report’s content while keeping its ID, name, and other properties. Required Scope: Report.ReadWrite.All

Input Parameters

string
required
The report ID in My workspace to update
string
required
The source type. Must be ‘ExistingReport’
object
required
The source report to copy content from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_WORKSPACEUpdates the properties for the specified workspace. Use this action when you need to modify workspace settings such as renaming the workspace or changing the default dataset storage format. This action can be called by a service principal profile with appropriate permissions. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Workspace.ReadWrite.All

Input Parameters

string
The workspace name. Include this property to rename the workspace.
string
required
The workspace ID
string ("Small" | "Large")
Dataset storage format for the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_UPDATE_WORKSPACE_PROPERTIES_AS_ADMINUpdate workspace name/description as a Fabric administrator; Premium workspaces also support defaultDatasetStorageFormat and logAnalyticsWorkspace. Names must be unique in the organization. Explicit logAnalyticsWorkspace:null unassigns Log Analytics. Does not update capacity assignments, users or artifact collections. Required delegated scope: Tenant.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/admin/groups-update-group-as-admin

Input Parameters

string
required
The workspace ID
object
required
Writable PATCH properties: name/description on Shared capacity; Premium also permits defaultDatasetStorageFormat/logAnalyticsWorkspace. Explicit logAnalyticsWorkspace:null unassigns Log Analytics. Omitted properties stay unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_BIND_RDL_REPORT_TO_GATEWAYBind a workspace paginated report data source to a gateway. Binds the specified data source of the paginated report from the specified workspace to the specified gateway, optionally with a given data source ID. If you don’t supply a specific data source ID, the data source will be bound to the first matching data source in the gateway. Required delegated scopes: Workspace.Read.All or Workspace.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_BindToGatewayInGroup.

Input Parameters

string
required
The workspace ID
string
required
The report ID
object
required
The bind to gateway request payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_EXECUTE_DAX_QUERIESExecute DAX against a dataset in a workspace and return base64 Arrow streams. Requires dataset read/build permissions and the Dataset Execute Queries tenant setting. Dataset.Read.All or Dataset.ReadWrite.All authorizes this operation. Supports one query with multiple EVALUATE statements. The binary response may contain error rowsets even with HTTP 200. Query success is explicitly unverified; decode data_base64 and inspect IsError in every Arrow stream’s schema metadata.

Input Parameters

string
required
DAX query text to execute.
array
RLS roles; caller must be a role member or workspace administrator.
string
Locale-specific formatting culture, e.g. en-US.
string
required
The workspace ID.
string
required
The dataset ID.
string
Dynamic RLS data for CUSTOMDATA().
boolean
Return only the schema without data.
integer
Query memory limit in KB (int64).
integer
Query timeout in seconds.
string
Effective username; requires workspace administrator permissions.
string
JSON structure encoded as a string containing operation context.
integer
Maximum rows returned; provider default is 1,000,000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_GET_DATASET_REFRESH_HISTORYGet dataset refresh history in a workspace. Returns the refresh history for the specified dataset from the specified workspace. OneDrive refresh history is not returned. Caller must have Write permissions on the dataset. Supports service principal profiles. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetRefreshHistoryInGroup.

Input Parameters

integer
The requested number of entries in the refresh history. If not provided, the default is the last available 60 entries.
string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_GET_DIRECT_QUERY_SCHEDULEGet a DirectQuery refresh schedule in a workspace. Returns the refresh schedule for a specified DirectQuery or LiveConnection dataset from the specified workspace. Required delegated scopes: Dataset.Read.All or Dataset.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_GetDirectQueryRefreshScheduleInGroup.

Input Parameters

string
required
The workspace ID
string
required
The dataset ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_LIST_RDL_REPORT_DATASOURCESList paginated report data sources in a workspace. Returns a list of data sources for the specified paginated report (RDL) from the specified workspace. Required delegated scopes: Report.Read.All or Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_GetDatasourcesInGroup.

Input Parameters

string
required
The workspace ID
string
required
The paginated report (RDL) ID in the specified workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_UPDATE_DATASET_DATASOURCESUpdate a workspace dataset’s data source connections as its owner. Original and replacement sources must have the same schema and type. Supports SQL Server, Azure SQL Server, Azure Analysis Services, Azure Synapse, OData, SharePoint, Teradata and SAP HANA. XMLA-created/modified datasets and parameterized connection strings are unsupported. With enhanced metadata refresh after updating; otherwise wait 30 minutes, then refresh. This call does not refresh data. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/update-datasources-in-group

Input Parameters

string
required
The workspace ID
string
required
The dataset ID within the specified workspace.
object
required
Data source connection updates. Supply datasourceSelector for datasets with multiple sources. Replacement sources must have the same schema and type. This does not refresh data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_UPDATE_DATASET_PERMISSIONSUpdate existing direct dataset permissions in a workspace; App principals are unsupported. Cannot add or remove write permission or remove inherited workspace permissions. Set datasetUserAccessRight to None to revoke direct access. Caller needs ReadWriteReshare permission. Permission propagation may require Refresh User Permissions. Required scope: Dataset.ReadWrite.All. https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/put-dataset-user-in-group

Input Parameters

string
required
The workspace ID
string
required
The dataset ID
object
required
Existing direct dataset permission to replace. App principals are unsupported; cannot add/remove write permission or remove inherited workspace access. None revokes direct access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_UPDATE_DIRECT_QUERY_SCHEDULEUpdate a DirectQuery or LiveConnection dataset’s refresh schedule in a workspace. The caller must own the dataset. Service principal profiles are supported. Supply either days/times or frequency, not both. Days without times use a default single time per day; frequency overwrites existing days/times. Supported frequencies in minutes: 15, 30, 60, 120, 180. Required delegated scopes: Dataset.ReadWrite.All. Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Datasets_UpdateDirectQueryRefreshScheduleInGroup.

Input Parameters

string
required
The workspace ID
string
required
The dataset ID
object
required
Patch DirectQuery or LiveConnection Refresh Schedule parameters, by specifying all or some of the parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_POWER_BI_WORKSPACE_UPDATE_REPORT_CONTENTUpdate workspace report content from a source report. Updates the content of the specified report from the specified workspace with the content of a specified source report. Required delegated scopes: Report.ReadWrite.All Provider permissions and limitations: https://github.com/microsoft/PowerBI-CSharp/blob/master/sdk/swaggers/swagger.json operation Reports_UpdateReportContentInGroup.

Input Parameters

string
required
The workspace ID
string
required
The report ID
object
required
UpdateReportContent parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not