Azure DevOps Connector for Azure Data Factory (SSIS)

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.
You can use this connector to integrate Azure DevOps data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.

Download Documentation

Create SSIS package

First of all, create an SSIS package, which will connect to Azure DevOps in SSIS. Once you do that, you are one step closer to deploying and running it in Azure-SSIS integration runtime in Azure Data Factory (ADF). Then simply proceed to the next step - creating and configuring Azure Blob Storage Container.

Prepare custom setup files for Azure-SSIS runtime

Now it's time to start preparing custom setup files for Azure-SSIS runtime. During Azure-SSIS runtime creation you can instruct ADF to perform a custom setup on a VM (Azure-SSIS node); i.e. to run the custom installer, copy files, execute PowerShell scripts, etc. In that case, your custom setup files are downloaded and run in the Azure-SSIS node (a VM) when you start the runtime. In this section we will prepare custom setup files so that you can run SSIS packages with SSIS PowerPack connectors inside in Azure-SSIS runtime.

Read more on Azure-SSIS runtime custom setup in Microsoft Azure Data Factory reference.

Trial Users

Use the step below if you are a Trial User, when you did not purchase a license key. Proceed with these steps:

  1. Download SSIS PowerPack trial installer.
    Make sure you don't rename the installer and keep it named as SSISPowerPackSetup_64bit_Trial.msi.
  2. Create a text file and name it main.cmd (make it all lowercase, very important).
  3. Copy and paste this script into it and save it:
    set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
    
    echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
    dir /s /b > "%DIR%\file_list.txt"
    
    echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
    
    ::Install SSIS PowerPack
    msiexec /i  "SSISPowerPackSetup_64bit_Trial.msi" ADDLOCAL=ALL /q  /L*V "%DIR%\powerpack_trial_install_log.txt"
    
    echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
    dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
    dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
    
    echo DONE : %TIME% >> "%DIR%\steps_log.txt"
    
    echo complete
    This is the entry-point script that is executed when Azure-SSIS runtime is started.
  4. At last! You are ready to upload these two files — main.cmd & SSISPowerPackSetup_64bit_Trial.msi — into your Azure Blob Storage container's folder, which we will do in the Upload custom setup files to Azure Blob Storage container step.

Paid Customers

Use the steps below if you are a Paid Customer, when you purchased a license. Proceed with these steps:

  1. Download SSIS PowerPack paid installer.
    Make sure you don't rename the installer and keep it named as SSISPowerPackSetup_64bit.msi.
  2. Have your SSIS PowerPack license key handy, we will need it in the below script.
  3. Create a text file and name it main.cmd (make it all lowercase, very important).
  4. Copy and paste the below script into it.
  5. Paste your license key by replacing parameter's --register argument with your real license key.
  6. Finally, save main.cmd:
    set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
    
    echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
    dir /s /b > "%DIR%\file_list.txt"
    
    echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
    
    ::Install SSIS PowerPack
    msiexec /i  "SSISPowerPackSetup_64bit.msi" ADDLOCAL=ALL /q  /L*V "%DIR%\powerpack_install_log.txt"
    
    echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
    
    ::Activate PowerPack license (Optional)
    "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -p SSISPowerPack --register "lgGAAO0-----REPLACE-WITH-YOUR-LICENSE-KEY-----czM=" --logfile "%DIR%\powerpack_register_log.txt"
    
    ::Show System Info
    echo Calling Step 4 : %TIME% >> "%DIR%\steps_log.txt"
    "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -i -l "%DIR%\sysinfo_log.txt"
    
    echo Calling Step 5 : %TIME% >> "%DIR%\steps_log.txt"
    dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
    dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
    
    echo DONE : %TIME% >> "%DIR%\steps_log.txt"
    
    echo complete
    This is the entry-point script that is executed when Azure-SSIS runtime is started.
  7. At last! You are ready to upload these two files — main.cmd & SSISPowerPackSetup_64bit.msi — into your Azure Blob Storage container's folder, which we will do in the Upload custom setup files to Azure Blob Storage container step.

Upload custom setup files to Azure Blob Storage container

Within Azure Blob Storage container we will store custom setup files we prepared in the previous step so that Azure-SSIS can use them in custom setup process. Just perform these very simple, but very important steps:

  1. Create Azure Blob Storage container, if you haven't done it already
    Make sure you create and use Azure Blob Storage container instead of Azure Data Lake Storage folder. Azure Data Lake Storage won't allow creating an SAS URI for the container, which is a crucial step in the process.
  2. Find Blob Containers node, right-click on it and hit Create Blob Container option: Create a new blob container in Azure Storage Explorer
  3. Upload the two custom setup files — main.cmd & the MSI installer — into your Azure Blob Storage container's folder: Upload SSIS Custom Setup Files to Azure Data Factory
  4. It was easy, wasn't it? It's time we create an SAS URI in the next step.

Create SAS URI for Azure Blob Container

Once you have custom setup files prepared, it's time we generate an SAS URI. This SAS URI will be used by a new Azure-SSIS runtime to install SSIS PowerPack inside the runtime's node, a VM. Let's proceed together by performing the steps below:

  1. Install and launch Azure Storage Explorer.
  2. Right-click on the Storage Accounts node and then hit Connect to Azure storage... menu item: Add Azure Storage account to Azure Storage Explorer
  3. Proceed by right-clicking on that container node and select Get Shared Access Signature... option.
  4. Next, set the Expiry time field to a date far in the future.
    If you restart Azure-SSIS runtime and your SAS URI is expired by that time, it will not start.
  5. Select Read, Create, Write, and List permissions: Generate SAS URI in Azure Storage Explorer for Azure Data Factory Custom Setup
    We also recommend to add Delete permission too to support future functionality.
  6. Copy SAS URL to the clipboard and save it for the next step: Get container SAS URI for Azure Data Factory SSIS Custom Setup You can also generate and copy SAS URL from within Azure Portal itself: Generate SAS URI in Azure Data Factory Custom Setup via online portal

Create Azure-SSIS integration runtime

Once you have the SAS URL we obtained in the previous step, we are ready to move on to create an Azure-SSIS runtime in Azure Data Factory:

  1. Firstly, perform the steps described in Create an Azure-SSIS integration runtime article in Azure Data Factory reference.
  2. In Advanced settings page section, configure Custom setup container SAS URI you obtained in the previous step: Configure SAS URI in Azure Data Factory custom setup
  3. And you are done! That was quick! You can see your Azure-SSIS runtime up and running: Verify Azure-SSIS runtime status in Azure Data Factory portal

The custom setup script is executed only once — at the time an Azure-SSIS runtime is started.

It is also executed if you stop and start Azure-SSIS runtime again.

Deploy SSIS package in Visual Studio

We are ready to deploy the SSIS package to Azure-SSIS runtime. Once you do that, proceed to the next step for the grand finale! Deploy SSIS package to Azure Data Factory from Visual Studio

Execute SSIS package in SQL Server Management Studio (SSMS)

After all hard work, we are ready to execute SSIS package in SQL Server Management Studio (SSMS):

  1. Connect to the SQL Server which is linked to your Azure-SSIS runtime and contains SSISDB database.
  2. Navigate to Integration Services Catalog » Your Folder » Your Project » Your Package, right-click on it, and hit Execute...: Execute SSIS package using SQL Server Management Studio (SSMS)
  3. To view the status of the past execution, navigate to Integration Services Catalog » Your Folder » Your Project » Your Package, right-click on it, and select Reports » Standard Reports » All Executions menu item: Monitor SSIS package execution using SSMS UI

Scenarios

Moving SSIS PowerPack license to another Azure-SSIS runtime

If you are a Paid Customer, there will be a time when you no longer use Azure-SSIS runtime or you need to use your license on a different ADF instance. To transfer a license from one Azure-SSIS runtime to another, perform these steps:

  1. Copy & paste this script into main.cmd we used in the previous step:
    set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
    
    echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
    dir /s /b > "%DIR%\file_list.txt"
     
    echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
    
    ::Install SSIS PowerPack
    msiexec /i  "SSISPowerPackSetup_64bit.msi" ADDLOCAL=ALL /q  /L*V "%DIR%\powerpack_install_log.txt"
     
    echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
     
    ::De-Activate same license
    "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -p SSISPowerPack --unregister --logfile "%DIR%\powerpack_un_register_log.txt"
     
    ::Show System Info
    echo Calling Step 4 : %TIME% >> "%DIR%\steps_log.txt"
    "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -i -l "%DIR%\sysinfo_log.txt"
     
    echo Calling Step 5 : %TIME% >> "%DIR%\steps_log.txt"
    dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
    dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
     
    echo DONE : %TIME% >> "%DIR%\steps_log.txt"
     
    echo complete
  2. Start Azure-SSIS runtime.
    This will unregister your license on the original Azure-SSIS runtime.
  3. Stop Azure-SSIS runtime to deallocate resources in Azure.
  4. Now you are free to activate it on another Azure-SSIS runtime.

Advanced topics

Actions supported by Azure DevOps Connector

Azure DevOps Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Get Query Fileds
Gets query fields for work items.    [Read more...]
Parameter Description
Project Name The Name of the project.
Team Id or Name Id or name of the team associated with the query.
Use time precision Whether or not to use time precision.
Option Value
false false
true true
Wiql Query The WIQL query (refer Azure DevOps Help to learn Wiql syntax.
 Get Work Items for Specified Query Id
Get work items associated with the specified project, organization and query. (A team can optionally be specified as well.). Read more about this API here https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query-by-id?view=azure-devops-rest-7.1    [Read more...]
Parameter Description
Project Name The Name of the project.
Query Id The Id of the predefined Query.
Team Id or Name Id or name of the team associated with the query.
Use time precision Whether or not to use time precision.
Option Value
false false
true true
 Query Work Items
Get work items associated with the specified project and organization that are filtered by a Wiql query. (A team can optionally be specified as well.). Read more about this API here https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query-by-wiql?view=azure-devops-rest-7.0 and here https://learn.microsoft.com/en-us/azure/devops/boards/queries/query-operators-variables?view=azure-devops    [Read more...]
Parameter Description
Project Name The Name of the project.
Team Id or Name Id or name of the team associated with the query.
Use time precision Whether or not to use time precision.
Option Value
false false
true true
Wiql Query The WIQL query (refer Azure DevOps Help to learn Wiql syntax.
 Query Work Item Comments
Get work item comments associated with the specified project and organization that are filtered by a Wiql query. (A team can optionally be specified as well.). Read more about this API here https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query-by-wiql?view=azure-devops-rest-7.0 and here https://learn.microsoft.com/en-us/azure/devops/boards/queries/query-operators-variables?view=azure-devops    [Read more...]
Parameter Description
Project Name The Name of the project.
Team Id or Name Id or name of the team associated with the query.
Use time precision Whether or not to use time precision.
Option Value
false false
true true
Wiql Query The WIQL query (refer Azure DevOps Help to learn Wiql syntax.
 Get Work Item Comments (by WorkItem Id)
Get work item comments associated with WorkItem Id    [Read more...]
Parameter Description
WorkItemId WorkItem Id for which you like to get comments
Project Name The Name of the project.
api-version For this API you must set 7.0-preview for now
 Get Work Item Comment by Comment Id and Work Item Id
Get work item comment by its Comment Id (for specific WorkItem Id)    [Read more...]
Parameter Description
Id Comment Id
WorkItemId WorkItem Id for which you like to get comments
Project Name The Name of the project.
api-version For this API you must set 7.0-preview for now
 Create Work Item Comment
Creates work item comment for a specific WorkItem Id    [Read more...]
Parameter Description
Id Comment Id
WorkItemId WorkItem Id for which you like to get comments
Project Name The Name of the project.
Comment Text
api-version For this API you must set 7.0-preview for now
 Update Work Item Comment
Update work item comment for a specific Work Item Id and Comment Id    [Read more...]
Parameter Description
Id Comment Id
WorkItemId WorkItem Id for which you like to get comments
Project Name The Name of the project.
Comment Text
api-version For this API you must set 7.0-preview for now
 Delete Work Item Comment
Delete work item comment for a specific Work Item Id and Comment Id    [Read more...]
Parameter Description
Id Comment Id
WorkItemId WorkItem Id for which you like to get comments
Project Name The Name of the project.
api-version For this API you must set 7.0-preview for now
 Get Work Item Column Fields
Get work item column fields in the default project within the organization. Read more about description on each field here https://learn.microsoft.com/en-us/azure/devops/boards/work-items/guidance/work-item-field?view=azure-devops    [Read more...]
Parameter Description
Project Name The Name of the project.
Expand Parameters The expand parameters for work item attributes. Possible options are 'None', 'Relations', 'Fields', 'Links', and 'All'.
Option Value
None None
Relations Relations
Fields Fields
Links Links
All All
 Get Work Items by Ids
Get work items in the default project within the organization by their work item Ids.    [Read more...]
Parameter Description
Project Name The Name of the project.
Work Item Id List (comma separated) The comma-separated list of requested work item ids. (Maximum 200 ids allowed).
As-Of Date AsOf UTC date time string.
Expand Parameters The expand parameters for work item attributes. Possible options are 'None', 'Relations', 'Fields', 'Links', and 'All'.
Option Value
None None
Relations Relations
Fields Fields
Links Links
All All
Error Policy The flag to control error policy in a bulk get work items request. Possible options are 'Fail' and 'Omit'.
Option Value
Fail Fail
Omit Omit
Fields Comma-separated list of requested fields.
 Get Work Item Types
Get work item types in the default project within the organization.    [Read more...]
Parameter Description
Project Name The Name of the project.
 Create Work Item
Creates a new work item in the default project within the organization.    [Read more...]
Parameter Description
Project Name The Name of the project.
WorkItemType
ByPassRules Set this to true to allow setting values for some fields which otherwise wont work due to certain rules
Option Value
true true
false false
 Update Work Item
Updates an existing work item in the default project within the organization.    [Read more...]
Parameter Description
Project Name The Name of the project.
Work Item Id
Operation Some operation requires you to supply 'add' rather than 'replace' (e.g. adding new tag)
Option Value
replace replace
add add
remove remove
copy copy
move move
test test
 Delete Work Item
Deletes an existing work item in the default project within the organization.    [Read more...]
Parameter Description
Project Name The Name of the project.
Work Item Id
 Get List of Queries
Gets a list of predefined queries within the organization.    [Read more...]
Parameter Description
Project Name The Name of the project.
Max Depth (items inside nested folders)
 Get List of Projects
Gets a list of projects within the organization.    [Read more...]
 Get Project Details
Gets the details of the specified project within the organization by its project Id.    [Read more...]
Parameter Description
Id
 Create Project
Create a new project within the organization.    [Read more...]
 Update Project
Update an existing project within the organization.    [Read more...]
Parameter Description
Project Id The ID of the project to update.
 Delete Project
Delete an existing project within the organization.    [Read more...]
Parameter Description
Project Id The ID of the project to delete.
 Get List of Teams
Gets a list of teams in the default project within the organization.    [Read more...]
Parameter Description
Project Name The Name of the project.
 Get Team Details
Gets the details of the specified team in the default project within the organization by its team Id or team name.    [Read more...]
Parameter Description
API Version
Option Value
7.0-preview 7.0-preview
7.1-preview.2 7.1-preview.2
Team Id or Name
Project Name The Name of the project.
 Create Team
Creates a new team in the default project within the organization.    [Read more...]
 Update Team
Updates the details of the specified team in the default project within the organization by its team Id.    [Read more...]
Parameter Description
API Version
Option Value
7.0-preview 7.0-preview
7.1-preview.2 7.1-preview.2
Team Id
 Delete Team
Deletes the specified team in the default project within the organization by its team Id.    [Read more...]
Parameter Description
API Version
Option Value
7.0-preview 7.0-preview
7.1-preview.2 7.1-preview.2
Team Id The ID of the team to delete.
 Search for Work Items by Text
Search for specific text within work items in the default project of the organization.    [Read more...]
Parameter Description
Text to Search For
 Get Team Members
Lists all members part of a specified Team in the project within the organization (by team Id or team name).    [Read more...]
Parameter Description
API Version
Option Value
7.0-preview 7.0-preview
7.1-preview.2 7.1-preview.2
Project Name The Name of the project.
Team Id or Name
 Get Team Iterations
Lists Team iterations for a specified project / team.    [Read more...]
Parameter Description
API Version
Option Value
7.0-preview 7.0-preview
7.1-preview.2 7.1-preview.2
Project Name The Name of the project.
Team Id or Name
 Get Team Iteration Capacities
Lists capacity for all team members in a specified project / team / iteration.    [Read more...]
Parameter Description
Project Name The Name of the project.
Team Id or Name
Itertation Id or Name
API Version
Option Value
7.0-preview 7.0-preview
7.1-preview.2 7.1-preview.2
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Conclusion

In this article we discussed how to connect to Azure DevOps in Azure Data Factory (SSIS) and integrate data without any coding. Click here to Download Azure DevOps Connector for Azure Data Factory (SSIS) and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Azure DevOps Connector for Azure Data Factory (SSIS) Documentation 

More integrations

Other application integration scenarios for Azure DevOps

Other connectors for Azure Data Factory (SSIS)


Download Azure DevOps Connector for Azure Data Factory (SSIS) Documentation

  • How to connect Azure DevOps in Azure Data Factory (SSIS)?

  • How to get Azure DevOps data in Azure Data Factory (SSIS)?

  • How to read Azure DevOps data in Azure Data Factory (SSIS)?

  • How to load Azure DevOps data in Azure Data Factory (SSIS)?

  • How to import Azure DevOps data in Azure Data Factory (SSIS)?

  • How to pull Azure DevOps data in Azure Data Factory (SSIS)?

  • How to push data to Azure DevOps in Azure Data Factory (SSIS)?

  • How to write data to Azure DevOps in Azure Data Factory (SSIS)?

  • How to POST data to Azure DevOps in Azure Data Factory (SSIS)?

  • Call Azure DevOps API in Azure Data Factory (SSIS)

  • Consume Azure DevOps API in Azure Data Factory (SSIS)

  • Azure DevOps Azure Data Factory (SSIS) Automate

  • Azure DevOps Azure Data Factory (SSIS) Integration

  • Integration Azure DevOps in Azure Data Factory (SSIS)

  • Consume real-time Azure DevOps data in Azure Data Factory (SSIS)

  • Consume real-time Azure DevOps API data in Azure Data Factory (SSIS)

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

  • Connect Azure DevOps in Azure Data Factory (SSIS)

  • Load Azure DevOps in Azure Data Factory (SSIS)

  • Load Azure DevOps data in Azure Data Factory (SSIS)

  • Read Azure DevOps data in Azure Data Factory (SSIS)

  • Azure DevOps API Call in Azure Data Factory (SSIS)