> ## Documentation Index
> Fetch the complete documentation index at: https://docs.celezant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reset Azure APIM Developer Portal

> Azure DevOps Agent published in Azure Marketplace for Resetting the Azure APIM Developer Portal to default state

<img className="block dark:hidden" src="https://celezantweb.blob.core.windows.net/images/apim-reset-2.png" alt="Reset Azure APIM Developer Portal" />

<img className="hidden dark:block" src="https://celezantweb.blob.core.windows.net/images/apim-reset-2.png" alt="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

<Tabs>
  <Tab title="Microsoft Hosted Agent">
    No Pre-Requisites Required
  </Tab>

  <Tab title="Self-Hosted Agent">
    Install **Node v14.0.0** or higher version
  </Tab>

  <Tab title="Azure Virtual Machine Scale Set Agent">
    Install **Node v14.0.0** or higher version
  </Tab>
</Tabs>

### Agent-supported

<Tabs>
  <Tab title="Microsoft Hosted Agent">
    * Windows Agents
    * Linux Agents
    * MacOs Agents
  </Tab>

  <Tab title="Self-Hosted Agent">
    * Windows Agents \[Windows 10 & 11, Server 2019, Server 2022]
    * Ubuntu 20.04 and later
    * RedHat Linux
    * CentOS
    * Debian OS
  </Tab>
</Tabs>

## Task Configuration:

<Steps>
  <Step title="Add Task">
    Click on **+ Add task** to the Build / Release pipeline.
  </Step>

  <Step title="Search for the Task">
    Search for **Reset Developer Portal for API Management Services**.
  </Step>

  <Step title="Add Input Parameters">
    Add the Input Parameters as per the table below.
  </Step>
</Steps>

## Task Inputs

<Tabs>
  <Tab title="v2">
    | Options                  | Description                                               |
    | ------------------------ | --------------------------------------------------------- |
    | Azure Service Connection | Should have access to the required API Management Service |
    | APIM Service Name        | Service name for Source API Management Service            |
  </Tab>

  <Tab title="v1">
    | Options                  | Description                                               |
    | ------------------------ | --------------------------------------------------------- |
    | Azure Service Connection | Should have access to the required API Management Service |
    | APIM Subscription ID     | Subscription ID for API Management Service                |
    | APIM Resource Group      | Resource Group Name for API Management Service            |
    | APIM Service Name        | Service Name for Source API Management Service            |
  </Tab>
</Tabs>

#

<Warning>Once Reset it cannot be reverted back to previous version.</Warning>

## Azure API Management Network Restrictions

Understand how your Virtual Network Type affects your Resetting of your Developer Portal.

<Tabs>
  <Tab title="Virtual Network - None">
    No Restrictions on Resetting
  </Tab>

  <Tab title="Virtual Network - Internal">
    No Restrictions on Resetting
  </Tab>

  <Tab title="Virtual Network - External">
    No Restrictions on Resetting
  </Tab>
</Tabs>

## 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

* [Report Issues](https://github.com/celezant/APIM-Reset-Developer-Portal/issues)
* [Join Discussions](https://github.com/celezant/APIM-Reset-Developer-Portal/discussions)

## Links and References

* [Microsoft - Overview of the developer portal](https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal)
* [API Management developer portal - frequently asked questions](https://learn.microsoft.com/en-us/azure/api-management/developer-portal-faq)
* [Automate developer portal deployments](https://learn.microsoft.com/en-us/azure/api-management/automate-portal-deployments)
* [Migrate to the new developer portal](https://learn.microsoft.com/en-us/azure/api-management/developer-portal-deprecated-migration)