Azure DevOps Connector for Power BI

Read and write Azure DevOps (Cloud or On-Premises) data effortlessly. Integrate, manage, and automate work items, projects, and teams — almost no coding required.

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.

    User Credentials

    Azure DevOps authentication

    Delegated access using OAuth authorization code flow. Users sign in with their Azure AD account. [API reference]

    Follow these simple steps below to create Microsoft Entra ID application with delegated access:

    WARNING: To automate your company's processes, make sure you use a system/generic account (e.g. automation@my-company.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will start to fail.
    1. Navigate to the Azure Portal and log in using your credentials.
    2. Access Microsoft Entra ID.
    3. Register a new application by going to App registrations and clicking on New registration button: Start new app registration in Microsoft Entra ID
      INFO: Find more information on how to register an application in Graph API reference.
    4. When configuration window opens, configure these fields:
      • Supported account type
        • Use Accounts in this organizational directory only, if you need access to data in your organization only.
      • Redirect URI:
        • Set the type to Public client/native (mobile & desktop).
        • Use https://zappysys.com/oauth as the URL.
      Register app in Microsoft Entra ID
    5. After registering the app, copy the Application (client) ID for later: Copy client ID of Microsoft Entra ID app
    6. Then copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs to use later in the configuration: Copy Auth and Token URLs in Microsoft Entra ID app
    7. Now go to SSIS package or ODBC data source and use the copied values in User Credentials authentication configuration:
      • In the Authorization URL field paste the OAuth authorization endpoint (v2) URL value you copied in the previous step.
      • In the Token URL field paste the OAuth token endpoint (v2) URL value you copied in the previous step.
      • In the Client ID field paste the Application (client) ID value you copied in the previous step.
      • In the Scope field use the default value or select individual scopes, e.g.:
        • vso.project
        • vso.work_full
    8. Press Generate Token button to generate Access and Refresh Tokens.
    9. Optional step. Choose Default Drive Id from the drop down menu.
    10. Click Test Connection to confirm the connection is working.
    11. Done! Now you are ready to use the API Connector!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to User Credentials [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    AzureDevopsDSN
    Azure DevOps
    User Credentials [OAuth]
    https://dev.azure.com
    Required Parameters
    Authorization URL Fill-in the parameter...
    Token URL Fill-in the parameter...
    Client ID Fill-in the parameter...
    Organization name or Id (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
    Client Secret
    Refresh Token File Path
    Default Project Name (Choose after Generating Token)
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN OAuth Connection Configuration

    Azure App Credentials

    Azure DevOps authentication

    Use Azure AD service principal credentials (client id + secret) with the client credentials flow. Recommended for automated server-to-server access instead of PAT or delegated OAuth. [API reference]

    Step 1: Register the App in Microsoft Entra ID (AAD)

    1. Go to the Azure Portal > Microsoft Entra ID > App registrations and click New registration: Start new app registration in Microsoft Entra ID
    2. Name it (e.g., ZS-AzureDevOps-AppCred).
    3. Set Supported account types to "Accounts in this organizational directory only" (Single Tenant): Register app in Microsoft Entra ID
    4. Leave Redirect URI blank (it's not used for Client Credentials).
    5. Click Register.

    Step 2: Create a Client Secret

    1. In your new app, go to Certificates & secrets.
    2. Click New client secret, give it a name, and set an expiration.
    3. Copy the Secret Value immediately. You will never see it again once you leave the page: Copy client Secret of Microsoft Entra ID app

    Step 3: Set Permissions and Admin Consent

    1. Go to API permissions > Add a permission.
    2. Select Azure DevOps and click Delegated permissions.
    3. Check the necessary scopes (e.g., vso.project, vso.work_full).
    4. Crucial: Click Grant admin consent for [Your Tenant]. Without this, the app cannot authenticate in the background.

    Step 4: Map the App to Azure DevOps Organization

    1. Copy your Application (client) ID from the App Overview page.
    2. Go to your Azure DevOps Organization Settings > Users.
    3. Click Add users, paste the Application (client) ID in the search box, and select the App.
    4. Assign an Access level (usually Basic) and add it to the relevant Projects.

    Step 5: Connection Settings

    In your SSIS package or ODBC data source, use the following in the App Credentials configuration:

    • In the Token URL field, paste the OAuth token endpoint (v2) URL from the Azure Portal 'Endpoints' tab.
    • In the Client ID field, paste the Application (client) ID.
    • In the Client Secret field, paste the Secret Value copied in Step 2.
    • In the Scope field, use: https://app.vssps.visualstudio.com/.default

    Step 6: Finalize Connection

    1. Press Generate Token button to fetch the token using the Client Secret.
    2. Click Test Connection to confirm the setup.
    3. Done! You are ready to use the API Connector!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Azure App Credentials [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    AzureDevopsDSN
    Azure DevOps
    Azure App Credentials [OAuth]
    https://dev.azure.com
    Required Parameters
    Token URL Fill-in the parameter...
    Client ID Fill-in the parameter...
    Client Secret Fill-in the parameter...
    Scopes (Use .default for App Credentials) Fill-in the parameter...
    Organization name or Id Fill-in the parameter...
    API Version Fill-in the parameter...
    Optional Parameters
    Default Project Name
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN OAuth Connection Configuration

    Azure App Credentials with Certificate (Sign JWT with Private Key)

    Azure DevOps authentication

    Same as Application Credentials but uses a client certificate instead of a secret. [API reference]

    Step 1: Register the App in Microsoft Entra ID (AAD)

    1. Go to the Azure Portal > Microsoft Entra ID > App registrations and click New registration: Start new app registration in Microsoft Entra ID
    2. Name it (e.g., ZS-AzureDevOps-CertAuth).
    3. Set Supported account types to "Accounts in this organizational directory only" (Single Tenant): Register app in Microsoft Entra ID
    4. Leave Redirect URI blank (it's not used for Client Credentials flows).
    5. Click Register.

    Step 2: Upload Client Certificate

    1. In your new app, go to Certificates & secrets.
    2. Click the Certificates tab, then click Upload certificate.
    3. Upload your public key certificate (.cer, .pem, or .crt). Keep the private key secure on your system.
    4. Copy the Thumbprint for your configuration: Copy certificate thumbprint

    Step 3: Set Permissions and Admin Consent

    1. Go to API permissions > Add a permission.
    2. Select Azure DevOps and click Delegated permissions.
    3. Select the required scopes (e.g., vso.project, vso.work_full).
    4. Crucial: Click Grant admin consent for [Your Tenant]. Without this, the background service cannot acquire a token.

    Step 4: Map the App to Azure DevOps Organization

    1. Copy your Application (client) ID from the App Overview page.
    2. Go to your Azure DevOps Organization Settings > Users.
    3. Click Add users and paste the Application (client) ID in the search box to find the App.
    4. Assign an Access level (usually Basic) and add it to the relevant Projects.

    Step 5: Connection Settings

    In your SSIS package or ODBC data source, use the following in the Client Certificate configuration:

    • In the Token URL field, paste the OAuth token endpoint (v2) URL from the Azure Portal 'Endpoints' tab.
    • In the Client ID field, paste the Application (client) ID.
    • Configure your Certificate Path or Thumbprint in the Client Certificate tab of the connector.
    • In the Scope field, use: https://app.vssps.visualstudio.com/.default

    Step 6: Finalize Connection

    1. Press Generate Token. The connector will sign the request using your certificate to fetch a token.
    2. Click Test Connection to confirm the setup.
    3. Done! Your certificate-based connection is ready!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Azure App Credentials with Certificate (Sign JWT with Private Key) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    AzureDevopsDSN
    Azure DevOps
    Azure App Credentials with Certificate (Sign JWT with Private Key) [OAuth]
    https://dev.azure.com
    Required Parameters
    Token URL Fill-in the parameter...
    Client ID Fill-in the parameter...
    Certificate: *** Configure [Client Certificate] Tab *** Fill-in the parameter...
    Scopes (Must match with App Registration) Fill-in the parameter...
    Organization name or Id Fill-in the parameter...
    API Version Fill-in the parameter...
    Optional Parameters
    Default Project Name
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN OAuth Connection Configuration

    (Cloud) OAuth App - User Credentials (DEPRECATED)

    Azure DevOps authentication
    **DEPRECATED:** this OAuth-based user credential flow is legacy; for new integrations prefer the Azure App Credentials options below. 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.
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to (Cloud) OAuth App - User Credentials (DEPRECATED) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    AzureDevopsDSN
    Azure DevOps
    (Cloud) OAuth App - User Credentials (DEPRECATED) [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 (e.g. mycompany) Fill-in the parameter...
    Return URL Fill-in the parameter...
    Scopes (Use .default for App Credentials) 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

    (Cloud) Personal Access Token (PAT) (DEPRECATED)

    Azure DevOps authentication
    **DEPRECATED:** Personal Access Tokens are still supported but the new Azure App Credentials auth is recommended for security and automation. To connect to Azure DevOps using a Personal Access Token (PAT), you must first create a valid PAT:
    1. Start 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!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to (Cloud) Personal Access Token (PAT) (DEPRECATED) [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    AzureDevopsDSN
    Azure DevOps
    (Cloud) Personal Access Token (PAT) (DEPRECATED) [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
    Default Project Name
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

    (On-Premises) Personal Access Token (PAT) (DEPRECATED)

    Azure DevOps authentication
    **DEPRECATED:** On-premises PAT method is legacy; consider Azure App Credentials if your server supports Azure AD apps. To connect to Azure DevOps On-Premises Server using a Personal Access Token (PAT), you must first create a valid PAT:
    1. Start by navigating to your on-premises Azure DevOps Server URL.
      NOTE: The screenshots shown below are from the cloud version, so your interface may look slightly different depending on which on-premises Azure DevOps Server version you’re using — however, the overall concepts and steps are very similar between the cloud and on-premises editions.
    2. Now open any project and capture Collection Name from the URL. For example if your URL is 
      https://tfs.mycompany.local/tfs/MyCollection/MyProject/
      then your collection name is MyCollection usually after /tfs/. Copy this collection name and later we will enter on Connection UI.
    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!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to (On-Premises) Personal Access Token (PAT) (DEPRECATED) [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    AzureDevopsDSN
    Azure DevOps
    (On-Premises) Personal Access Token (PAT) (DEPRECATED) [Http]
    https://dev.azure.com
    Required Parameters
    Personal Access Token (PAT) Fill-in the parameter...
    Collection name (e.g. MyCollection) Fill-in the parameter...
    API Version Fill-in the parameter...
    Optional Parameters
    AuthScheme Bearer
    AuthHeader Authorization
    Default Project Name
    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
    Read and write Azure DevOps (Cloud or On-Premises) data effortlessly. Integrate, manage, and automate work items, projects, and teams — almost no coding required.
    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 WorkItems
    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
    Read and write Azure DevOps (Cloud or On-Premises) data effortlessly. Integrate, manage, and automate work items, projects, and teams — almost no coding required.
    AzureDevopsDSN
    SELECT * FROM WorkItems
    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 WorkItems
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
    Read and write Azure DevOps (Cloud or On-Premises) data effortlessly. Integrate, manage, and automate work items, projects, and teams — almost no coding required.
    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=Custom;OAuthVersion=OAuth2;ScopeSeparator={space};GrantType=Default;Scope=[$Scope$];ScopeSeparator={space};
    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 WorkItems')
    SELECT * FROM OPENQUERY([LS_TO_AZURE_DEVOPS_IN_GATEWAY], 'SELECT * FROM WorkItems')
    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 data 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. You can download On-premises data gateway straight from Microsoft Data Fabric or Power BI web app:

Download Power BI On-premises data gateway

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 your 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. Once Microsoft gateway is installed, check if it registered correctly:

    • Go back to Power BI portal

    • Click Gear icon on top-right

    • And then hit Manage connections and gateways menu item

    Manage On-premise data gateways in Microsoft Fabric or Power BI

  7. Continue by clicking On-premises data gateway tab and select Standard mode gateways option from the dropdown:

    Access On-premises data gateway list (Standard mode) in Power BI

    If your gateway is not listed, the registration may have failed. To resolve this:

    • Wait a couple of minutes and refresh Power BI portal page
    • Restart the machine where On-premises data gateway is installed
    • Check firewall settings

  8. 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

  9. 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.

  10. Proceed by choosing the newly created connection:

    ODBC{"connectionstring":"dsn=AzureDevopsDSN"}
    Selecting gateway connection in Power BI semantic model

  11. 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 your account.

  4. Once Microsoft gateway is installed, check if it registered correctly:

    • Go back to Power BI portal

    • Click Gear icon on top-right

    • And then hit Manage connections and gateways menu item

    Manage On-premise data gateways in Microsoft Fabric or Power BI

  5. Continue by clicking On-premises data gateway tab and select Personal mode option from the dropdown:

    Access On-premises data gateway list (Personal mode) in Power BI

    If your gateway is not listed, the registration may have failed. To resolve this:

    • Wait a couple of minutes and refresh Power BI portal page
    • Restart the machine where On-premises data gateway is installed
    • Check firewall settings

  6. 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

  7. Finally, you are ready to refresh your semantic model:

    Refreshing Power BI semantic model using On-premises Data Gateway

Centralized data access via Data Gateway

In some situations, you may need to provide Azure DevOps data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

  • Centralized data access
    The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
  • Centralized access control
    Since all connections route through the gateway, access can be governed or revoked from a single location for all users.
Data Gateway
Local ODBC
data source
Simple configuration
Installation Single machine Per machine
Connectivity Local and remote Local only
Connections limit Limited by License Unlimited
Central data access
Central access control
More flexible cost

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Azure DevOps, and to create an ODBC data source to connect to Data Gateway in Power BI.

Let's not wait and get going!

Creating Azure DevOps data source in Gateway

In this section we will create a data source for Azure DevOps in Data Gateway. Let's follow these steps to accomplish that:

  1. Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:

    Opening Data Gateway

  2. Go to Users tab and follow these steps to add a Data Gateway user:

    • Click Add button
    • In Login field enter username, e.g., john
    • Then enter a Password
    • Check Is Administrator checkbox
    • Click OK to save
    Data Gateway - Adding User

  3. Now we are ready to add a data source:

    • Click Add button
    • Give Datasource a name (have it handy for later)
    • Then select Native - ZappySys API Driver
    • Finally, click OK
    AzureDevopsDSN
    ZappySys API Driver
    Data Gateway - Adding data source

  4. When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.

  5. Very important step. Now, after creating or modifying the data source make sure you:

    • Click the Save button to persist your changes.
    • Hit Yes, once asked if you want to restart the Data Gateway service.

    This will ensure all changes are properly applied:

    ZappySys Data Gateway - Save Changes
    Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from Power BI. To achieve that, let's perform these steps:

  1. Open ODBC Data Sources (x64):

    Open ODBC Data Source

  2. Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

    ODBC Driver 17 for SQL Server
    Create new User DSN for ODBC Driver 17 for SQL Server
    If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.

  3. Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

    GatewayDSN
    localhost,5000
    ODBC driver for SQL Server - Setting hostname and port
    Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

  4. Proceed with authentication part:

    • Select SQL Server authentication
    • In Login ID field enter the user name you used in Data Gateway, e.g., john
    • Set Password to the one you configured in Data Gateway
    ODBC driver for SQL Server - Selecting SQL Authentication

  5. Then set the default database property to AzureDevopsDSN (the one we used in Data Gateway):

    AzureDevopsDSN
    ODBC driver for SQL Server - Selecting database

  6. Continue by checking Trust server certificate option:

    ODBC driver for SQL Server - Trusting certificate

  7. Once you do that, test the connection:

    ODBC driver for SQL Server - Testing connection

  8. If connection is successful, everything is good:

    ODBC driver for SQL Server - Testing connection succeeded

  9. Done!

We are ready to move to the final step. Let's do it!

Accessing data in Power BI via Data Gateway

Finally, we are ready to read data from Azure DevOps in Power BI via Data Gateway. Follow these final steps:

  1. Go back to Power BI.

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

    Power Bi Get Data

  3. A window opens, and then search for "odbc" to get data from ODBC data source:

    Power Bi ODBC Get Data

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

    GatewayDSN
    Power Bi Select ZappySys Driver DSN

  5. Read the data the same way we discussed at the beginning of this article.

  6. That's it!

Now you can connect to Azure DevOps data in Power BI via the Data Gateway.

If you are asked for authentication details, use Database authentication or SQL Authentication option and enter credentials you used when configuring Data Gateway, e.g. john and your password.

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.

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
Download Azure DevOps Connector for Power BI Documentation