Power BI Connector for PowerShell

In this article you will learn how to integrate Power BI data in PowerShell without coding in just a few clicks (live / bi-directional connection to Power BI). Connect to your Power BI account and retrieve data, refresh datasets, etc..

Using Power BI Connector you will be able to connect, read, and write data from within PowerShell. Follow the steps below to see how we would accomplish that.

Download Documentation

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Power BI using PowerShell we first need to create a DSN (Data Source) which will access data from Power BI. We will later be able to read data using PowerShell. Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
  4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Power BI" from the list of Popular Connectors. If "Power BI" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    PowerBiDSN
    Power BI
    ODBC DSN Template Selection

  5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    OAuth App must be created in Microsoft Azure AD. These settings typically found here https://docs.microsoft.com/en-us/graph/auth-register-app-v2. [API Help..]

    Steps to get Power BI Credentials : User Credentials [OAuth]

    Firstly, login into Azure Portal and there create an OAuth application:

    1. Go to Azure Portal and login there.
    2. Then go to Azure Active Directory.
    3. On the left side click menu item App registrations
    4. Then proceed with clicking New registration.
    5. Enter a name for your application.
    6. Select the account types to support with the Supported account types option.
    7. In Redirect URI, select Web.
    8. In the textbox enter https://zappysys.com/oauth as the Redirect URI or another valid redirect URL.
    9. Use this same Redirect URI in the Redirect URI (must match App Redirect URL) grid row.
    10. Copy Client ID and paste it into the API Connection Manager configuration grid in the Client ID row.
    11. Click on the Endpoints link and copy the OAuth 2.0 authorization endpoint (v2) URL to the Authorization URL grid row. Usually it looks similar to this:
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/authorize
    12. Copy the OAuth 2.0 token endpoint (v2) URL to the Token URL grid row. Usually it looks similar to this:
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/token
    13. Close "Endpoints" popup and create a Client Secret in the Certificates & secrets tab.
    14. Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
    15. Now lets setup permissions for the app. Click on API Permissions and on the page click Plus Sign Add Permission
    16. Click on Microsoft Graph API and then choose Delegated Permissions
    17. on Permission list page search or choose permissions as needed. We need to enable following Permissions from 2 Sections: Microsoft Graph API and Power BI Service.
    18. Make sure you have checked below permissions (If you do not need Write feature then you can skip Write scopes)
      offline_access
      Dataset.ReadWrite.All
      
    19. Click Generate Token to generate tokens.
    20. That's it!

    Fill in all required parameters and set optional parameters if needed:

    PowerBiDSN
    Power BI
    User Credentials [OAuth]
    https://api.powerbi.com/v1.0/myorg
    Required Parameters
    Authorization URL Fill in the parameter...
    Token URL Fill in the parameter...
    Client ID Fill in the parameter...
    Scope Fill in the parameter...
    Default Dataset (select after generating tokens) Fill in the parameter...
    Optional Parameters
    Client Secret Fill in the parameter...
    Redirect URI (must match App Redirect URI) Fill in the parameter...
    Default Workspace (Keep Empty for My Workspace - select after generating tokens) Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryWaitTimeMs Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    Login options Fill in the parameter...
    ODBC DSN Oauth Connection Configuration

  6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source.

Video instructions

Read Power BI data in PowerShell

Sometimes, you need to quickly access and work with your Power BI data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:

Viewing data in a terminal
  • Quickly peek at Power BI data
  • Monitor data constantly in your console
Saving data to a file
  • Export data to a CSV file so that it can be sliced and diced in Excel
  • Export data to a JSON file so that it can ingested by other processes
  • Export data to an HTML file for user-friendly view and easy sharing
  • Create a schedule to make it an automatic process
Saving data to a database
  • Store data internally for analysis or for further ETL processes
  • Create a schedule to make it an automatic process
Sending data to another API
  • Integrate data with other systems via external APIs

In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!

Reading individual fields

  1. Open your favorite PowerShell IDE (we are using Visual Studio Code).
  2. Then simply follow these instructions:
    "DSN=PowerBiDSN"
    Read API data with PowerShell using ODBC DSN in Visual Code

    For your convenience, here is the whole PowerShell script:

    # Configure connection string and query
    $connectionString = "DSN=PowerBiDSN"
    $query = "SELECT * FROM Customers"
    
    # Instantiate OdbcDataAdapter and DataTable
    $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
    $table = New-Object System.Data.DataTable
    
    # Fill the table with data
    $adapter.Fill($table)
    
    # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
    $format = "{0}`t{1}`t{2}`t{3}"
    
    # Display data in the console
    foreach ($row in $table.Rows)
    {
        # Construct line based on the format and individual Power BI fields
        $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
        Write-Host $line
    }
    
    Access specific Power BI table field using this code snippet:
    $field = $row["ColumnName"]
    You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.
    For demonstration purposes we are using sample tables which may not be available in Power BI.
  3. To read values in a console, save the script to a file and then execute this command inside PowerShell terminal: Read API data in PowerShell using ODBC DSN
    You can also use even a simpler command inside the terminal, e.g.:
    . 'C:\Users\john\Documents\dsn.ps1'

Retrieving all fields

However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:

"DSN=PowerBiDSN"
Read all API columns from ODBC data source in PowerShell

Again, for your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=PowerBiDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Display data in the console
foreach ($row in $table.Rows) {
    $line = ""
    foreach ($column in $table.Columns) {
        $value = $row[$column.ColumnName]

        # Let's handle NULL values
        if ($value -is [DBNull])
        {
            $value = "(NULL)"
        }
        $line += $value + "`t"
    }
    Write-Host $line
}
You can limit the numbers of lines to retrieve by using a LIMIT keyword in the query, e.g.:
SELECT * FROM Customers LIMIT 10

Using a full ODBC connection string

In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:

  1. Open ODBC data source configuration and click Copy settings:
    ZappySys API Driver - Power BI
    Connect to your Power BI account and retrieve data, refresh datasets, etc.
    PowerBiDSN
    Copy connection string for ODBC application
  2. The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application
  3. Then just paste the connection string into your script: Paste ODBC connection string in PowerShell to read API data
  4. You are good to go! The script will execute the same way as using a DSN.

Have in mind that using a full connection string has length limitations.

Proceed to the next step to find out the details.

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols. It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If it happens you use such API, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the Refresh Token in a file instead of directly in ODBC connection string. Follow the steps below to achieve this.

  1. Open your ODBC data source
  2. Hit Advanced tab and enter a file path:
    ZappySys API Driver - Power BI
    Connect to your Power BI account and retrieve data, refresh datasets, etc.
    PowerBiDSN
    Configure Refresh Token in ODBC data source
    If you cannot find the Advanced tab, try looking for Click to Configure link in Properties tab, under URL text box. Click it, and then configure the file path in OAuth Grant Options tab.
  3. Then click Copy settings button to copy a full connection string and paste it into your script.
  4. Proceed by pasting the connection string into your C# code as an argument when calling the OdbcConnection object's constructor.
  5. Before using it we still have to shorten it manually like this: Shorten ODBC connection string to read API data in PowerShell
  6. Our troubles are over, now you should be able to execute the script with no problems.

Write Power BI data to a file in PowerShell

Save data to a CSV file

Export data to a CSV file so that it can be sliced and diced in Excel:

# Configure connection string and query
$connectionString = "DSN=PowerBiDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force

Save data to a JSON file

Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force

Save data to an HTML file

Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force
Check useful PowerShell cmdlets other than ConvertTo-Csv, ConvertTo-Json, and ConvertTo-Html for other data manipulation scenarios.

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Stored Procedure

  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Stored Procedure

  5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Actions supported by Power BI Connector

Power BI Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Get Workspaces
Get all user's Workspaces.    [Read more...]
 Get a Workspace
Get a Workspace by ID.    [Read more...]
Parameter Description
Id
 Get Datasets
Get Datasets from default or specified Workspace. If WorkspaceId parameter is not supplied, default Workspace will be used.    [Read more...]
Parameter Description
WorkspaceId
 Get a Dataset
Get a Dataset by ID.    [Read more...]
Parameter Description
Id
WorkspaceId
 Create a Push Dataset
Creates a Push Dataset with Tables.    [Read more...]
Parameter Description
Definition JSON describing the created Dataset and its Tables
Option Value
Example { "name": "SalesMarketing", "defaultMode": "Push", "tables": [ { "name": "Product", "columns": [ { "name": "ProductID", "dataType": "Int64" }, { "name": "Name", "dataType": "string" }, { "name": "Category", "dataType": "string" }, { "name": "IsComplete", "dataType": "bool" }, { "name": "ManufacturedOn", "dataType": "DateTime" }, { "name": "Sales", "dataType": "Double", "formatString": "Currency" } ] } ] }
WorkspaceId
Option Value
Default
 Delete a Dataset
Delete a Dataset by ID.    [Read more...]
Parameter Description
Id
WorkspaceId
Option Value
Default
 Refresh a Dataset
Refreshes a Dataset by ID.    [Read more...]
Parameter Description
Id
WorkspaceId
Option Value
Default
 Get Tables
Gets a list of Tables of a Dataset    [Read more...]
Parameter Description
DatasetId
WorkspaceId
Option Value
Default
 Get Table Columns
Gets Columns of a Table    [Read more...]
Parameter Description
TableName
DatasetId
WorkspaceId
Option Value
Default
 Get Table Rows
Reads a Table of a Dataset.    [Read more...]
Parameter Description
TableName
DatasetId
WorkspaceId
Option Value
Default
DaxFilter
Option Value
All Rows true
'Equal to' operator example [Column] = "AnyValue"
'And' operator example [Column1] = "AnyValue1" && [Column2] = "AnyValue2"
'And' and 'Or' operators used together [Column1] = "AnyValue" && ([Column2] = 1234 || [Column3] < 1000)
'IN' operator example [Column] IN { "Value1", "Value2"}
 Insert Rows into Push Dataset Table
Inserts rows into a Push Dataset Table    [Read more...]
Parameter Description
TableName
DatasetId
WorkspaceId
Option Value
Default
 Truncate a Push Dataset Table
Reads a Table of a Dataset.    [Read more...]
Parameter Description
TableName
DatasetId
WorkspaceId
Option Value
Default
 Execute a DAX query
Executes a DAX query on a Dataset in a default or specified Workspace.    [Read more...]
Parameter Description
DAX query Your DAX Query. Examples: EVALUATE FILTER('MyTable',true) --OR-- more complex EVALUATE FILTER(''MyTable'', [SomeNameColumn] = "ZZZ" && ([SomeIdColumn] = 10643 || [SomeIdColumn] = 10952 ) )
DatasetId
WorkspaceId
Option Value
Default
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Power BI Connector Examples for PowerShell Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Workspaces - Get Workspaces    [Read more...]

SELECT * 
FROM Workspaces

Workspaces - Get a Workspace    [Read more...]

SELECT * 
FROM Workspaces
WHERE Id='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'

Datasets - Get Datasets    [Read more...]

SELECT * 
FROM Datasets

Datasets - Get Datasets in a specified Workspace    [Read more...]

SELECT * 
FROM Datasets
WITH (WorkspaceId = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee')

Datasets - Get a Dataset    [Read more...]

SELECT * 
FROM Datasets
WHERE Id='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'

Datasets - Create a Push Dataset    [Read more...]

SELECT * 
FROM create_push_dataset
WITH (Definition='{
  "name": "My Push Dataset Name",
  "defaultMode": "Push",
  "tables": [
	{
      "name": "Products",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsComplete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        },        
        {
          "name": "Price",
          "dataType": "Double",
          "formatString": "Currency"
        }
      ]
    }
  ]
}'
)

-- More info on creating a Push Dataset:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-post-dataset

Datasets - Create a Push Dataset with 2 Tables    [Read more...]

SELECT * 
FROM create_push_dataset
WITH (Definition='{
  "name": "My Push Dataset Name",
  "defaultMode": "Push",
  "tables": [
     {
      "name": "Customers",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        }
      ]
    },
	{
      "name": "Products",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsComplete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        },        
        {
          "name": "Price",
          "dataType": "Double",
          "formatString": "Currency"
        }
      ]
    }
  ]
}'
)

-- More info on creating a Push Dataset:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-post-dataset

Datasets - Delete a Dataset    [Read more...]

SELECT *
FROM delete_dataset
WHERE Id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'

-- More info on deleting a Dataset:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/delete-dataset

Datasets - Refresh a Dataset    [Read more...]

SELECT *
FROM refresh_dataset
WHERE Id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
                
-- More info on refreshing a Dataset:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/refresh-dataset

Tables - Get Tables    [Read more...]

SELECT * 
FROM get_tables

Tables - Get Tables in a specified Dataset    [Read more...]

SELECT * 
FROM get_tables
WITH (DatasetId='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee')

Tables - Get Table Columns    [Read more...]

SELECT * 
FROM get_table_columns
WITH (TableName='MyTable')

Tables - Get Table Columns in a specified Dataset    [Read more...]

SELECT * 
FROM get_table_columns
WITH (TableName='MyTable',
      DatasetId='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee')

Tables - Get Table Rows (Use default Workspace and Dataset)    [Read more...]

SELECT * 
FROM MyTable

Tables - Get Table Rows for a specified Workspace and Dataset    [Read more...]

SELECT *
FROM get_table_rows
WITH(
	  "TableName"='Products'
	, "DatasetId"='11b6c287-51d3-4061-bed8-811a4e5f6ce9'
	, "WorkspaceId"='848353e2-f3b1-4fb4-89d7-44e84b8bdf9f'
)

Tables - Insert / Update / Delete Rows for a specified Workspace and Dataset    [Read more...]

INSERT INTO Products 
SOURCE(
  'MSSQL',
  'Data Source=localhost\developer;Initial Catalog=Northwind;Integrated Security=true',
  '  SELECT T.* FROM (       SELECT  TOP 50                
      ProductName AS [Name]              
      ,C.CategoryName AS Category              
      ,Discontinued AS IsComplete              
      ,GETDATE() AS ManufacturedOn              
      ,CAST(UnitPrice * ReOrderLevel * 100 AS BIGINT) AS Sales              
      ,CAST(UnitPrice AS DECIMAL) AS Price       
      FROM Northwind.dbo.Products AS P       
      JOIN Northwind.dbo.Categories C ON P.CategoryId = P.CategoryId       
      ) AS T              
      CROSS JOIN GENERATE_SERIES(1, 2000)             
      -- COMMENT:  50 x 2000 = 100 000 rows  
   '
) 
CONNECTION(
  Parameters = '[{ Name: "TokenUrl",Value:"https://login.microsoftonline.com/organizations/oauth2/v2.0/token"}                         
  ,{ Name: "DatasetId",Value: "6a0e04da-a6e4-4533-abe4-30fcabd0e2a5"},                      
  { Name: "WorkspaceId",Value: "848353e2-f3b1-4fb4-89d7-44e84b8bdf9f"}]'
)

Tables - Using an INSERT statement    [Read more...]

INSERT INTO MyTable(MyColumn1, MyColumn2, MyColumn3, MyColumn4, MyColumn5)
VALUES (1001, 'Glass', true, '2001-02-03', 195.95)

Tables - Using an INSERT statement in a specified Dataset    [Read more...]

INSERT INTO MyTable(MyColumn1, MyColumn2, MyColumn3, MyColumn4, MyColumn5)
VALUES (1001, 'Glass', true, '2001-02-03', 195.95)
WITH (DatasetId='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee')

Tables - Get Table rows    [Read more...]

SELECT * 
FROM get_table_rows 
WITH (TableName='MyTable')

Tables - Get Table rows in a specified Dataset    [Read more...]

SELECT * 
FROM get_table_rows 
WITH (TableName='MyTable', DatasetId='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee')

Tables - Truncate a Push Dataset Table    [Read more...]

SELECT *
FROM truncate_push_dataset_table
WITH (TableName='MyTable')
                
-- More info on truncating a Push Dataset Table:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-delete-rows

Tables - Truncate a Push Dataset Table in a specified Dataset    [Read more...]

SELECT *
FROM truncate_push_dataset_table
WITH (DatasetId='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee', TableName='MyTable')
                
-- More info on truncating a Push Dataset Table:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-delete-rows

Execute a DAX query - Evaluating a Table    [Read more...]

SELECT * 
FROM execute_dax_query
WITH (Query='EVALUATE ''MyTable''')

-- More info on 'EVALUATE' statement and DAX queries:
-- https://dax.guide/st/evaluate/
-- https://learn.microsoft.com/en-us/dax/dax-queries
-- https://learn.microsoft.com/en-us/dax/filter-functions-dax
-- https://learn.microsoft.com/en-us/dax/dax-syntax-reference

Execute a DAX query - Using FILTER function with simple expression    [Read more...]

SELECT * 
FROM execute_dax_query 
WITH (Query='EVALUATE FILTER(''MyTable'', [MyColumn] = "MyValue"')

-- More info on 'EVALUATE' statement and DAX queries:
-- https://dax.guide/st/evaluate/
-- https://dax.guide/filter/
-- https://dax.guide/operators/
-- https://learn.microsoft.com/en-us/dax/dax-queries
-- https://learn.microsoft.com/en-us/dax/dax-syntax-reference

Execute a DAX query - Using FILTER function with AND and OR operators    [Read more...]

SELECT * 
FROM execute_dax_query 
WITH (Query='EVALUATE FILTER(''MyTable'', [MyColumn1] = "MyValue" && ([MyColumn2] > 0 || [MyColumn3] <= 1000))')

-- More info on 'EVALUATE' statement and DAX queries:
-- https://dax.guide/operators/
-- https://learn.microsoft.com/en-us/dax/dax-queries
-- https://learn.microsoft.com/en-us/dax/dax-syntax-reference

Execute a DAX query - Selecting specific columns from a Table    [Read more...]

SELECT * 
FROM execute_dax_query
WITH (Query='EVALUATE 
             SELECTCOLUMNS (
                ''MyTable'',
                "MyColumn1 alias", [MyColumn1],
                "MyColumn2 alias", [MyColumn2]
             )
             ORDER BY "MyColumn2 alias"'
    )
    
-- More info on 'EVALUATE' statement and DAX queries:
-- https://dax.guide/st/evaluate/
-- https://dax.guide/selectcolumns/   
-- https://learn.microsoft.com/en-us/dax/dax-queries
-- https://learn.microsoft.com/en-us/dax/dax-syntax-reference

Execute a DAX query - Selecting and sorting TOP N rows    [Read more...]

SELECT * 
FROM execute_dax_query
WITH (Query='EVALUATE 
             TOPN(1000, ''MyTable'', [MyColumnOrExpression], ASC)')

-- More info on 'EVALUATE' statement and DAX queries:
-- https://dax.guide/st/evaluate/
-- https://dax.guide/topn/
-- https://learn.microsoft.com/en-us/dax/dax-queries
-- https://learn.microsoft.com/en-us/dax/dax-syntax-reference

Execute a DAX query - A complicated query    [Read more...]

SELECT * 
FROM execute_dax_query
WITH (Query='
DEFINE
    VAR MinimumAmount = 2000000
    VAR MaximumAmount = 8000000
EVALUATE
FILTER (
    ADDCOLUMNS (
        SUMMARIZE (Sales, Products[Category]),
        "CategoryAmount", [Sales Amount]
    ),
    AND (
        [CategoryAmount] <= MinimumAmount,
        [CategoryAmount] >= MaximumAmount
    )
)
ORDER BY [CategoryAmount]"')

-- More info on 'EVALUATE' statement and DAX queries:
-- https://dax.guide/st/evaluate/
-- https://dax.guide/addcolumns/
-- https://dax.guide/summarize/
-- https://dax.guide/st/order-by/
-- https://learn.microsoft.com/en-us/dax/dax-queries
-- https://learn.microsoft.com/en-us/dax/filter-functions-dax
-- https://learn.microsoft.com/en-us/dax/dax-syntax-reference

Generics - A simple generic API request    [Read more...]

SELECT * 
FROM generic_request
WITH (Url='/groups',
Filter='$.value[*]')


/*
EXPLANATION:
- This configuration calls Power BI REST API "Get Groups" endpoint and gets the Workspaces back.
- This is achieved by "/groups" value in the "Url" parameter.
- The SQL query parameter "Filter" uses JsonPath "$.value[*]".
- This gets JSON objects from "value" array and transforms them into SQL rows.

MORE INFORMATION:
- About "Get Groups" REST API endpoint:
  https://learn.microsoft.com/en-us/rest/api/power-bi/groups/get-groups
- About JsonPath used in "Filter" parameter:
  https://zappysys.com/blog/jsonpath-examples-expression-cheetsheet  
*/

Generics - A generic API request with URL parameter    [Read more...]

SELECT * 
FROM generic_request
WITH (Url='/groups?$filter=contains(name,''MyWorkspace'') or name eq ''My Blue Workspace''',
Filter='$.value[*]')


/*
EXPLANATION:
- This configuration calls Power BI REST API "Get Groups" endpoint and gets the Workspaces back.
- This is achieved by "/groups" value in the "Url" parameter.
- Workspaces are filtered on the Power BI REST API side by using the "$filter" URL parameter.
- Only those Workspaces are returned that:
  > contain a string value "MyWorkspace" or
  > if the Workspace name is "My Blue Workspace" (each single quote is escaped with two single quotes).
- The SQL query parameter "Filter" uses JsonPath "$.value[*]".
- This gets JSON objects from "value" array and transforms them into SQL rows.

MORE INFORMATION:
- About "Get Groups" REST API endpoint:
  https://learn.microsoft.com/en-us/rest/api/power-bi/groups/get-groups
- About JsonPath used in "Filter" parameter:
  https://zappysys.com/blog/jsonpath-examples-expression-cheetsheet  
*/

Conclusion

In this article we discussed how to connect to Power BI in PowerShell and integrate data without any coding. Click here to Download Power BI Connector for PowerShell and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Power BI Connector for PowerShell Documentation 

More integrations

Other application integration scenarios for Power BI

Other connectors for PowerShell


Download Power BI Connector for PowerShell Documentation

  • How to connect Power BI in PowerShell?

  • How to get Power BI data in PowerShell?

  • How to read Power BI data in PowerShell?

  • How to load Power BI data in PowerShell?

  • How to import Power BI data in PowerShell?

  • How to pull Power BI data in PowerShell?

  • How to push data to Power BI in PowerShell?

  • How to write data to Power BI in PowerShell?

  • How to POST data to Power BI in PowerShell?

  • Call Power BI API in PowerShell

  • Consume Power BI API in PowerShell

  • Power BI PowerShell Automate

  • Power BI PowerShell Integration

  • Integration Power BI in PowerShell

  • Consume real-time Power BI data in PowerShell

  • Consume real-time Power BI API data in PowerShell

  • Power BI ODBC Driver | ODBC Driver for Power BI | ODBC Power BI Driver | SSIS Power BI Source | SSIS Power BI Destination

  • Connect Power BI in PowerShell

  • Load Power BI in PowerShell

  • Load Power BI data in PowerShell

  • Read Power BI data in PowerShell

  • Power BI API Call in PowerShell