Azure DevOps Connector
Documentation
Version: 2
Documentation

Write data in Azure DevOps using Azure DevOps Connector in SSIS


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

Video Tutorial - Write or lookup data to Azure DevOps using SSIS

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




How to write or lookup data to Azure DevOps in SSIS (Import data)


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.
    SSIS API Destination (Predefined Templates) - Drag and Drop

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

  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
    Azure DevOps Connector Selection

  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.

    Steps to get 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.
    3. Select Create Application and then the Application Settings page will be displayed.
    4. Record the application settings that are displayed for us to use later, especially the App ID and the Client Secret.
    5. Visit https://aex.dev.azure.com. Once you are logged in, record your organization name in the URL that is displayed on the page. For example, if your organization is called "acmeinc", the URL on the page would be acmeinc.visualstudio.com.
    6. Back at the connector screen, enter the App ID that was recorded in step 4 into the Client Id (App ID) field.
    7. Enter the client secret that was recorded in step 4 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.
    8. Enter the organization that was recorded in step 5 into the Organization name or Id for url field.
    9. 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.
    10. Select the project you want to connect to by default from the Default Project (Choose after Generating Token) field.
    11. Select the Security tab.
    12. Enter https://auditservice.dev.azure.com,https://almsearch.dev.azure.com into the Additional Trusted Domains field.
    13. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account.
    14. If the connection test succeeds, select OK.
    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...
    Scope Fill in the parameter...
    API Version Fill in the parameter...
    Optional Parameters
    Default Project Name (Choose after Generating Token) Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection
    Steps to get Azure DevOps Credentials
    To connect to Azure DevOps using a Personal Access Token (PAT), you must first create a valid PAT:
    1. Go to your Azure DevOps home page: https://dev.azure.com/{your organization name}.
    2. On the home page, select the User Settings menu dropdown (looks like a person icon with a small gear over it), and then select Personal access tokens.
    3. Select the New Token button.
    4. Enter a name for the new personal access token.
    5. Select the appropriate organization for the new personal access token.
    6. Select the expiration date for the new personal access token.
    7. Select the scopes for this token. (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.)
    8. Select the Create button.
    9. The new Personal Access Token (PAT) is created and displayed. Copy and save this token, since it is as sensitive as a password.
    10. Visit https://aex.dev.azure.com. Once you are logged in, record your organization name in the URL that is displayed on the page. For example, if your organization is called "acmeinc", the URL on the page would be acmeinc.visualstudio.com.
    11. Back at the connector screen, enter the token you recorded from step 9 into the Personal Access Token (PAT) field.
    12. Enter the organization that was recorded in step 10 into the Organization name or Id for url field.
    13. Enter the name or Id of the project you want to connect to by default in the Default Project (Choose after above fields) field.
    14. Select the Security tab.
    15. Enter https://auditservice.dev.azure.com,https://almsearch.dev.azure.com,https://analytics.dev.azure.com into the Additional Trusted Domains field.
    16. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account.
    17. If the connection test succeeds, select OK.
    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 Fill in the parameter...
    AuthHeader Fill in the parameter...
    UserName Fill in the parameter...
    Default Project Name (Choose after Generating Token) Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

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

  7. Finally, map the 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.
    API Destination - Columns Mapping

  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