Search code examples
azure-devopsazure-devops-extensions

Creating configuration pane for Azure DevOps extension

We have created a few extensions for Azure DevOps (0) that are pipeline extensions.

We are trying to create new extensions that can react to changes in work items of Azure Boards. The API's for interacting with changes in work items are fairly straight-forward, but we are struggling with configuration of the extension.

Essentially we need to allow the users to configure the extension on two levels

1) On "Organization level"

It should be possible for a user (Project Administrator) to configure parameters as "external system URL" etc. An example of this could be something like below mockup:

enter image description here

2) On "Project level"

For each project in Azure DevOps an admin should be able to configure parameters like "Enable/disable extension" or "External UID" etc. An example of this could be something like below mockup:

Organization level

When the extension reacts to "Work item saved" it will query the parameters on both levels to figure out what to do.

My problem is: where the heck do I save this information? I could add a number of "custom fields" to the template in use, but since fields can only be added to work item types, it is really not ideal in any way.

Where can I save this information through the API's?

PS: Source code for our extensions are available as OSS (Apache license) here:

(0) https://bitbucket.org/projectum/

Thank you :-)

Solution

  • It turns out that Azure DevOps has a way to store data for extensions. It can store data on both Project Collection scope as well as User scope.

    I think I will be able to use this to store the data I need. All I need now is to figure out where to put the UI that the user or admin will use to maintain this data.

    https://learn.microsoft.com/en-us/azure/devops/extend/develop/data-storage?view=vsts

    :-)