Azure DevOps Connector for Power BI

Azure DevOps Connector can be used to integrate Azure DevOps data in your App / BI Tools. You can create, read, query, modify, and delete WorkItems, Projects, Teams and more.

In this article you will learn how to quickly and efficiently integrate Azure DevOps data in Power BI without coding. We will use high-performance Azure DevOps Connector to easily connect to Azure DevOps and then access the data inside Power BI.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Video Tutorial - Integrate Azure DevOps data in Power BI

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Azure DevOps integration in Power BI
  • How to configure the connection for Azure DevOps
  • Features of the ZappySys API Driver (Authentication / Query Language / Examples / Driver UI)
  • How to use the Azure DevOps in Power BI

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

Step-by-step instructions

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

  1. Download and install 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
    • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
    • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
    Power BI uses a Service Account, when a solution is deployed to production environment, therefore for production environment you have to create and use a System DSN.
  4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Azure DevOps" from the list of Popular Connectors. If "Azure DevOps" 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:

    AzureDevopsDSN
    Azure DevOps
    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.

    Steps how to get and use Azure DevOps credentials
    Connecting to your Azure DevOps data requires you to authenticate your REST API access. Follow the instructions below:
    1. Go to https://app.vsaex.visualstudio.com/app/register to register your app.
    2. Fill in your application and company's information as required, and then select the scopes that your application needs. This should typically be Project and team (read and write) and Work items (read and write).
      Your selected scopes when registering your app must match the scopes you enter here on the connector screen. If they don't match, the connector will not be able to work with your Azure DevOps account!
      If you need further information about the scopes used in Azure DevOps, or need to see what to enter into the connector screen to match up with your selected scopes, visit https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops.
      Create OAuth application in Azure DevOps

      NOTE: For Authorization callback URL use your company's OAuth Redirect URL (if IT administrator provides you one) or you can use https://zappysys.com/oauth (it's safe).

    3. Select Create Application and then the Application Settings page will be displayed.
    4. Record the App ID for us to use later: Copy App ID in Azure DevOps
    5. And do the same with Client Secret: Use Client Secret to read Azure DevOps REST API data
    6. Then go to https://aex.dev.azure.com and select relevant organization on the left.
    7. Then copy Organization's host name part (e.g. acmeinc, if full host name is acmeinc.visualstudio.com), save it to a file, and click it: Copy Organization Host in Azure DevOps
    8. Back at the connector screen, enter the App ID into the Client Id (App ID) field that was recorded in the previous step.
    9. Enter the Client Secret that was recorded in the previous step into the Client Secret field. In order to edit the text in this field, select the ellipses (...) button that appears when the textbox is clicked, and edit the Client Secret with the dialog box that appears.
    10. Enter the organization that was recorded in step 5 into the Organization name or Id for url field.
    11. Click Generate Token. If proper authentication occurs, you will see a notice saying so. You can click Yes to save a backup file of your generated tokens.
    12. Select the project you want to connect to by default from the Default Project (Choose after Generating Token) field.
    13. Select the Security tab.
    14. Enter https://auditservice.dev.azure.com,https://almsearch.dev.azure.com into the Additional Trusted Domains field.
    15. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account.
    16. If the connection test succeeds, select OK.
    17. To edit previously created app you can visit https://app.vsaex.visualstudio.com/me and see Applications and services section. Click on your desired app name.

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

    AzureDevopsDSN
    Azure DevOps
    OAuth [OAuth]
    https://dev.azure.com
    Required Parameters
    Client Id (App ID) Fill-in the parameter...
    Client Secret Fill-in the parameter...
    Organization name or Id for url (e.g. mycompany) Fill-in the parameter...
    Return URL Fill-in the parameter...
    Scopes (Must match with App Registration) Fill-in the parameter...
    API Version Fill-in the parameter...
    Optional Parameters
    Default Project Name (Choose after Generating Token)
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN Oauth Connection Configuration
    Steps how to get and use Azure DevOps credentials
    To connect to Azure DevOps using a Personal Access Token (PAT), you must first create a valid PAT:
    1. Start by by going to https://aex.dev.azure.com and selecting relevant organization on the left.
    2. Then copy Organization's host name part (e.g. acmeinc, if full host name is acmeinc.visualstudio.com), save it to a file, and click it: Copy Organization Host in Azure DevOps
    3. Next, click User settings icon and then click Personal access tokens: Click User Settings icon in Azure DevOps
    4. Then click New Token button to create a new personal access token: Create new token in Azure DevOps
    5. Continue by...
      • naming your token
      • selecting the right Organization
      • setting token's Expiration date (it's recommended to use Custom defined option and make it expire after one year or later)
      • and setting the Scopes:
      Finish creating token in Azure DevOps

      NOTE: You may be restricted from creating full-scoped PATs. If so, your Azure DevOps administrator in Azure AD has enabled a policy which limits you to a specific custom defined set of scopes.

    6. Now click Copy button and save the newly created token into a file for quick access later: Use Azure DevOps token to read REST API data
    7. Go back to the connector screen, input the token you saved in a previous step into the Personal Access Token (PAT) field.
    8. Then enter the Organization host name part that you noted recorded in previous step into Organization name or Id for url field.
    9. Enter the name or Id of the project you want to connect to by default in the Default Project (Choose after above fields) field.
    10. Select the Security tab.
    11. Enter https://auditservice.dev.azure.com,https://almsearch.dev.azure.com,https://analytics.dev.azure.com into the Additional Trusted Domains field.
    12. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account.
    13. Done!

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

    AzureDevopsDSN
    Azure DevOps
    Personal Access Token (PAT) [Http]
    https://dev.azure.com
    Required Parameters
    Personal Access Token (PAT) Fill-in the parameter...
    Organization name or Id for url Fill-in the parameter...
    API Version Fill-in the parameter...
    Optional Parameters
    AuthScheme Bearer
    AuthHeader Authorization
    UserName
    Default Project Name (Choose after Generating Token)
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

  6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

    ZappySys API Driver - Azure DevOps
    Azure DevOps Connector can be used to integrate Azure DevOps data in your App / BI Tools. You can create, read, query, modify, and delete WorkItems, Projects, Teams and more.
    AzureDevopsDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Power BI to retrieve data from Azure DevOps. Hit OK button to use this query in the next step.

    SELECT * FROM Projects
    Configure table/endpoint parameters in ODBC data source based on API Driver
    Some parameters configured in this window will be passed to the Azure DevOps API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.
  8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Power BI:

    ZappySys API Driver - Azure DevOps
    Azure DevOps Connector can be used to integrate Azure DevOps data in your App / BI Tools. You can create, read, query, modify, and delete WorkItems, Projects, Teams and more.
    AzureDevopsDSN
    SELECT * FROM Projects
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Azure DevOps API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Azure DevOps servers).
  9. Click OK to finish creating the data source.

Video Tutorial

Read Azure DevOps data in Power BI using ODBC

Importing Azure DevOps data into Power BI from table or view

  1. Once you open Power BI Desktop click Get Data to get data from ODBC:
    Power Bi Get Data

  2. A window opens, and then search for "odbc" to get data from ODBC data source:
    Power Bi ODBC Get Data

  3. Another window opens and asks to select a Data Source we already created. Choose AzureDevopsDSN and continue:

    AzureDevopsDSN
    Power Bi Select ZappySys Driver DSN

  4. Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:

    AzureDevopsDSN
    Power Bi DSN Authentication

  5. Finally, you will be asked to select a table or view to get data from. Select one and load the data!
    Power Bi Load DSN Table Data

  6. Finally, finally, use extracted data from Azure DevOps in a Power BI report:
    Power Bi Extracted DSN Table Data

Importing Azure DevOps data into Power BI using SQL query

If you wish to import Azure DevOps data from SQL query rather than a table then you can use advanced options during import steps (as below). After selecting DSN you can click on advanced options to see SQL Query editor.

AzureDevopsDSN
SELECT * FROM Projects
Get REST API data in Power BI Desktop using SQL query and ODBC
Consider using Custom Objects feature in ODBC data source to encapsulate SQL query in a Virtual Table. This way, you can see a virtual table in Power BI table list where you can import multiple objects using the same connection rather than creating a new connection for each custom SQL query.

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 - Configuration [Version: 2.0.1.10418]
    ZappySys API Driver - Azure DevOps
    Azure DevOps Connector can be used to integrate Azure DevOps data in your App / BI Tools. You can create, read, query, modify, and delete WorkItems, Projects, Teams and more.
    AzureDevopsDSN
    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:
    AzureDevopsDSN
    DRIVER={ZappySys API Driver};ServiceUrl=https://dev.azure.com;Provider=Vsts;ScopeSeparator={space};ReturnUrl=[$ReturnUrl$];Scope=[$Scope$];
    Use full connection string in Power BI Desktop to read API data
  4. You are good to go! The script will execute the same way as using a DSN.
The DSN defined in the Data source name (DSN) field will be ignored.

Have in mind that 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 (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

  1. Open your ODBC data source.
  2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
  3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
  4. Continue by pasting the copied connection string into a newly created file and save it.
  5. Finally, the last step! Just construct a shorter ODBC connection string using this format:
    DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
  6. Our troubles are over! Now you should be able to use this connection string in Power BI with no problems.
This feature requires ODBC PowerPack v1.9.0 or later.

Editing query for table in Power BI

There will be a time you need to change the initial query after importing data into Power BI. Don't worry, just right-click on your table and click Edit query menu item:

Edit query in Power BI to get REST API data
Refer to Power Query M reference for more information on how to use its advanced features in your queries.

Using parameters in Power BI (dynamic query)

In the real world, many values of your REST / SOAP API call may be coming from parameters. If that's the case for you can try to edit script manually as below. In below example its calling SQL Query with POST method and passing some parameters. Notice below where paraAPIKey is Power BI Parameter (string type). You can use parameters anywhere in your script just like the normal variable.

To use a parameter in Power BI report, follow these simple steps:

  1. Firstly, you need to Edit query of your table (see previous section)

  2. Then just create a new parameter by clicking Manage Parameters dropdown, click New Parameter option, and use it in the query:

    						
                                = Odbc.Query("dsn=AzureDevopsDSN",
                                             "SELECT ProductID, ProductName, UnitPrice, UnitsInStock
                                              FROM Products
                                              WHERE UnitPrice > " & Text.From(MyParameter) & "
                                              ORDER BY UnitPrice")
                            
                    
    Use parameter in Power BI to get REST API data
    Refer to Power Query M reference for more information on how to use its advanced features in your queries.

Using DirectQuery Option rather than Import

So far we have seen how to Import Azure DevOps data into Power BI, but what if you have too much data and you don't want to import but link it. Power BI Offers very useful feature for this scenario. It's called DirectQuery Option. In this section we will explore how to use DirectQuery along with ZappySys Drivers.

Out of the box ZappySys Drivers won't work in ODBC Connection Mode, so you have to use SQL Server Connection rather than ODBC if you wish to use Live data using DirectQuery option. See below step-by-step instructions to enable DirectQuery mode in Power BI for Azure DevOps data.

Basically we will use ZappySys Data Gateway its part of ODBC PowerPack. We will then use Linked Server in SQL Server to Link API Service, then issue OPENROWSET queries from Power BI to SQL Server, and it will then call Azure DevOps via ZappySys Data Gateway.

  1. First, create a data source in ZappySys Data Gateway and create a Linked Server based on it.
  2. Once SQL Server Linked Server is configured we are ready to issue a SQL query in Power BI.
  3. Click Get Data in Power BI, select SQL Server Database
  4. Enter your server name and any database name
  5. Select Mode as DirectQuery
  6. Click on Advanced and enter query like below (we are assuming you have created Azure DevOps Data Source in Data Gateway and defined linked server - change the name below).
    SELECT * FROM OPENQUERY([LS_TO_AZURE_DEVOPS_IN_GATEWAY], 'SELECT * FROM Projects')
    SELECT * FROM OPENQUERY([LS_TO_AZURE_DEVOPS_IN_GATEWAY], 'SELECT * FROM Projects')
    DirectQuery option for Power BI (Read Azure DevOps Data Example using SQL Server Linked Server and ZappySys Data Gateway)


    DirectQuery option for Power BI (Read Azure DevOps Data Example using SQL Server Linked Server and ZappySys Data Gateway)

  7. Click OK and Load data... That's it. Now your Azure DevOps API data is linked rather than imported.

Publishing Power BI report to Power BI service

Here are the instructions on how to publish a Power BI report to Power BI service from Power BI Desktop application:

  1. First of all, go to Power BI Desktop, open a Power BI report, and click Publish button:

    Publish Power BI report to Power BI service
  2. Then select the Workspace you want to publish report to and hit Select button:

    Publish Power BI report to workspace
  3. Finally, if everything went right, you will see a window indicating success:

    Successful Power BI report publishing

    If you need to periodically refresh Power BI semantic model (dataset) to ensure data accuracy and up-to-dateness, you can accomplish that by using Microsoft On-premises data gateway. Proceed to the next section - Refreshing Power BI semantic model (dataset) using On-premises data gateway - and learn how to do that.

Refreshing Power BI semantic model (dataset) using On-premises data gateway

Power BI allows to refresh semantic models which are based on data sources that reside on-premises. This can be achieved using Microsoft On-premises data gateway. There are two types of On-premises gateways:

  • Standard Mode
  • Personal Mode

Standard Mode supports Power BI and other Microsoft Data Fabric services. It fits perfectly for Enterprise solutions as it installs as a Windows Service and also supports Direct Query feature.

Personal Mode, on the other hand, can be configured faster, but is designed more for home users (you cannot install it as a Windows Service and it does not support DirectQuery). You will find a detailed comparison in the link above.

We recommend to go with Personal Mode for a quick POC solution, but use Standard Mode in production environment.

Below you will find instructions on how to refresh semantic model using both types of gateways.

Refresh using On-premises data gateway (standard mode)

Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (standard mode):

  1. Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:

    Configure Power BI semantic model settings
  2. If you see this view, it means you have to install On-premises data gateway (standard mode):

    On-premises data gateway is not installed
  3. Install On-premises data gateway (standard mode) and sign-in:

    signing in into on-premises data gateway standard
    Use the same email address you use when logging in into Power BI account.
  4. Register a new gateway (or migrate an existing one):

    registering or migrating on-premises data gateway standard
  5. If you are creating a new gateway, name your gateway, enter a Recovery key, and click Configure button:

    naming on-premises data gateway standard
  6. Now, let's get back to your semantic model settings in Power BI portal. Refresh the page and you should see your newly created gateway. Click arrow icon and then click on Add to gateway link:

    ODBC{"connectionstring":"dsn=AzureDevopsDSN"}
    Using On-premises Data Gateway Standard for Power BI Semantic Model
  7. Once you do that, you will create a new gateway connection. Give it a name, set Authentication method, Privacy level, and click Create button:

    dsn=AzureDevopsDSN
    Create new connection in Power BI On-premises data gateway
    In this example, we used the least restrictive Privacy level.

    If your connection uses a full connection string you may hit a length limitation when entering it into the field. To create the connection, you will need to shorten it manually. Check the section about the limitation of a full connection string on how to accomplish it.

    On-premises data gateway (personal mode) does not have this limitation.

  8. Proceed by choosing the newly created connection:

    ODBC{"connectionstring":"dsn=AzureDevopsDSN"}
    Selecting gateway connection in Power BI semantic model
  9. Finally, you are at the final step where you can refresh the semantic model:

    Refreshing Power BI semantic model using On-premises Data Gateway

Refresh using On-premises data gateway (personal mode)

Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (personal mode):

  1. Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:

    Configure Power BI semantic model settings
  2. If you see this view, it means you have to install On-premises data gateway (personal mode):

    On-premises data gateway is not installed
  3. Install On-premises data gateway (personal mode) and sign-in:

    Sign-in to On-premises data gateway personal
    Use the same email address you use when logging in into Power BI account.
  4. Again, go to your semantic model Settings, expand Data source credentials, click Edit credentials, select Authentication method together with Privacy level, and then click Sign in button:

    dsn=AzureDevopsDSN
    Use On-premises data gateway personal for Power BI semantic model
  5. Finally, you are ready to refresh your semantic model:

    Refreshing Power BI semantic model using On-premises Data Gateway

Actions supported by Azure DevOps Connector

Learn how to perform common Azure DevOps actions directly in Power BI with these how-to guides:

Conclusion

In this article we showed you how to connect to Azure DevOps in Power BI and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Azure DevOps, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download Azure DevOps Connector for Power BI and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Azure DevOps Connector for Power BI Documentation

More integrations

Other connectors for Power BI

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Azure DevOps

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications

  • How to connect Azure DevOps in Power BI?

  • How to get Azure DevOps data in Power BI?

  • How to read Azure DevOps data in Power BI?

  • How to load Azure DevOps data in Power BI?

  • How to import Azure DevOps data in Power BI?

  • How to pull Azure DevOps data in Power BI?

  • How to push data to Azure DevOps in Power BI?

  • How to write data to Azure DevOps in Power BI?

  • How to POST data to Azure DevOps in Power BI?

  • Call Azure DevOps API in Power BI

  • Consume Azure DevOps API in Power BI

  • Azure DevOps Power BI Automate

  • Azure DevOps Power BI Integration

  • Integration Azure DevOps in Power BI

  • Consume real-time Azure DevOps data in Power BI

  • Consume real-time Azure DevOps API data in Power BI

  • Azure DevOps ODBC Driver | ODBC Driver for Azure DevOps | ODBC Azure DevOps Driver | SSIS Azure DevOps Source | SSIS Azure DevOps Destination

  • Connect Azure DevOps in Power BI

  • Load Azure DevOps in Power BI

  • Load Azure DevOps data in Power BI

  • Read Azure DevOps data in Power BI

  • Azure DevOps API Call in Power BI