To export and import data in Microsoft Power BI® and manage the various objects that make up your Power BI deployment as part of a chain, add a step that includes a Microsoft Power BI connection command.
To enable these commands, an IT admin first creates a Power BI connector.
Note: The connector can't connect Power BI with multi-factor authentication (MFA) enabled.
Add Rows to Dataset
Adds new data rows to the specified table, within the specified dataset, from the specified workspace
Note: Duplicate rows are ignored in Power BI but are still considered added in this command.
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset ID |
Enter the ID of the dataset |
| Table Name |
Enter the name of the table to add rows to |
| Data |
Enter the file that contains the data to add to the table |
| Data Type |
Select whether the Data input file is JSON or CSV |
| Delimiter |
If the Data Type input is CSV, enter the delimiter used in the file |
Outputs
| Output |
Output Type |
| Rows Added |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Bind Dataset to Gateway
Binds the specified dataset from the specified workspace to the specified gateway. Only supported from the On-Premises Data Gateway.
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset ID |
Enter the ID of the dataset |
| Gateway |
Enter the ID of the gateway |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Clone Report
Clones the specified report from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Report ID |
Enter the ID of the report |
| Name |
Enter the name of the new report created |
| Target Dataset ID |
Enter the ID of the dataset for the new report. To associate the new report with the same dataset as the Report ID input, leave blank. |
| Target Workspace ID |
Enter the ID of the workspace for the new report. For "My Workspace", enter an empty GUID of 00000000-0000-0000-0000-0000000000.To associate the new report with the same workspace as the Workspace ID input, leave blank. |
Outputs
| Output |
Output Type |
| Report |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Create Dataset
Creates a new dataset in the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Name |
Enter the name of the dataset |
| Tables |
Enter the tables in the dataset |
Outputs
| Output |
Output Type |
| Dataset |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Create Temporary Upload Location
Creates a temporary blob storage to be used to import .PBIX files larger than 1 GB and up to 10 GB.
To import large .PBIX files, create a temporary upload location, upload the .PBIX file using the shared access signature (SAS) URL from the response, and call Post Import to Group and specify the fileUrl to be the SAS URL in the Request Body.
Note: Import large .PBIX files is only available for workspaces on premium capacity and for .PBIX files between 1 GB and 10 GB.
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
Outputs
| Output |
Output Type |
| URL |
String |
| Expires At |
Date |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Delete All Rows in Table
Deletes all rows from the specified table, within the specified dataset, from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset ID |
Enter the ID of the dataset |
| Table Name |
Enter the name of the table to delete rows from |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Delete Dataset
Deletes the specified dataset from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset ID |
Enter the ID of the dataset |
Outputs
| Output |
Output Type |
| Dataset |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Delete Report
Deletes the specified report from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Report ID |
Enter the ID of the report |
Outputs
| Output |
Output Type |
| Deleted Report ID |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Export Report
Exports the specified report from the specified workspace to a .PBIX file
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Report ID |
Enter the ID of the report |
Outputs
| Output |
Output Type |
| Report Export (.PBIX) |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Get Dataset
Retrieves the specified dataset from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset ID |
Enter the ID of the dataset |
Outputs
| Output |
Output Type |
| Dataset |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Get Dataset Datasources
Retrieves a list of datasources for the specified dataset from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset ID |
Enter the ID of the dataset |
Outputs
| Output |
Output Type |
| Datasources |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Get Dataset Tables
Retrieves a list of tables within the specified dataset from the specified workspace.
Note: This command supports only Push datasets.
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset ID |
Enter the ID of the dataset |
Outputs
| Output |
Output Type |
| Tables |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Get Report
Retrieves the specified report from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Report ID |
Enter the ID of the report |
Outputs
| Output |
Output Type |
| Report |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Import File
Creates new content on the specified workspace from .PBIX, .JSON, or Microsoft Excel®.
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset Name |
Enter the display name of the data, including its file extension |
| On Name Conflict |
Select what to do if a dataset with the same name already exists. By default, Ignore. |
| .PBIX File |
If importing a .PBIX file, enter the file to import. File must be less than 1GB. |
| Import Info |
If importing a large .PBIX file, enter its details |
| Run Asynchronously |
To not wait for the import to finish, check this box |
Outputs
| Output |
Output Type |
| Import |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
List Dashboards
Lists the dashboards that exist in a workspace and that the user can access
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
Outputs
| Output |
Output Type |
| Dashboards |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
List Datasets
Lists the datasets that exist in a workspace and that the user can access
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
Outputs
| Output |
Output Type |
| Datasets |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
List Gateway Datasources
Lists the datasources from the specified gateway
Inputs
| Input |
Detail |
| Gateway ID |
Enter the ID of the gateway |
Outputs
| Output |
Output Type |
| Datasources |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
List Gateways
Lists the gateway the user is an admin of
Inputs
None
Outputs
| Output |
Output Type |
| Gateways |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
List Reports
Lists the reports from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
Outputs
| Output |
Output Type |
| Reports |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Rebind Reports to Dataset
Rebinds the specified report from the specified workspace to the requested dataset
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Report ID |
Enter the ID of the report |
| Dataset ID |
Enter the ID of the new dataset for the rebinded report |
Outputs
| Output |
Output Type |
| Report ID |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Refresh Dataset
Refreshes the specified dataset from the specified workspace
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Dataset ID |
Enter the ID of the dataset |
| Notification Type |
Select the type of notification to send when the refresh completes |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |
Update Report Content
Updates the specified report from the specified workspace to have the same content as the specified report in the request body
Inputs
| Input |
Detail |
| Workspace ID |
Enter the ID of the workspace |
| Report ID |
Enter the ID of the report |
| Source Report ID |
Enter the ID of the source report |
| Source Workspace ID |
Enter the ID of the workspace with the source report |
Outputs
| Output |
Output Type |
| Report |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error during execution |
| 2 |
Error |
There was an error authenticating with Power BI |