Skip to main content

Microsoft Power BI Component

Interact with and modify Power BI datasets

Component key: ms-power-bi

Description#

Microsoft Power BI is a Microsoft data visualization and business analytics service. This component allows you to interact with datasets and update data schemas.

Microsoft Power BI Connections#

OAuth 2.0#

The Microsoft Power BI component authenticates requests through the Microsoft Graph API. To configure OAuth 2.0 you must first create an application through Active Directory in the Microsoft Azure portal. For more information regarding authenticating against the Microsoft Graph API refer to Microsoft's documentation.

Next, supply the following values to the OAuth 2.0 connection in your integration within Prismatic:

  • For Client ID and Client Secret enter the values that you got from the Microsoft Azure Portal.
  • For Scopes choose from the options found on the Microsoft Graph API documentation
  • For Authorize URL and Token URL you will need to identify your Azure Tenant ID to include in the URLs or configure your app for multi-tenant which allows using the common endpoints.

Refer to the Microsoft Power BI REST API documentation for more information.

InputDefaultNotesExample
Input
Authorize URL
string
/ Required
Default
https://login.microsoftonline.com/common/oauth2/authorize
Notes
The OAuth 2.0 Authorization URL for Microsoft Power BI
Example
 
Input
Client ID
string
/ Required
Default
 
Notes
Generate at https://dev.powerbi.com/apps
Example
 
Input
Client Secret
password
/ Required
Default
 
Notes
Generate at https://dev.powerbi.com/apps
Example
 
Input
Scopes
string
Default
 
Notes
Microsoft Power BI permission scopes must also be set on the OAuth application
Example
https://analysis.windows.net/powerbi/api/Dataset.ReadWrite.All
Input
Token URL
string
/ Required
Default
https://login.microsoftonline.com/common/oauth2/v2.0/token
Notes
The OAuth 2.0 Token URL for Microsoft Power BI
Example
 

Actions#

Create Dataset#

Creates a new dataset on 'My Workspace' | key: createDataset

InputNotesExample
Input
Columns
string
/ Required
Value List
Notes
For each item, provide an object containing the column name and data type.
Example
{ "name": "ProductID", "dataType": "Int64" }
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Dataset Name
string
/ Required
Notes
Provide a string value for the name of the database you want to interact with.
Example
MyDatabase
Input
Table Name
string
/ Required
Notes
 
Example
 

Create Row#

Adds new data rows to the specified table within the specified dataset from 'My Workspace' | key: createRow

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Dataset ID
string
/ Required
Notes
A dataset is a spreadsheet like document that can be used to generate reports and visuals in Power BI.
Example
myExampleDataset
Input
Rows
data
/ Required
Value List
Notes
For each item, provide an object containing the fields to be inserted.
Example
{ "ProductID": 1, "Name": "Adjustable Race", "Category": "Components", "ManufacturedOn": "07/30/2014" }
Input
Table Name
string
/ Required
Notes
 
Example
 

Delete Rows#

Deletes all rows from the specified table within the specified dataset from 'My Workspace' | key: deleteRows

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Dataset ID
string
/ Required
Notes
A dataset is a spreadsheet like document that can be used to generate reports and visuals in Power BI.
Example
myExampleDataset
Input
Table Name
string
/ Required
Notes
 
Example
 

List Datasets#

Returns a list of datasets from 'My Workspace' | key: listDatasets

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Page Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Top
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20

List Groups#

Returns a list of workspaces the user has access to | key: listGroups

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Page Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Top
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20

List Reports#

Returns a list of reports from 'My Workspace' | key: listReports

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Page Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Top
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20

List Tables#

Returns a list of tables tables within the specified dataset from 'My Workspace' | key: listTables

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Dataset ID
string
/ Required
Notes
A dataset is a spreadsheet like document that can be used to generate reports and visuals in Power BI.
Example
myExampleDataset
Input
Page Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Top
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20

Update Table#

Updates the metadata and schema for the specified table within the specified dataset from 'My Workspace' | key: updateTable

InputNotesExample
Input
Columns
string
/ Required
Value List
Notes
For each item, provide an object containing the column name and data type.
Example
{ "name": "ProductID", "dataType": "Int64" }
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Dataset ID
string
/ Required
Notes
A dataset is a spreadsheet like document that can be used to generate reports and visuals in Power BI.
Example
myExampleDataset
Input
Table Name
string
/ Required
Notes
 
Example