Pricing: Free

Overview

This extension allows you to automate various DfE Find and Use an API Management Portal tasks by providing you with pre-built DevOps Pipeline tasks and customisable templates. It will help you conveniently and effectively automate a set of Azure DevOps Pipeline tasks without the need to individually configure or make API calls for each step of those processes - improving efficiency, maintain consistency and reducing the chances of errors.

Prerequisites

The following is required to install and use the FaUAPI DevOps Pipeline tasks extension:

  1. Node.js - version 22.x
  2. npm install -g typescript@5.7.2
  3. npm install -g tfx-cli@v0.17.0
  4. npm install mocha
  5. npm install mocha-junit-reporter
  6. Create a file named config.local.json under the shared folder.
{
    "AutomationToken":"valid test workspace token",
    "FaUAPIInstance": "DEV"
}
  1. Run build-tasks.ps1. This will install all necessary modules and ensure the shared folder is copied to all tasks (problem). All copies are ignored when committing.

Available Tasks:

Task FaUAPI DevOps Pipeline Task Name Notes
Configuring Named Values FaUAPI-Configure-Named-Values This DevOps pipeline task configure Named values which are useful for creating shared variables including email address and secret keys that can be reused across APIs within a workspace and used by API policies. Within a Pipeline with multiple tasks, this task will need to be performed first as it is required to configured backends and API policy which may have references to Named Values.
Configuring Backends FaUAPI-Configure-Backends This DevOps pipeline task will configure Backends for an API which is the location address of the backend server for the hosted API environment.
Configuring an API FaUAPI-ConfigureApi This DevOps pipeline task will to configure and create a new API or update the configuration of an existing an API.
Configuring an API policy FaUAPI-Configure-Api-Policy This DevOps pipeline task will configure the policy for an API.
Publishing an API FaUAPI-Publish-Api This DevOps pipeline task will publishing an API.
Unpublishing an API FaUAPI-Unpublish-Api This DevOps pipeline task will unpublishing an API.

Task inputs:

Using this extension requires different sets of inputs depending on the task, however these two a common across all tasks: | Input Name | Required? | Type | Description | Default Value | | --------------- | ------------------------------ | ----------------------------------------------------------------------------------- |------------------- |------------------ | | AutomationToken | Required | String | Workspace automation token. This is obtained by following the steps in Adding a workspace automation token. | - | FaUAPIInstance | Required | String | Instance which the API is to be configured. Valid value string are ('DEV', 'Test', 'PREPROD', 'PROD'). | - |

Notes:

Depending on the FaUAPI DevOps Pipeline task selected from the tasks available within the extension, additional inputs will be required and will be clearly indicated in the configuration forms.

How to Use

After installing the extension, you can add tasks to new or existing build and release pipelines.

Quick start

  1. Add the FaUAPI DevOps Pipeline tasks to your Azure DevOps organization.
  2. Sign in to Azure DevOps.
  3. Go to your project within Azure DevOps organization.
  4. Select Pipelines from the left sidebar tab options. This will show you the Pipeline page with search.
  5. Type the word or phrase for the pipeline task you want to create into the search box.
  6. Select the relevant FaUAPI DevOps pipeline task from the search result. This will show you the pipeline task creation page.
  7. Enter the relevant details for the pipeline task such as FaUAPI instance, Automation Token etc.
  8. Select the Add button.
  9. Select the Run button to run your pipeline.

For more details, see the full documentation with the Get Started guide .

Highlighted feature:

  • Easy to set up and configure
  • One Click automation
  • Only Azure DevOps Pipeline extension for FaUAPI Management Portal

Releases:

| V 0.1.46 (Latest)| Automation tool publishing and managing APIs on the Department for Education's Find and Use an API service. |

Known Limitations and Issues

FaUAPI DevOps Pipeline tasks extension requires you to be part of the relevant organisation tenant to have the extension available to you for installation and use.

Feedback and Issues

If you have any features suggestions, questions, or issues then please contact the FaUAPI Team. You can raise a feature suggestion or report a problem regarding Azure DevOps search on the Azure DevOps developer community.

This Get Started guide provides instructions on installing, configuring and using the FaUAPI DevOps Pipeline tasks extension for Azure DevOps.