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.

Authorization Notes#

The Microsoft Power Bi component authenticates requests through the Microsoft Graph API. To configure an OAuth 2.0 credential 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 the Microsoft docs. Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

  • For Client ID and Client Secret enter the values that you got from the Microsoft Azure Portal.
  • For Scopes and permission choose from the options found on the Microsoft Graph API docs
  • For Authorization URL enter https://login.microsoftonline.com/common/oauth2/authorize
  • For Access Token URL enter https://login.microsoftonline.com/common/oauth2/v2.0/token

Actions#

Create Dataset#

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

InputKeyNotesExample

Columns

string
/ Required
Value List
columnsFor each item, provide an object containing the column name and data type.{ "name": "ProductID", "dataType": "Int64" }

Dataset Name

string
/ Required
datasetNameProvide a string value for the name of the database you want to interact with.MyDatabase

Table Name

string
/ Required
tableName

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Row#

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

InputKeyNotesExample

Dataset ID

string
/ Required
datasetIdA dataset is a spreadsheet like document that can be used to generate reports and visuals in Power BI.myExampleDataset

Rows

data
/ Required
Value List
rowsFor each item, provide an object containing the fields to be inserted.{ "ProductID": 1, "Name": "Adjustable Race", "Category": "Components", "ManufacturedOn": "07/30/2014" }

Table Name

string
/ Required
tableName

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Rows#

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

InputKeyNotesExample

Dataset ID

string
/ Required
datasetIdA dataset is a spreadsheet like document that can be used to generate reports and visuals in Power BI.myExampleDataset

Table Name

string
/ Required
tableName

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Datasets#

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

InputKeyNotesExample

Page Offset

string
skipTokenProvide an integer value for the page offset for the given object's results.3

Top

string
topProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Groups#

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

InputKeyNotesExample

Page Offset

string
skipTokenProvide an integer value for the page offset for the given object's results.3

Top

string
topProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Reports#

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

InputKeyNotesExample

Page Offset

string
skipTokenProvide an integer value for the page offset for the given object's results.3

Top

string
topProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Tables#

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

InputKeyNotesExample

Dataset ID

string
/ Required
datasetIdA dataset is a spreadsheet like document that can be used to generate reports and visuals in Power BI.myExampleDataset

Page Offset

string
skipTokenProvide an integer value for the page offset for the given object's results.3

Top

string
topProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Table#

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

InputKeyNotesExample

Columns

string
/ Required
Value List
columnsFor each item, provide an object containing the column name and data type.{ "name": "ProductID", "dataType": "Int64" }

Dataset ID

string
/ Required
datasetIdA dataset is a spreadsheet like document that can be used to generate reports and visuals in Power BI.myExampleDataset

Table Name

string
/ Required
tableName

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri