Microsoft Power Bi
microsoft_power_biMicrosoft Power BI is a business analytics service that provides interactive visualizations and business intelligence capabilities with an interface simple enough for end users to create their own reports and dashboards.
Acciones disponibles (116)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Dashboard to WorkspaceMICROSOFT_POWER_BI_ADD_DASHBOARD2AcciónCreates 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.
MICROSOFT_POWER_BI_ADD_DASHBOARD2AcciónCreates 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.
Parámetros de entrada
namestringObligatorioThe name of the new dashboard
groupIdstringObligatorioThe workspace ID (also known as group ID)
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Reports From AppMICROSOFT_POWER_BI_APPS_GET_REPORTSAcciónReturns 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.
MICROSOFT_POWER_BI_APPS_GET_REPORTSAcciónReturns 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.
Parámetros de entrada
appIdstringObligatorioThe app ID of the Power BI app whose reports to retrieve.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Assign Workspace to CapacityMICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_CAPACITYAcciónAssigns 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).
MICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_CAPACITYAcciónAssigns 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).
Parámetros de entrada
groupIdstringObligatorioThe workspace (group) ID. This is a path parameter identifying the target workspace.
capacityIdstringObligatorioThe capacity ID. Use an empty GUID (00000000-0000-0000-0000-000000000000) to unassign My workspace from a capacity.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Cancel Dataset Refresh in WorkspaceMICROSOFT_POWER_BI_CANCEL_REFRESH2AcciónCancels 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
MICROSOFT_POWER_BI_CANCEL_REFRESH2AcciónCancels 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID. Use GetGroups to find the workspace ID.
datasetIdstringObligatorioThe dataset ID. Use GetDatasetsInGroup to find the dataset ID within a workspace.
refreshIdstringObligatorioThe refresh ID to cancel. This is the unique identifier of a refresh operation from the dataset refresh history.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clone ReportMICROSOFT_POWER_BI_CLONE_REPORT2AcciónClones 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
MICROSOFT_POWER_BI_CLONE_REPORT2AcciónClones 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
Parámetros de entrada
namestringObligatorioThe name for the cloned report
report_idstringObligatorioThe report ID of the source report to clone
target_model_idstringOptional. 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.
target_workspace_idstringOptional. 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clone Report in WorkspaceMICROSOFT_POWER_BI_CLONE_REPORT_IN_GROUPAcciónClones 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
MICROSOFT_POWER_BI_CLONE_REPORT_IN_GROUPAcciónClones 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
Parámetros de entrada
namestringObligatorioThe name for the cloned report
group_idstringObligatorioThe workspace ID (group ID)
report_idstringObligatorioThe report ID
target_model_idstringThe target dataset ID. If not provided, the new report will be associated with the same dataset as the source report
target_workspace_idstringThe 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
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Goal Value Check-inMICROSOFT_POWER_BI_CREATE_GOAL_VALUEAcciónCreates 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
MICROSOFT_POWER_BI_CREATE_GOAL_VALUEAcciónCreates 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
Parámetros de entrada
trendstringenumGoal trend values.
012valuenumberThe current value of the goal.
statusstringenumGoal status ID values.
012345targetnumberThe target value of the goal.
goal_idstringObligatorioThe unique identifier of the goal
forecastnumberThe value trend forecast of the goal.
group_idstringObligatorioThe unique identifier of the workspace containing the scorecard
timestampstringObligatorioThe UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
scorecard_idstringObligatorioThe unique identifier of the scorecard containing the goal
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WorkspaceMICROSOFT_POWER_BI_CREATE_GROUPAcciónCreates 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.
MICROSOFT_POWER_BI_CREATE_GROUPAcciónCreates 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.
Parámetros de entrada
namestringObligatorioThe name of the workspace to create
workspaceV2boolean(Preview feature) Whether to create a workspace V2. The only supported value is `true`.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Push DatasetMICROSOFT_POWER_BI_CREATE_PUSH_DATASETAcciónCreates 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.
MICROSOFT_POWER_BI_CREATE_PUSH_DATASETAcciónCreates 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.
Parámetros de entrada
namestringObligatorioThe name of the dataset to create.
tablesobject[]ObligatorioThe list of tables to create in the dataset.
datasourcesobject[]The data sources associated with this dataset.
default_modestringThe dataset mode or type. For push datasets, use 'Push'.
relationshipsobject[]The relationships between tables in this dataset.
default_retention_policystringenumDefault retention policy for the dataset.
NonebasicFIFO
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ScorecardMICROSOFT_POWER_BI_CREATE_SCORECARDAcciónCreates 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.
MICROSOFT_POWER_BI_CREATE_SCORECARDAcciónCreates 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.
Parámetros de entrada
namestringObligatorioThe scorecard name.
group_idstringObligatorioThe workspace ID (group ID) that identifies the workspace.
descriptionstringOptional. The scorecard description.
sensitivity_label_idstringOptional. 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Temporary Upload LocationMICROSOFT_POWER_BI_CREATE_TEMPORARY_UPLOAD_LOCATIONAcciónCreates a temporary blob storage upload location for importing large Power BI .pbix files that are between 1 GB and 10 GB in size. Use this action when you need to upload a large Power BI .pbix file (between 1 GB and 10 GB) to the organization. The temporary upload location provides a shared access signature (SAS) URL where the file can be uploaded before being imported into Power BI. After uploading to the temporary location, you would use the regular import API to complete the import process. This action creates an upload location at the organization level (myorg), not a specific workspace. To upload to a specific workspace, use CreateTemporaryUploadLocationInGroup instead. Required Scope: Workspace.ReadWrite.All
MICROSOFT_POWER_BI_CREATE_TEMPORARY_UPLOAD_LOCATIONAcciónCreates a temporary blob storage upload location for importing large Power BI .pbix files that are between 1 GB and 10 GB in size. Use this action when you need to upload a large Power BI .pbix file (between 1 GB and 10 GB) to the organization. The temporary upload location provides a shared access signature (SAS) URL where the file can be uploaded before being imported into Power BI. After uploading to the temporary location, you would use the regular import API to complete the import process. This action creates an upload location at the organization level (myorg), not a specific workspace. To upload to a specific workspace, use CreateTemporaryUploadLocationInGroup instead. Required Scope: Workspace.ReadWrite.All
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Temporary Upload LocationMICROSOFT_POWER_BI_CREATE_TEMPORARY_UPLOAD_LOCATION_IN_GROUPAcciónCreates a temporary blob storage upload location for importing large Power BI .pbix files that are between 1 GB and 10 GB in size. Use this action when you need to upload a large Power BI .pbix file (between 1 GB and 10 GB) to a workspace. The temporary upload location provides a shared access signature (SAS) URL where the file can be uploaded before being imported into Power BI. After uploading to the temporary location, you would use the regular import API to complete the import process. Required Scope: Workspace.ReadWrite.All
MICROSOFT_POWER_BI_CREATE_TEMPORARY_UPLOAD_LOCATION_IN_GROUPAcciónCreates a temporary blob storage upload location for importing large Power BI .pbix files that are between 1 GB and 10 GB in size. Use this action when you need to upload a large Power BI .pbix file (between 1 GB and 10 GB) to a workspace. The temporary upload location provides a shared access signature (SAS) URL where the file can be uploaded before being imported into Power BI. After uploading to the temporary location, you would use the regular import API to complete the import process. Required Scope: Workspace.ReadWrite.All
Parámetros de entrada
group_idstringObligatorioThe workspace ID (group ID) that identifies the workspace.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete DashboardMICROSOFT_POWER_BI_DELETE_DASHBOARDAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_DASHBOARDAcciónDeletes 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
Parámetros de entrada
dashboardIdstringObligatorioThe dashboard ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete DataflowMICROSOFT_POWER_BI_DELETE_DATAFLOWAcciónDeletes 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.
MICROSOFT_POWER_BI_DELETE_DATAFLOWAcciónDeletes 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.
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
dataflowIdstringObligatorioThe dataflow ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete DatasetMICROSOFT_POWER_BI_DELETE_DATASETAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_DATASETAcciónDeletes 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
Parámetros de entrada
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Dataset from WorkspaceMICROSOFT_POWER_BI_DELETE_DATASET2AcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_DATASET2AcciónDeletes 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete GoalMICROSOFT_POWER_BI_DELETE_GOALAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_GOALAcciónDeletes 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
Parámetros de entrada
goalIdstringObligatorioThe unique identifier of the goal
groupIdstringObligatorioThe unique identifier of the workspace
scorecardIdstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Goal Note by IDMICROSOFT_POWER_BI_DELETE_GOAL_NOTE_BY_IDAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_GOAL_NOTE_BY_IDAcciónDeletes 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
Parámetros de entrada
goalIdstringObligatorioThe unique identifier of the goal
noteIdstringObligatorioThe unique identifier of the goal check-in note
groupIdstringObligatorioThe unique identifier of the workspace
timestampstringObligatorioThe timestamp for the value of the goal (ISO 8601 format)
scorecardIdstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Goal Status RulesMICROSOFT_POWER_BI_DELETE_GOAL_STATUS_RULESAcciónRemoves 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
MICROSOFT_POWER_BI_DELETE_GOAL_STATUS_RULESAcciónRemoves 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
Parámetros de entrada
goalIdstringObligatorioThe unique identifier of the goal
groupIdstringObligatorioThe unique identifier of the workspace
scorecardIdstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Pipeline UserMICROSOFT_POWER_BI_DELETE_PIPELINE_USERAcciónRemoves 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
MICROSOFT_POWER_BI_DELETE_PIPELINE_USERAcciónRemoves 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
Parámetros de entrada
identifierstringObligatorioThe user principal name (UPN) of the user. To delete a service principal or a security group, provide the Object ID.
pipelineIdstringObligatorioThe deployment pipeline ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Report from WorkspaceMICROSOFT_POWER_BI_DELETE_REPORT_IN_GROUPAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_REPORT_IN_GROUPAcciónDeletes 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
reportIdstringObligatorioThe report ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Rows from Dataset TableMICROSOFT_POWER_BI_DELETE_ROWSAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_ROWSAcciónDeletes 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
Parámetros de entrada
datasetIdstringObligatorioThe dataset ID
tableNamestringObligatorioThe table name from which to delete all rows
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Rows from Dataset Table in WorkspaceMICROSOFT_POWER_BI_DELETE_ROWS_IN_GROUPAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_ROWS_IN_GROUPAcciónDeletes 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace
datasetIdstringObligatorioThe dataset ID
tableNamestringObligatorioThe table name from which to delete all rows
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Scorecard By IDMICROSOFT_POWER_BI_DELETE_SCORECARD_BY_IDAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_SCORECARD_BY_IDAcciónDeletes 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
Parámetros de entrada
groupIdstringObligatorioThe unique identifier of the workspace (group)
scorecardIdstringObligatorioThe unique identifier of the scorecard to delete
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete WorkspaceMICROSOFT_POWER_BI_DELETE_WORKSPACEAcciónDeletes 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
MICROSOFT_POWER_BI_DELETE_WORKSPACEAcciónDeletes 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Discover Gateways for DatasetMICROSOFT_POWER_BI_DISCOVER_GATEWAYSAcciónReturns 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
MICROSOFT_POWER_BI_DISCOVER_GATEWAYSAcciónReturns 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasetIdstringObligatorioThe dataset ID that identifies the dataset.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Execute DAX QueriesMICROSOFT_POWER_BI_EXECUTE_DAX_QUERIESAcciónExecutes Data Analysis Expressions (DAX) queries against the provided dataset in My workspace. Use this action when you need to run DAX queries to retrieve or analyze data from a Power BI dataset. This endpoint supports complex DAX queries with multiple EVALUATE statements and includes features for Row-Level Security (RLS), culture-specific formatting, and custom data injection. The response is returned in Apache Arrow format and contains the query results in a columnar format. Use pyarrow or similar libraries to parse the response. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Important: This API is only available for datasets hosted on a capacity. Datasets with live connections to Azure Analysis Services or on-premises models are not supported. There's a limit of 120 query requests per minute per user.
MICROSOFT_POWER_BI_EXECUTE_DAX_QUERIESAcciónExecutes Data Analysis Expressions (DAX) queries against the provided dataset in My workspace. Use this action when you need to run DAX queries to retrieve or analyze data from a Power BI dataset. This endpoint supports complex DAX queries with multiple EVALUATE statements and includes features for Row-Level Security (RLS), culture-specific formatting, and custom data injection. The response is returned in Apache Arrow format and contains the query results in a columnar format. Use pyarrow or similar libraries to parse the response. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Important: This API is only available for datasets hosted on a capacity. Datasets with live connections to Azure Analysis Services or on-premises models are not supported. There's a limit of 120 query requests per minute per user.
Parámetros de entrada
querystringObligatorioThe DAX query text to execute. Supports single or multiple EVALUATE statements.
rolesstring[]Roles assigned to the user for Row-Level Security (RLS).
culturestringCulture 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.
dataset_idstringObligatorioThe dataset ID
custom_datastringCustom data for use in Dynamic RLS. Can be referenced by the model's CUSTOMDATA() function.
schema_onlybooleanWhether the query must return only the schema without data.
memory_limitintegerMemory limit in KB for the query execution.
query_timeoutintegerQuery timeout in seconds.
effective_usernamestringEffective username for the query. Used for RLS and audit purposes.
result_set_row_count_limitintegerMaximum number of rows to return. Default is 1,000,000 rows.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Execute DAX Queries on DatasetMICROSOFT_POWER_BI_EXECUTE_QUERIES_2AcciónExecutes 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
MICROSOFT_POWER_BI_EXECUTE_QUERIES_2AcciónExecutes 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
Parámetros de entrada
queriesobject[]ObligatorioThe list of DAX queries to execute against the dataset. Each query will return its own result set.
group_idstringObligatorioThe workspace ID (group ID) that identifies the workspace.
dataset_idstringObligatorioThe dataset ID to execute queries against.
serializer_settingsobjectSerialization settings for query results.
impersonated_user_namestringThe UPN of a user to be impersonated. If the model is not Row-Level Security (RLS) enabled, this will be ignored.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Execute SubscriptionMICROSOFT_POWER_BI_EXECUTE_SUBSCRIPTIONAcciónExecutes 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.
MICROSOFT_POWER_BI_EXECUTE_SUBSCRIPTIONAcciónExecutes 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.
Parámetros de entrada
IdstringObligatorioThe key (GUID) that uniquely identifies the subscription. GUID example: 01234567-89ab-cdef-0123-456789abcdef
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Dashboard Embed TokenMICROSOFT_POWER_BI_GENERATE_DASHBOARD_EMBED_TOKENAcciónGenerates 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
MICROSOFT_POWER_BI_GENERATE_DASHBOARD_EMBED_TOKENAcciónGenerates 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
datasetIdstringThe dataset ID used for report creation. Only applies when you generate an embed token for report creation.
identitiesobject[]A list of identities to use for row-level security rules.
accessLevelstringObligatorioenumThe required access level for embed token generation.
ViewEditCreateallowSaveAsbooleanWhether 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.
dashboardIdstringObligatorioThe dashboard ID
lifetimeInMinutesintegerThe 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Embed Token for Power BIMICROSOFT_POWER_BI_GENERATE_EMBED_TOKENAcciónGenerates 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.
MICROSOFT_POWER_BI_GENERATE_EMBED_TOKENAcciónGenerates 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.
Parámetros de entrada
reportsobject[]A list of reports to include in the embed token. Reports and datasets do not have to be related.
datasetsobject[]A list of datasets to include in the embed token. Datasets and reports do not have to be related.
identitiesobject[]The list of identities to use for row-level security rules.
target_workspacesobject[]The list of workspaces that the embed token will allow saving to.
lifetime_in_minutesintegerThe 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.
datasource_identitiesobject[]List of identities to use when connecting to data sources with Single Sign-On (SSO) enabled.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Report Embed Token in GroupMICROSOFT_POWER_BI_GENERATE_REPORT_TOKEN_IN_GROUPAcciónGenerates 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
MICROSOFT_POWER_BI_GENERATE_REPORT_TOKEN_IN_GROUPAcciónGenerates 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
Parámetros de entrada
group_idstringObligatorioThe workspace ID
report_idstringObligatorioThe report ID
dataset_idstringThe dataset ID used for report creation. Only applies when you generate an embed token for report creation.
identitiesobject[]A list of identities to use for row-level security rules.
access_levelstringObligatorioenumThe required access level for embed token generation.
ViewEditCreateallow_save_asbooleanWhether 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.
lifetime_in_minutesintegerThe 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Dataset Embed Token in GroupMICROSOFT_POWER_BI_GENERATE_TOKEN_IN_GROUPAcciónGenerates 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
MICROSOFT_POWER_BI_GENERATE_TOKEN_IN_GROUPAcciónGenerates 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
Parámetros de entrada
group_idstringObligatorioThe workspace ID
dataset_idstringObligatorioThe dataset ID
identitiesobject[]A list of identities to use for row-level security rules.
access_levelstringObligatorioenumThe required access level for embed token generation.
ViewEditCreateallow_save_asbooleanWhether 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.
target_dataset_idstringThe dataset ID used for report creation. Only applies when you generate an embed token for report creation.
lifetime_in_minutesintegerThe 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Available Feature By NameMICROSOFT_POWER_BI_GET_AVAILABLE_FEATURE_BY_NAMEAcciónReturns 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.
MICROSOFT_POWER_BI_GET_AVAILABLE_FEATURE_BY_NAMEAcciónReturns 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.
Parámetros de entrada
feature_namestringObligatorioThe feature name to retrieve
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CapacitiesMICROSOFT_POWER_BI_GET_CAPACITIESAcciónReturns a list of Power BI capacities that the authenticated user has access to. Use this action to retrieve information about all available capacities in the organization, including their state, SKU, region, and access permissions. This is useful for admin operations and capacity management tasks. Permissions: Requires one of the following scopes: Capacity.Read.All or Capacity.ReadWrite.All. This API call can be called by a service principal profile.
MICROSOFT_POWER_BI_GET_CAPACITIESAcciónReturns a list of Power BI capacities that the authenticated user has access to. Use this action to retrieve information about all available capacities in the organization, including their state, SKU, region, and access permissions. This is useful for admin operations and capacity management tasks. Permissions: Requires one of the following scopes: Capacity.Read.All or Capacity.ReadWrite.All. This API call can be called by a service principal profile.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dashboard from My WorkspaceMICROSOFT_POWER_BI_GET_DASHBOARD2AcciónReturns 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
MICROSOFT_POWER_BI_GET_DASHBOARD2AcciónReturns 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
Parámetros de entrada
dashboardIdstringObligatorioThe dashboard ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DashboardsMICROSOFT_POWER_BI_GET_DASHBOARDSAcciónReturns 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.
MICROSOFT_POWER_BI_GET_DASHBOARDSAcciónReturns 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.
Parámetros de entrada
topintegerReturns only the first n results
skipintegerSkips the first n results
filterstringReturns a subset of results based on OData filter query parameter condition
groupIdstringObligatorioThe workspace ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DataflowsMICROSOFT_POWER_BI_GET_DATAFLOWSAcciónReturns a list of all dataflows from the specified workspace. Use this action when you need to retrieve all dataflows within a specific Power BI workspace. This is useful for inventory, monitoring, or managing dataflows within a workspace. This API call can be called by a service principal profile. Required Scope: Dataflow.Read.All or Dataflow.ReadWrite.All
MICROSOFT_POWER_BI_GET_DATAFLOWSAcciónReturns a list of all dataflows from the specified workspace. Use this action when you need to retrieve all dataflows within a specific Power BI workspace. This is useful for inventory, monitoring, or managing dataflows within a workspace. This API call can be called by a service principal profile. Required Scope: Dataflow.Read.All or Dataflow.ReadWrite.All
Parámetros de entrada
topintegerReturns only the first n results
skipintegerSkips the first n results
filterstringReturns a subset of results based on OData filter query parameter condition.
groupIdstringObligatorioThe workspace ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DatasetMICROSOFT_POWER_BI_GET_DATASETAcciónReturns 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
MICROSOFT_POWER_BI_GET_DATASETAcciónReturns 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
Parámetros de entrada
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dataset in WorkspaceMICROSOFT_POWER_BI_GET_DATASET2AcciónReturns 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
MICROSOFT_POWER_BI_GET_DATASET2AcciónReturns 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DataSet DataMICROSOFT_POWER_BI_GET_DATA_SET_DATAAcciónGets the query results for the specified DataSet. Use when you need to retrieve the actual data values from a Power BI DataSet, such as for exporting data, generating reports outside of Power BI, or performing data analysis on dataset contents. This action executes a query against the dataset and returns the column definitions and row data. Use the optional parameters to filter or customize the query results.
MICROSOFT_POWER_BI_GET_DATA_SET_DATAAcciónGets the query results for the specified DataSet. Use when you need to retrieve the actual data values from a Power BI DataSet, such as for exporting data, generating reports outside of Power BI, or performing data analysis on dataset contents. This action executes a query against the dataset and returns the column definitions and row data. Use the optional parameters to filter or customize the query results.
Parámetros de entrada
idstringObligatorioThe 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.
max_rowsintegerSpecifies the maximum number of rows to return from the query.
parametersobject[]An array of DataSet parameters to use when executing the query.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Datasets from My WorkspaceMICROSOFT_POWER_BI_GET_DATASETSAcciónReturns 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
MICROSOFT_POWER_BI_GET_DATASETSAcciónReturns 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
Parámetros de entrada
topintegerReturns only the first n results. Use with skip for pagination.
skipintegerSkips the first n results. Use with top for pagination.
expandstringExpands related entities inline (e.g., 'schema,tables,relationships').
filterstringReturns a subset of results based on OData filter query parameter condition.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DataSets from Power BIMICROSOFT_POWER_BI_GET_DATA_SETSAcciónGets 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
MICROSOFT_POWER_BI_GET_DATA_SETSAcciónGets 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
Parámetros de entrada
topintegerShow only the first n items. See OData Paging - Top.
skipintegerSkip the first n items. See OData Paging - Skip.
countstringInclude count of items. See OData Count.
filterstringFilter items by property values. See OData Filtering.
selectstringSelect properties to be returned. See OData Select.
order_bystringOrder items by property values. See OData Sorting.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dataset to Dataflows LinksMICROSOFT_POWER_BI_GET_DATASET_TO_DATAFLOWS_LINKSAcciónReturns a list of upstream dataflows for datasets from the specified workspace. Use this action when you need to retrieve the relationships between datasets and their upstream dataflows in a Power BI workspace for dependency analysis or lineage tracking. This API call can be called by a service principal profile.
MICROSOFT_POWER_BI_GET_DATASET_TO_DATAFLOWS_LINKSAcciónReturns a list of upstream dataflows for datasets from the specified workspace. Use this action when you need to retrieve the relationships between datasets and their upstream dataflows in a Power BI workspace for dependency analysis or lineage tracking. This API call can be called by a service principal profile.
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dataset UsersMICROSOFT_POWER_BI_GET_DATASET_USERSAcciónReturns 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.
MICROSOFT_POWER_BI_GET_DATASET_USERSAcciónReturns 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.
Parámetros de entrada
dataset_idstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dataset Users In GroupMICROSOFT_POWER_BI_GET_DATASET_USERS_IN_GROUPAcciónReturns 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.
MICROSOFT_POWER_BI_GET_DATASET_USERS_IN_GROUPAcciónReturns 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.
Parámetros de entrada
group_idstringObligatorioThe workspace ID
dataset_idstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Datasources for DatasetMICROSOFT_POWER_BI_GET_DATASOURCESAcciónReturns 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
MICROSOFT_POWER_BI_GET_DATASOURCESAcciónReturns 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
Parámetros de entrada
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Datasources for Dataset in WorkspaceMICROSOFT_POWER_BI_GET_DATASOURCES_IN_GROUP3AcciónReturns 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
MICROSOFT_POWER_BI_GET_DATASOURCES_IN_GROUP3AcciónReturns 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get GatewayMICROSOFT_POWER_BI_GET_GATEWAYAcciónReturns 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
MICROSOFT_POWER_BI_GET_GATEWAYAcciónReturns 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
Parámetros de entrada
gatewayIdstringObligatorioThe gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Gateway Datasources in GroupMICROSOFT_POWER_BI_GET_GATEWAY_DATASOURCES_IN_GROUPAcciónReturns 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.
MICROSOFT_POWER_BI_GET_GATEWAY_DATASOURCES_IN_GROUPAcciónReturns 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.
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get GatewaysMICROSOFT_POWER_BI_GET_GATEWAYSAcciónReturns 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.
MICROSOFT_POWER_BI_GET_GATEWAYSAcciónReturns 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Goals from ScorecardMICROSOFT_POWER_BI_GET_GOALSAcciónReturns 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
MICROSOFT_POWER_BI_GET_GOALSAcciónReturns 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
Parámetros de entrada
expandstringAccepts a comma-separated list of data types, which will be expanded inline in the response. Supports `goalValues` and `aggregations`.
selectstringAllows the clients to select specific properties from the server.
groupIdstringObligatorioThe unique identifier of the workspace
scorecardIdstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Goals Refresh HistoryMICROSOFT_POWER_BI_GET_GOALS_REFRESH_HISTORYAcciónReads 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.
MICROSOFT_POWER_BI_GET_GOALS_REFRESH_HISTORYAcciónReads 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.
Parámetros de entrada
goal_idstringObligatorioThe unique identifier of the goal to get refresh history for
group_idstringObligatorioThe unique identifier of the workspace (group) containing the scorecard and goal
scorecard_idstringObligatorioThe unique identifier of the scorecard containing the goal
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Goals Status RulesMICROSOFT_POWER_BI_GET_GOALS_STATUS_RULESAcciónReturns 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
MICROSOFT_POWER_BI_GET_GOALS_STATUS_RULESAcciónReturns 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
Parámetros de entrada
goalIdstringObligatorioThe unique identifier of the goal
groupIdstringObligatorioThe unique identifier of the workspace
scorecardIdstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Goal Value By IDMICROSOFT_POWER_BI_GET_GOAL_VALUE_BY_IDAcciónReads 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
MICROSOFT_POWER_BI_GET_GOAL_VALUE_BY_IDAcciónReads 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
Parámetros de entrada
expandstringAccepts a comma-separated list of data types, which will be expanded inline in the response. Supports `notes`.
goalIdstringObligatorioThe unique identifier of the goal
groupIdstringObligatorioThe unique identifier of the workspace
timestampstringObligatorioThe timestamp for the value of the goal. Use UTC format (e.g., 2024-05-12T00:00:00Z)
scorecardIdstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get GroupsMICROSOFT_POWER_BI_GET_GROUPSAcciónReturns a list of workspaces the user has access to. Use this action when you need to retrieve all Power BI workspaces (groups) that the authenticated user has access to. This is useful for listing available workspaces, finding specific workspace IDs, or managing workspace resources. This API call can be called by a service principal profile. Required Scope: Workspace.Read.All or Workspace.ReadWrite.All
MICROSOFT_POWER_BI_GET_GROUPSAcciónReturns a list of workspaces the user has access to. Use this action when you need to retrieve all Power BI workspaces (groups) that the authenticated user has access to. This is useful for listing available workspaces, finding specific workspace IDs, or managing workspace resources. This API call can be called by a service principal profile. Required Scope: Workspace.Read.All or Workspace.ReadWrite.All
Parámetros de entrada
topintegerReturns only the first n results. Defaults to 25 if not specified.
skipintegerSkips the first n results.
filterstringReturns a subset of results based on OData filter query parameter condition.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Groups Capacity Assignment StatusMICROSOFT_POWER_BI_GET_GROUPS_CAPACITY_ASSIGNMENT_STATUSAcciónGets 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
MICROSOFT_POWER_BI_GET_GROUPS_CAPACITY_ASSIGNMENT_STATUSAcciónGets 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Group UsersMICROSOFT_POWER_BI_GET_GROUP_USERSAcciónReturns 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.
MICROSOFT_POWER_BI_GET_GROUP_USERSAcciónReturns 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.
Parámetros de entrada
topintegerReturns only the first n results
skipintegerSkips the first n results
group_idstringObligatorioThe workspace ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ImportMICROSOFT_POWER_BI_GET_IMPORTAcciónReturns 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
MICROSOFT_POWER_BI_GET_IMPORTAcciónReturns 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
Parámetros de entrada
importIdstringObligatorioThe import ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Imports from My WorkspaceMICROSOFT_POWER_BI_GET_IMPORTS2AcciónReturns 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
MICROSOFT_POWER_BI_GET_IMPORTS2AcciónReturns 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
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Imports in WorkspaceMICROSOFT_POWER_BI_GET_IMPORTS_IN_GROUPAcciónReturns 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.
MICROSOFT_POWER_BI_GET_IMPORTS_IN_GROUPAcciónReturns 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.
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Linked Report History SnapshotMICROSOFT_POWER_BI_GET_LINKED_REPORT_HISTORY_SNAPSHOTAcciónGets 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.
MICROSOFT_POWER_BI_GET_LINKED_REPORT_HISTORY_SNAPSHOTAcciónGets 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.
Parámetros de entrada
idstringObligatorioThe 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.
historyIdstringObligatorioThe Id property of the HistorySnapshot.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Report PageMICROSOFT_POWER_BI_GET_PAGEAcciónReturns 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.
MICROSOFT_POWER_BI_GET_PAGEAcciónReturns 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.
Parámetros de entrada
group_idstringObligatorioThe workspace ID
page_namestringObligatorioThe page name
report_idstringObligatorioThe report ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Pages from ReportMICROSOFT_POWER_BI_GET_PAGESAcciónReturns 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
MICROSOFT_POWER_BI_GET_PAGESAcciónReturns 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
reportIdstringObligatorioThe report ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Pages from Report in My WorkspaceMICROSOFT_POWER_BI_GET_PAGES_IN_MY_WORKSPACEAcciónReturns 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
MICROSOFT_POWER_BI_GET_PAGES_IN_MY_WORKSPACEAcciónReturns 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
Parámetros de entrada
reportIdstringObligatorioThe report ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dataset ParametersMICROSOFT_POWER_BI_GET_PARAMETERSAcciónReturns a list of parameters for the specified dataset from **My workspace**. Use this action when you need to retrieve all parameter definitions and their current values for a Power BI dataset, 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. Required Scope: Dataset.Read
MICROSOFT_POWER_BI_GET_PARAMETERSAcciónReturns a list of parameters for the specified dataset from **My workspace**. Use this action when you need to retrieve all parameter definitions and their current values for a Power BI dataset, 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. Required Scope: Dataset.Read
Parámetros de entrada
datasetIdstringObligatorioThe unique identifier of the Power BI dataset in My Workspace.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dataset Parameters in WorkspaceMICROSOFT_POWER_BI_GET_PARAMETERS_IN_GROUP2AcciónReturns 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
MICROSOFT_POWER_BI_GET_PARAMETERS_IN_GROUP2AcciónReturns 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasetIdstringObligatorioThe unique identifier of the Power BI dataset in the workspace.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Query Scale Out Sync StatusMICROSOFT_POWER_BI_GET_QUERY_SCALE_OUT_SYNC_STATUS_2AcciónReturns 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
MICROSOFT_POWER_BI_GET_QUERY_SCALE_OUT_SYNC_STATUS_2AcciónReturns 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Refreshable For CapacityMICROSOFT_POWER_BI_GET_REFRESHABLE_CAPACITY_2AcciónReturns 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
MICROSOFT_POWER_BI_GET_REFRESHABLE_CAPACITY_2AcciónReturns 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
Parámetros de entrada
expandstring[]Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports 'capacities' and 'groups'.
capacity_idstringObligatorioThe capacity ID
refreshable_idstringObligatorioThe refreshable ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get refreshables for all capacitiesMICROSOFT_POWER_BI_GET_REFRESHABLESAcciónReturns 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.
MICROSOFT_POWER_BI_GET_REFRESHABLESAcciónReturns 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.
Parámetros de entrada
topintegerReturns only the first n results.
skipintegerSkips the first n results. Use with top to fetch results beyond the first 1000.
expandstringAccepts a comma-separated list of data types, which will be expanded inline in the response. Supports `capacity` and `group`.
filterstringReturns a subset of results based on OData filter query parameter condition.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Refresh Execution Details In GroupMICROSOFT_POWER_BI_GET_REFRESH_EXECUTION_DETAILS_IN_GROUPAcciónReturns 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
MICROSOFT_POWER_BI_GET_REFRESH_EXECUTION_DETAILS_IN_GROUPAcciónReturns 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasetIdstringObligatorioThe dataset ID.
refreshIdstringObligatorioThe refresh ID that identifies the specific refresh operation.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Refresh History for DatasetMICROSOFT_POWER_BI_GET_REFRESH_HISTORYAcciónReturns 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.
MICROSOFT_POWER_BI_GET_REFRESH_HISTORYAcciónReturns 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.
Parámetros de entrada
topintegerThe requested number of entries in the refresh history. If not provided, the default is the last available 60 entries.
dataset_idstringObligatorioThe dataset ID of the dataset to get refresh history for
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Dataset Refresh ScheduleMICROSOFT_POWER_BI_GET_REFRESH_SCHEDULEAcciónReturns 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
MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULEAcciónReturns 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
Parámetros de entrada
dataset_idstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Refresh Schedule In Group 2MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULE_IN_GROUP2AcciónReturns 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.
MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULE_IN_GROUP2AcciónReturns 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.
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasetIdstringObligatorioThe dataset ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Report from My WorkspaceMICROSOFT_POWER_BI_GET_REPORT3AcciónReturns 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
MICROSOFT_POWER_BI_GET_REPORT3AcciónReturns 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
Parámetros de entrada
reportIdstringObligatorioThe report ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Report Page From My WorkspaceMICROSOFT_POWER_BI_GET_REPORT_PAGE2AcciónReturns 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
MICROSOFT_POWER_BI_GET_REPORT_PAGE2AcciónReturns 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
Parámetros de entrada
page_namestringObligatorioThe page name
report_idstringObligatorioThe report ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ReportsMICROSOFT_POWER_BI_GET_REPORTSAcciónGets an array of Report CatalogItems from Power BI. Use this action when you need to retrieve all reports available in the Power BI service. This is useful for browsing the report catalog, finding specific reports, or auditing available resources. The endpoint supports OData query parameters for filtering, sorting, and pagination. Required Scope: Report.Read.All or Report.ReadWrite.All Note: This endpoint uses the v2.0 Power BI Report Server API path.
MICROSOFT_POWER_BI_GET_REPORTSAcciónGets an array of Report CatalogItems from Power BI. Use this action when you need to retrieve all reports available in the Power BI service. This is useful for browsing the report catalog, finding specific reports, or auditing available resources. The endpoint supports OData query parameters for filtering, sorting, and pagination. Required Scope: Report.Read.All or Report.ReadWrite.All Note: This endpoint uses the v2.0 Power BI Report Server API path.
Parámetros de entrada
topintegerShow only the first n items. See OData Paging - Top.
skipintegerSkip the first n items. See OData Paging - Skip.
countstringInclude count of items. See OData Count.
filterstringFilter items by property values. See OData Filtering.
selectstringSelect properties to be returned. See OData Select.
order_bystringOrder items by property values. See OData Sorting.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Reports From My WorkspaceMICROSOFT_POWER_BI_GET_REPORTS3AcciónReturns 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.
MICROSOFT_POWER_BI_GET_REPORTS3AcciónReturns 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ResourcesMICROSOFT_POWER_BI_GET_RESOURCESAcciónGets an array of Resource catalog items. Use this action when you need to retrieve all Power BI resources from the catalog. This is useful for exploring available resources, finding specific resource IDs, or managing resource content. Note: This endpoint uses the Power BI REST API (cloud service).
MICROSOFT_POWER_BI_GET_RESOURCESAcciónGets an array of Resource catalog items. Use this action when you need to retrieve all Power BI resources from the catalog. This is useful for exploring available resources, finding specific resource IDs, or managing resource content. Note: This endpoint uses the Power BI REST API (cloud service).
Parámetros de entrada
topintegerShow only the first n items, see OData Paging - Top
skipintegerSkip the first n items, see OData Paging - Skip
countbooleanInclude count of items, see OData Count
filterstringFilter items by property values, see OData Filtering
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Scorecard By IDMICROSOFT_POWER_BI_GET_SCORECARD_BY_IDAcciónReturns a scorecard with the specified ID. Use this action when you need to retrieve details about a specific Power BI scorecard within a workspace, including its goals, metrics, and configuration. This action supports optional OData expansion for including related data like goals, goal values, aggregations, and notes in the response. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All
MICROSOFT_POWER_BI_GET_SCORECARD_BY_IDAcciónReturns a scorecard with the specified ID. Use this action when you need to retrieve details about a specific Power BI scorecard within a workspace, including its goals, metrics, and configuration. This action supports optional OData expansion for including related data like goals, goal values, aggregations, and notes in the response. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All
Parámetros de entrada
expandstringAccepts a comma-separated list of data types to expand inline in the response. Supports: goals, goalValues, aggregations, notes
groupIdstringObligatorioThe unique identifier of the workspace
scorecardIdstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ScorecardsMICROSOFT_POWER_BI_GET_SCORECARDSAcciónReturns 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
MICROSOFT_POWER_BI_GET_SCORECARDSAcciónReturns 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
Parámetros de entrada
topintegerReturns only the first n results.
groupIdstringObligatorioThe unique identifier of the workspace (group).
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Tables in DatasetMICROSOFT_POWER_BI_GET_TABLESAcciónReturns 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
MICROSOFT_POWER_BI_GET_TABLESAcciónReturns 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
Parámetros de entrada
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Tables in Dataset within WorkspaceMICROSOFT_POWER_BI_GET_TABLES_IN_GROUPAcciónReturns 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.
MICROSOFT_POWER_BI_GET_TABLES_IN_GROUPAcciónReturns 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.
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Tiles from My Workspace DashboardMICROSOFT_POWER_BI_GET_TILES2AcciónReturns 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
MICROSOFT_POWER_BI_GET_TILES2AcciónReturns 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
Parámetros de entrada
dashboard_idstringObligatorioThe dashboard ID (UUID)
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Tiles from Workspace DashboardMICROSOFT_POWER_BI_GET_TILES3AcciónReturns 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
MICROSOFT_POWER_BI_GET_TILES3AcciónReturns 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
Parámetros de entrada
group_idstringObligatorioThe workspace (group) ID
dashboard_idstringObligatorioThe dashboard ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WorkspaceMICROSOFT_POWER_BI_GET_WORKSPACEAcciónReturns 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
MICROSOFT_POWER_BI_GET_WORKSPACEAcciónReturns 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Trigger Query Scale Out Sync in WorkspaceMICROSOFT_POWER_BI_MICROSOFT_POWER_BI_DATASETS_TRIGGER_QUERY_SCALE_OUT_SYNC_IN_GROUPAcciónTriggers 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
MICROSOFT_POWER_BI_MICROSOFT_POWER_BI_DATASETS_TRIGGER_QUERY_SCALE_OUT_SYNC_IN_GROUPAcciónTriggers 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Move Power BI Scorecard GoalsMICROSOFT_POWER_BI_MOVE_GOALSAcciónMoves 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
MICROSOFT_POWER_BI_MOVE_GOALSAcciónMoves 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
Parámetros de entrada
group_idstringObligatorioThe unique identifier of the workspace (group)
new_nextobjectRank 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.
new_parentobjectRank 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.
goal_to_moveobjectObligatorioThe goal to move and its current position validation information
new_previousobjectRank 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.
scorecard_idstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Patch Goal NoteMICROSOFT_POWER_BI_PATCH_GOAL_NOTEAcciónUpdates 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
MICROSOFT_POWER_BI_PATCH_GOAL_NOTEAcciónUpdates 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
Parámetros de entrada
bodystringObligatorioThe note text content to be updated
goalIdstringObligatorioThe unique identifier of the goal
noteIdstringObligatorioThe unique identifier of the goal check-in note
groupIdstringObligatorioThe unique identifier of the workspace
timestampstringObligatorioThe timestamp for the value of the goal (e.g., 2024-05-12T00:00:00Z)
scorecardIdstringObligatorioThe unique identifier of the scorecard
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Patch Goal Value By IDMICROSOFT_POWER_BI_PATCH_GOAL_VALUE_BY_IDAcciónUpdates 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
MICROSOFT_POWER_BI_PATCH_GOAL_VALUE_BY_IDAcciónUpdates 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
Parámetros de entrada
trendintegerThe goal value trend.
valuenumberThe goal current value.
goalIdstringObligatorioThe unique identifier of the goal.
statusintegerThe ID of the goal status. 0=Not started, 1=On track, 2=At risk, 3=Behind, 4=Overdue, 5=Completed.
targetnumberThe goal target value.
groupIdstringObligatorioThe unique identifier of the workspace (group).
forecastnumberThe goal value trend forecast.
timestampstringObligatorioThe UTC timestamp for the value of the goal (e.g., 2026-05-12T00:00:00Z).
createdTimestringThe UTC time at creation.
scorecardIdstringObligatorioThe unique identifier of the scorecard.
lastModifiedTimestringThe UTC time at last modification.
valueDisplayStringstringThe textual representation of the current goal value.
targetDisplayStringstringThe textual representation of the goal target.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Patch Scorecard By IDMICROSOFT_POWER_BI_PATCH_SCORECARD_BY_IDAcciónUpdates 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
MICROSOFT_POWER_BI_PATCH_SCORECARD_BY_IDAcciónUpdates 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
Parámetros de entrada
namestringThe scorecard name
goalsobject[]The scorecard goals
groupIdstringObligatorioThe unique identifier of the workspace (group)
reportIdstringThe ID of the internal report associated with the scorecard
datasetIdstringThe ID of the dataset associated with the scorecard
descriptionstringThe scorecard description
permissionsstringenumThe scorecard permissions.
NoneReadWriteReadWritescorecardIdstringObligatorioThe unique identifier of the scorecard
columnSettingsobject[]The display settings for columns on a scorecard
provisioningStatusstringenumThe provisioning status of the scorecard.
InitializedCompletedFailedDeprovisioningDeleted
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Push Dataset in WorkspaceMICROSOFT_POWER_BI_POST_DATASET_IN_GROUPAcciónCreates 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.
MICROSOFT_POWER_BI_POST_DATASET_IN_GROUPAcciónCreates 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.
Parámetros de entrada
namestringObligatorioThe name of the dataset to create.
tablesobject[]ObligatorioThe list of tables to create in the dataset.
group_idstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasourcesobject[]The data sources associated with this dataset.
default_modestringenumDataset mode or type.
AsAzureAsOnPremPushStreamingPushStreamingrelationshipsobject[]The relationships between tables in this dataset.
default_retention_policystringenumDefault retention policy for the dataset.
NonebasicFIFO
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Grant Dataset User PermissionsMICROSOFT_POWER_BI_POST_DATASET_USERAcciónGrants 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.
MICROSOFT_POWER_BI_POST_DATASET_USERAcciónGrants 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.
Parámetros de entrada
dataset_idstringObligatorioThe dataset ID.
identifierstringObligatorioIdentifier of the user (email address for User principalType, group ID for Group, app ID for App).
principal_typestringObligatorioenumThe type of principal (User, Group, or App).
UserGroupAppdataset_user_access_rightstringObligatorioenumThe 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.
ReadReadReshareReadExploreReadReshareExplore
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Grant Dataset User Permissions In GroupMICROSOFT_POWER_BI_POST_DATASET_USER_IN_GROUPAcciónGrants 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
MICROSOFT_POWER_BI_POST_DATASET_USER_IN_GROUPAcciónGrants 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
datasetIdstringObligatorioThe dataset ID
identifierstringObligatorioIdentifier of the user (email address for User principalType, group ID for Group, app ID for App).
principalTypestringObligatorioenumThe type of principal (User, Group, or App).
UserGroupAppdatasetUserAccessRightstringObligatorioenumThe 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.
ReadReadReshareReadExploreReadReshareExplore
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post GoalMICROSOFT_POWER_BI_POST_GOALAcciónAdds 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.
MICROSOFT_POWER_BI_POST_GOALAcciónAdds 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.
Parámetros de entrada
namestringObligatorioThe goal name.
groupIdstringObligatorioThe unique identifier of the workspace (group).
parentIdstringOptional. The ID of the parent goal, if defined.
startDatestringOptional. The UTC timestamp for the start date of the goal. The time portion is zero.
scorecardIdstringObligatorioThe unique identifier of the scorecard.
completionDatestringOptional. The UTC timestamp for the completion date of the goal. The time portion is zero.
datesFormatStringstringOptional. The custom format string for dates.
valuesFormatStringstringOptional. The custom format string for values.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post Goal NoteMICROSOFT_POWER_BI_POST_GOAL_NOTEAcciónAdds 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
MICROSOFT_POWER_BI_POST_GOAL_NOTEAcciónAdds 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
Parámetros de entrada
bodystringObligatorioThe note text to be added to the goal value check-in
goalIdstringObligatorioThe unique identifier of the goal
groupIdstringObligatorioThe unique identifier of the workspace (group) containing the scorecard
timestampstringObligatorioThe UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
scorecardIdstringObligatorioThe unique identifier of the scorecard containing the goal
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Rows to Dataset Table in WorkspaceMICROSOFT_POWER_BI_POST_ROWS_IN_GROUPAcciónAdds new data rows to the specified table within the specified dataset from the specified workspace. Use this action when you need to push new data rows into a Power BI push dataset table. This action is idempotent — pushing the same rows multiple times will add duplicate data. The dataset must be a push dataset (Push, Streaming, or PushStreaming mode) with the Add Rows API enabled. Required Scope: Dataset.ReadWrite.All
MICROSOFT_POWER_BI_POST_ROWS_IN_GROUPAcciónAdds new data rows to the specified table within the specified dataset from the specified workspace. Use this action when you need to push new data rows into a Power BI push dataset table. This action is idempotent — pushing the same rows multiple times will add duplicate data. The dataset must be a push dataset (Push, Streaming, or PushStreaming mode) with the Add Rows API enabled. Required Scope: Dataset.ReadWrite.All
Parámetros de entrada
rowsobject[]ObligatorioAn array of data rows to push to the dataset table. Each element is a collection of properties represented using key-value format.
groupIdstringObligatorioThe workspace ID
datasetIdstringObligatorioThe dataset ID
tableNamestringObligatorioThe table name within the dataset
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post Goal Status RulesMICROSOFT_POWER_BI_POST_STATUS_RULESAcciónCreates 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
MICROSOFT_POWER_BI_POST_STATUS_RULESAcciónCreates 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
Parámetros de entrada
rulesobject[]Optional. The list of status rules to apply.
goalIdstringObligatorioThe unique identifier of the goal
groupIdstringObligatorioThe unique identifier of the workspace
scorecardIdstringObligatorioThe unique identifier of the scorecard
defaultOutputintegerObligatorioThe default status ID when no rule matches. Values: 0=Not started, 1=On track, 2=At risk, 3=Behind, 4=Overdue, 5=Completed.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Table SchemaMICROSOFT_POWER_BI_PUT_TABLEAcciónUpdates 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
MICROSOFT_POWER_BI_PUT_TABLEAcciónUpdates 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
Parámetros de entrada
namestringObligatorioThe table name (must match the tableName path parameter).
sourceobject[]The list of sources for this table (used for streaming datasets).
columnsobject[]ObligatorioThe list of column definitions for this table. This replaces existing columns.
measuresobject[]The list of measure definitions for this table.
is_hiddenbooleanWhether the table is hidden from client tools.
dataset_idstringObligatorioThe dataset ID containing the table to update.
table_namestringObligatorioThe name of the table to update.
descriptionstringThe table description.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Table Schema in WorkspaceMICROSOFT_POWER_BI_PUT_TABLE_IN_GROUPAcciónUpdates 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
MICROSOFT_POWER_BI_PUT_TABLE_IN_GROUPAcciónUpdates 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
Parámetros de entrada
namestringObligatorioThe table name (must match the tableName path parameter).
sourceobject[]The list of sources for this table (used for streaming datasets).
columnsobject[]ObligatorioThe list of column definitions for this table. This replaces existing columns.
group_idstringObligatorioThe workspace (group) ID containing the dataset.
measuresobject[]The list of measure definitions for this table.
is_hiddenbooleanWhether the table is hidden from client tools.
dataset_idstringObligatorioThe dataset ID containing the table to update.
table_namestringObligatorioThe name of the table to update.
descriptionstringThe table description.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Rebind Report to DatasetMICROSOFT_POWER_BI_REBIND_REPORTAcciónRebinds the specified report from the specified workspace to the specified dataset. Use this action when you need to change which dataset a Power BI report uses. This is useful for migrating reports to different datasets, connecting reports to updated data sources, or consolidating multiple reports under a single dataset. If the target dataset resides in a different workspace than the report, a shared dataset will be automatically created in the report's workspace. Required Scope: Report.ReadWrite.All
MICROSOFT_POWER_BI_REBIND_REPORTAcciónRebinds the specified report from the specified workspace to the specified dataset. Use this action when you need to change which dataset a Power BI report uses. This is useful for migrating reports to different datasets, connecting reports to updated data sources, or consolidating multiple reports under a single dataset. If the target dataset resides in a different workspace than the report, a shared dataset will be automatically created in the report's workspace. Required Scope: Report.ReadWrite.All
Parámetros de entrada
groupIdstringObligatorioThe workspace ID. The report must belong to this workspace.
reportIdstringObligatorioThe report ID to rebind.
datasetIdstringObligatorioThe 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Trigger Dataset Refresh in WorkspaceMICROSOFT_POWER_BI_REFRESH_DATASET_IN_GROUPAcciónTriggers 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.
MICROSOFT_POWER_BI_REFRESH_DATASET_IN_GROUPAcciónTriggers 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.
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that contains the dataset.
datasetIdstringObligatorioThe dataset ID to refresh.
datasetRefreshRequestobjectPower 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Report Embed Token for Create in GroupMICROSOFT_POWER_BI_REPORTS_GENERATE_TOKEN_CREATE_IN_GROUPAcciónGenerates 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
MICROSOFT_POWER_BI_REPORTS_GENERATE_TOKEN_CREATE_IN_GROUPAcciónGenerates 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
Parámetros de entrada
group_idstringObligatorioThe workspace ID
dataset_idstringThe dataset ID used for report creation. Only applies when you generate an embed token for report creation.
identitiesobject[]A list of identities to use for row-level security rules.
access_levelstringObligatorioenumThe required access level for embed token generation.
ViewEditCreateallow_save_asbooleanWhether 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.
lifetime_in_minutesintegerThe 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Linked Report Cache OptionsMICROSOFT_POWER_BI_SET_LINKED_REPORT_CACHE_OPTIONSAcciónReplaces 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
MICROSOFT_POWER_BI_SET_LINKED_REPORT_CACHE_OPTIONSAcciónReplaces 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
Parámetros de entrada
idstringObligatorioThe 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.
cache_optionsobjectObligatorioThe cache options configuration to apply to the linked report.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Take Over DatasetMICROSOFT_POWER_BI_TAKE_OVER_DATASETAcciónTransfers 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
MICROSOFT_POWER_BI_TAKE_OVER_DATASETAcciónTransfers 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that contains the dataset
datasetIdstringObligatorioThe dataset ID to take over
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Take Over Paginated Report OwnershipMICROSOFT_POWER_BI_TAKE_OVER_REPORT_IN_GROUPAcciónTransfers 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
MICROSOFT_POWER_BI_TAKE_OVER_REPORT_IN_GROUPAcciónTransfers 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID
reportIdstringObligatorioThe report ID of the paginated report (RDL)
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Trigger Query Scale Out SyncMICROSOFT_POWER_BI_TRIGGER_QUERY_SCALE_OUT_SYNCAcciónTriggers 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
MICROSOFT_POWER_BI_TRIGGER_QUERY_SCALE_OUT_SYNCAcciónTriggers 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
Parámetros de entrada
datasetIdstringObligatorioThe dataset ID
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update DatasetMICROSOFT_POWER_BI_UPDATE_DATASETAcciónUpdates 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
MICROSOFT_POWER_BI_UPDATE_DATASETAcciónUpdates 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
Parámetros de entrada
datasetIdstringObligatorioThe dataset ID.
targetStorageModestringThe dataset storage mode. Values: Abf, PremiumFiles, SmallSemanticModel.
queryScaleOutSettingsobjectQuery scale out settings for the dataset update request.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Dataset In WorkspaceMICROSOFT_POWER_BI_UPDATE_DATASET_IN_GROUPAcciónUpdates 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
MICROSOFT_POWER_BI_UPDATE_DATASET_IN_GROUPAcciónUpdates 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasetIdstringObligatorioThe dataset ID.
targetStorageModestringThe dataset storage mode. Values: Abf, PremiumFiles, SmallSemanticModel.
queryScaleOutSettingsobjectQuery scale out settings for the dataset update request.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Paginated Report Data SourcesMICROSOFT_POWER_BI_UPDATE_DATASOURCES3AcciónUpdates 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
MICROSOFT_POWER_BI_UPDATE_DATASOURCES3AcciónUpdates 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
Parámetros de entrada
groupIdstringObligatorioThe workspace ID.
reportIdstringObligatorioThe paginated report ID.
updateDetailsobject[]ObligatorioThe update details for the data sources of the paginated report. Each item specifies the data source name and new connection details.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Patch Goal By IDMICROSOFT_POWER_BI_UPDATE_GOAL_BY_IDAcciónUpdates 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
MICROSOFT_POWER_BI_UPDATE_GOAL_BY_IDAcciónUpdates 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
Parámetros de entrada
idstringThe goal ID
namestringThe goal name
rankintegerThe rank of the goal within the ordered set of sibling goals
levelintegerThe nested level of the goal in the parent-child hierarchy of scorecard goals
goalIdstringObligatorioThe unique identifier of the goal
groupIdstringObligatorioThe unique identifier of the workspace (group)
parentIdstringThe ID of the parent goal, if defined.
startDatestringThe UTC timestamp for the start date of the goal. The time portion of the timestamp is zero.
goalValuesobject[]The list of goal value check-ins
notesCountintegerThe number of notes
createdTimestringThe UTC time at creation
descriptionstringThe goal description
permissionsstringenumThe goal permissions.
NoneViewUpdateCurrentValueUpdateTargetValueUpdateNotesUpdateStatusUpdateValuesAllscorecardIdstringObligatorioThe unique identifier of the scorecard
statusRulesobjectA container for JSON definitions of status rules on a Power BI goal.
aggregationsobject[]The list of aggregated properties of the goal
completionDatestringThe UTC timestamp for the completion date of the goal. The time portion of the timestamp is zero.
hasStatusRulesbooleanWhether the goal has status rules defined
lastModifiedTimestringThe UTC time at last modification
datesFormatStringstringThe format string for dates
valuesFormatStringstringThe format string for values
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Dataset Parameters in WorkspaceMICROSOFT_POWER_BI_UPDATE_PARAMETERS_IN_GROUP2AcciónUpdates 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.
MICROSOFT_POWER_BI_UPDATE_PARAMETERS_IN_GROUP2AcciónUpdates 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.
Parámetros de entrada
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasetIdstringObligatorioThe unique identifier of the Power BI dataset.
updateDetailsobject[]ObligatorioA list of dataset parameters to update. At least one parameter update is required.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Refresh ScheduleMICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULEAcciónUpdates 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
MICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULEAcciónUpdates 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
Parámetros de entrada
valueobjectThe refresh schedule configuration for a dataset.
datasetIdstringObligatorioThe dataset ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Refresh Schedule In GroupMICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULE_IN_GROUP3AcciónUpdates 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
MICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULE_IN_GROUP3AcciónUpdates 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
Parámetros de entrada
valueobjectThe refresh schedule configuration for a dataset in a workspace.
groupIdstringObligatorioThe workspace ID (group ID) that identifies the workspace.
datasetIdstringObligatorioThe dataset ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Report ContentMICROSOFT_POWER_BI_UPDATE_REPORT_CONTENTAcciónUpdates 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
MICROSOFT_POWER_BI_UPDATE_REPORT_CONTENTAcciónUpdates 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
Parámetros de entrada
report_idstringObligatorioThe report ID in My workspace to update
source_typestringObligatorioThe source type. Must be 'ExistingReport'
source_reportobjectObligatorioThe source report to copy content from
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update WorkspaceMICROSOFT_POWER_BI_UPDATE_WORKSPACEAcciónUpdates 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
MICROSOFT_POWER_BI_UPDATE_WORKSPACEAcciónUpdates 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
Parámetros de entrada
namestringThe workspace name. Include this property to rename the workspace.
groupIdstringObligatorioThe workspace ID
defaultDatasetStorageFormatstringenumDataset storage format for the workspace.
SmallLarge
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not