Create a new Azure Connection

Owned by Jeff Gleeson
Last updated: Jan 10, 2024
3 min read

TFS4JIRA requires connections to your Jira and Azure DevOps instances to perform synchronization tasks. Since TFS4JIRA is installed on Jira Cloud, no connection configuration is required. However, you must establish a connection to an Azure DevOps instance.

This page provides instructions for creating, editing and removing a connection to Azure DevOps.

Create a new connection to Azure

  1. There are two ways to access the Azure Connections page:

    1. From the TFS4JIRA Synchronizer page. Click Connections from the Jira-Azure Synchronizer menu and click +Add Azure Connection to open the Add Azure Connection page.

    2. When creating or editing a Sync profile from the Connections section of General Settings. Click the Azure field and select Add Connection to go to the Add Azure Connection page.

  2. Provide your Azure connection credentials:

    1. Enter the Azure Instance URL. Provide the root path to your instance, not to a particular project.

    2. Enter the Sync user email. This user account performs all synchronization changes and is associated with the personal access token.
      We strongly recommend creating a dedicated Azure user account specifically for synchronization. Refer to https://appfire.atlassian.net/wiki/spaces/TFS4JIRA/pages/148177872 for more information.

    3. Enter an Azure Personal access token. This token is created in Azure DevOps and contains security credentials used for authentication.
      Refer to Create a Personal Access Token in Azure for creating a token in Azure.

      add azure connection page

  3. Click Test Connection. A Connection succeeded message appears when all the provided details are valid.

  4. Click Add Connection to save the connection.

The new connection appears on the Azure Connections page.

Edit an existing connection

Edit an existing connection if there has been a change to any of the connection information. For example, if a Personal Access Token has expired and a new token created, you can edit the connection and enter the new token.

  1. Click Connections from the Jira-Azure Synchronizer menu to open the Azure Connections page.

  2. Click the Options icon (…) for the connection you want to edit.

  3. Click Edit from the options list.

  4. You can update the Instance URL, Sync user email, or Personal access token from the Edit Azure Connection page.

  5. Click Test Connection. A Connection succeeded message appears when all the provided details are valid.

  6. Click Save Connection to save the updated details.

Remove an existing connection

If the connection is currently used by a synchronization profile, you cannot remove the connection. Remove the connection reference from the profile before you continue.

  1. Click Connections from the Jira-Azure Synchronizer menu to open the Azure Connections page.

  2. Click the Options icon (…) for the connection you want to remove.

  3. Click Remove from the options list.

  4. Type REMOVE CONNECTION in the Remove connection? dialog to confirm.

  5. Click Remove connection. This action cannot be undone.

The connection is now removed from the Azure Connections page.