Skip to main content
Reset Azure APIM Developer Portal

Overview

The extension facilitates resetting the Developer Portal to the default Contoso version. This action eradicates all pages, layouts, and contents from the Developer Portal permanently. Please note, once implemented, it cannot be restored to the previous version.

Prerequisites

  1. An active Service Principle with access to Azure API Management Services.

Agent-Requisites

  • Microsoft Hosted Agent
  • Self-Hosted Agent
  • Azure Virtual Machine Scale Set Agent
No Pre-Requisites Required

Agent-supported

  • Microsoft Hosted Agent
  • Self-Hosted Agent
  • Windows Agents
  • Linux Agents
  • MacOs Agents

Task Configuration:

1

Add Task

Click on + Add task to the Build / Release pipeline.
2

Search for the Task

Search for Reset Developer Portal for API Management Services.
3

Add Input Parameters

Add the Input Parameters as per the table below.

Task Inputs

  • v2
  • v1
OptionsDescription
Azure Service ConnectionShould have access to the required API Management Service
APIM Service NameService name for Source API Management Service

Once Reset it cannot be reverted back to previous version.

Azure API Management Network Restrictions

Understand how your Virtual Network Type affects your Resetting of your Developer Portal.
  • Virtual Network - None
  • Virtual Network - Internal
  • Virtual Network - External
No Restrictions on Resetting

Releases:

  • v1.0.0 (March 2023) • Initial Release.
  • v2.0.0 (September 2023) • Release 2.0
    • Updated to Dropdowns from Input Textboxes.
    • Removed Text Inputs - Subscription ID, Resource Group and Replaced APIM Service Name with Dynamic Dropdown.
    • Now supports Microsoft Agents - Windows, Mac, Linux as well as Self-Hosted Agents now.
    • Execution time is now less than 60 seconds and faster on Linux.

Issues and Discussions