Write data to Azure DevOps using SSIS (Import data)

In this section we will learn how to configure and use Azure DevOps Connector in the API Destination to write data to Azure DevOps.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

• How to download SSIS PowerPack for Azure DevOps integration in SSIS
• How to configure connection for Azure DevOps
• How to write or lookup data to Azure DevOps
• Features about SSIS API Destination
• Using Azure DevOps Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Azure DevOps in the API Source to POST data to the Azure DevOps.

1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
   

3. Select New Connection to create a new connection:
   

   API Destination - 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.

   

4. Use a preinstalled Azure DevOps Connector from Popular Connector List or press Search Online radio button to download Azure DevOps Connector. Once downloaded simply use it in the configuration:
   

   Azure DevOps

   

5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    OAuth [OAuth]

   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.
      

      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:
   5. And do the same with Client Secret:
   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:
   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

   

    Personal Access Token (PAT) [Http]

   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:
   3. Next, click User settings icon and then click Personal access tokens:
   4. Then click New Token button to create a new personal access token:
   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:
      

      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:
   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

   

6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

   API Destination - 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.

   

7. Finally, map the desired columns:

   API Destination - 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.

   

8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Azure DevOps API call using ZappySys Azure DevOps Connector