Azure DevOps Connector for Azure Data Factory (Pipeline)

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 Azure Data Factory (Pipeline) without coding. We will use high-performance Azure DevOps Connector to easily connect to Azure DevOps and then access the data inside Azure Data Factory (Pipeline).

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

Download Documentation

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

Step-by-step instructions

To get data from Azure DevOps using Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline). 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.
    Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline):

    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 data in Azure Data Factory (ADF) from ODBC datasource (Azure DevOps)

  1. Sign in to Azure Portal

    • Open your browser and go to: https://portal.azure.com

    • Enter your Azure credentials and complete MFA if required.

    • After login, go to Data factories.

    Azure Portal

  2. Under Azure Data Factory Resource - Create or select the Data Factory you want to work with.

    Select the Data Factory

  3. Inside the Data Factory resource page, click Launch studio.

    Launch Azure Data Factory Studio

  4. Create a New Integration Runtime (Self-Hosted):

    • In Azure Data Factory Studio, go to the Manage section (left menu).

    • Under Connections, select Integration runtimes.

    • Click + New to create a new integration runtime.

    Create new Self-Hosted integration runtime

  5. Select Azure, Self-Hosted option:

    Create new Self-Hosted integration runtime

  6. Select Self-Hosted option:

    Create new Self-Hosted integration runtime

  7. Set a name, we will use OnPremisesRuntime:

    Set a name for IR

  8. Download and install Microsoft Integration Runtime.

    Download and install Microsoft Integration Runtime

  9. Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:

    Copy/paste Authentication Key

  10. After finishing registering the Integration Runtime node, you should see a similar view:

    Check Integration Runtime node status

  11. Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:

    Integration Runtime status

  12. Create a New Linked service:

    • In the Manage section (left menu).

    • Under Connections, select Linked services.

    • Click + New to create a new Linked service based on ODBC.

    Add new Linked service

  13. Select ODBC service:

    Add new ODBC service

  14. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    AzureDevopsDSN
    DSN=AzureDevopsDSN
    Configure new ODBC service

  15. For created ODBC service create ODBC-based dataset:

    Add new ODBC dataset

  16. Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:

    Set source in Copy data

  17. Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:

    Set sink in Copy data

  18. Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:

    Run the flow

Executing SQL queries using Lookup activity

If you need to execute commands in Azure DevOps instead of retrieving data, use the Lookup activity for that purpose. Use this approach when you want data to be changed on the Azure DevOps side, but you don't need the data on your side (a "fire-and-forget" scenario).

Perform these simple steps to accomplish that:

  1. Go to your pipeline in Azure Data Factory

  2. Find Lookup activity in the Activities pane

  3. Then drag-and-drop the Lookup activity onto your pipeline canvas

  4. Click Settings tab

  5. Select OdbcDataset in the Source dataset field

  6. Finally, enter your SQL query in the Query text box:

SELECT * FROM get_query_fields WITH ( "Project" = 'abcd-1234-project', "Query" = 'SELECT * FROM WorkItems Order By [System.Id] DESC' )
Configuring Lookup activity in ADF pipeline to perform a command in Azure DevOps

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 Azure Data Factory (Pipeline).

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 Azure Data Factory (Pipeline). 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 Azure Data Factory (Pipeline) via Data Gateway

Finally, we are ready to read data from Azure DevOps in Azure Data Factory (Pipeline) via Data Gateway. Follow these final steps:

  1. Go back to Azure Data Factory (Pipeline).

  2. Create a New Linked service:

    • In the Manage section (left menu).

    • Under Connections, select Linked services.

    • Click + New to create a new Linked service based on ODBC.

    Add new Linked service

  3. Select ODBC service:

    Add new ODBC service

  4. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    GatewayDSN
    DSN=GatewayDSN
    Configure new ODBC service

  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 Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) with these how-to guides:

Conclusion

In this article we showed you how to connect to Azure DevOps in Azure Data Factory (Pipeline) and integrate data without any coding, saving you time and effort.

We encourage you to download Azure DevOps Connector for Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) Documentation

More integrations

Other connectors for Azure Data Factory (Pipeline)

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 Azure Data Factory (Pipeline) Documentation