Plug-in Documentation

Azure DevOps

Overview

The Azure DevOps plug-in provides for integration with an Azure DevOps server. This plug-in imports work items from an Azure DevOps server and saves them as UrbanCode Velocity issues. Data between the Azure DevOps server and the UrbanCode Velocity server is synchronized every five minutes.

Compatibility

Must be running UrbanCode Velocity version 1.2.1 and later to use the plug-in.

Versions

There is no install process for this plug-in. The Azure DevOps plug-in is identified to UrbanCode Velocity as a value stream integration. UrbanCode Velocity plug-in images are located in DockerHub and the UrbanCode Velolcity code accesses the version that you select. To view available versions, see the UrbanCode DockerHub.

History

Version 1.0.34

  • Added http proxy support

Version 1.0.30

  • Update plugin version from 0.x.x to 1.x.x format.

Version 0.0.15

  • Get string representation of trackerId.

Version 0.0.14

  • Initial release

Usage

To use the Azure DevOps plug-in you must define the integration, create a value stream, and upload the integration. The value stream map contains the properties, you will use to define the plug-in integration. Basically, the plug-in integration is defined with a value stream within the UrbanCode Velocity user interface. Defining the integration includes defining configuration properties that connect the UrbanCode Velocity server to the Azure DevOps server. The basic flow to use the plug-in includes:

  1. Download the value stream map. The value stream map is a JSON file used to define integrations.
  2. Edit the JSON file to include the plug-in configuration properties.
  3. Save and upload the JSON file. This replaces the current JSON file with the new content.
  4. View the new integration on the Integration user interface page.

Integration type

The Azure DevOps plug-in supports scheduled events integration which are listed in the following table.

Scheduled events
Name Description
SyncAzureIssuesEvent Queries the Query Azure DevOps server for new or updated pull requests and commits.
SyncAzureGitDataEvent Queries the Azure DevOps server for new or updated work items.

Integration

From the user interface Value Steam page, click Upload to upload the value stream map which is a JSON file. The JSON file contains the information for creating a value stream and integrating with the Azure DevOps server. The following table describes the information for the creating a UrbanCode Velocity value stream map.

Value stream map information
Name Description Required
image The version of the plug-in that you want to use. To view available versions, see the UrbanCode DockerHub. If a value is not specified, the latest version is used. No
name An assigned name to the value stream. Yes
properties List of configuration properties used to connect and communicate with the Azure DevOps server. Enclose the properties within braces. Yes
tenant_id The name of the tenant. Yes
type Unique identifier assigned to the plug-in. The value for the Azure DevOps plug-in is ucv-ext-azure. Yes

Configuration Properties

The configuration properties which are included in the properties field are unique to the Azure DevOps plug-in and define the connection and communication to the Azure DevOps server.

Configuration properties
Name Type Description Required Hidden
Access Token String The access token to authenticate with the Azure DevOps server. You can use either this property or the Password property to authenticate with the server. No No
Organization String The name of the Azure organization in which the specified project exists. Yes No
Password String The password to use to authenticate with the Rally server. No No
Project String The name of the Azure DevOps project from which to pull data. Yes No
Repositories Array A list of repositories from which to import pull request, commit, and build data. No No
URL String The URL of the Azure DevOps server. The default value is https://dev.azure.com. Yes No
User Name String The user name to authenticate with the Azure DevOps server. No No
UrbanCode Velocity User AccessKey String The user access key to authenticate with the UrbanCode Velocity server. No No
Proxy Server String The URL of the proxy server including the port number. The URL protocol can be http or https. No Yes
Proxy User Name String The user name used to authenticate with the proxy server. No Yes
Proxy Password String The password used to authenticate with the proxy server. No Yes