Share via

API Management - LegacyPortalStatus - REST API - Details

Kevin Pearce 35 Reputation points
2023-12-15T09:35:05.5333333+00:00

Hi,

I have seen a new Body Param/Option appear in the "2023-03-01-preview" REST API for disabling the Legacy API Management Developer Portal.

https://learn.microsoft.com/en-us/rest/api/apimanagement/api-management-service/update?view=rest-apimanagement-2023-03-01-preview&tabs=HTTP#legacyportalstatus

I cannot seem to find any Documentation around this (yet?) and was wondering if it would be possible to clarify exactly "what" is happening behind the scenes when this flag is switched please.

ie.

  1. Is it simply switching off the backend (presumed an app service?) used to host the Legacy Portal?
  2. Are DNS entries being resolved/unresolved?
  3. Does it queue any removal of the Legacy code/setup, or does it remain available to be switched back on if desired? (although I do appreciate it is now officially retired)
  4. Are there any side effects that would alter any existing New Portal functionality?
  5. Are there any side effects that would change the way historic API calls are made (ie. ones that may remain baked into legacy custom applications?

If you had any information on any of the above, it would be much appreciated.

Thanks

Azure API Management
Azure API Management
An Azure service that provides a hybrid, multi-cloud management platform for APIs.
2,459 questions
Accepted answer
  1. JananiRamesh-MSFT 29,276 Reputation points
    2023-12-15T18:07:45.0966667+00:00

    Kevin Pearce Thanks for reaching out. As we have announced already (Opens in new window or tab), the legacy portal technically retired on October 31st, 2023. For some services, the legacy portal may still be available.

    On December 1st, 2023, the engineering team started disabling legacy portal for all services where usage of portal is not detected. For a service where legacy portal has been disabled, browsing to the legacy portal will return a "503 - Service Unavailable" message.

    Customers can enable/disable the Developer Portal (both new and legacy) using this REST API (Opens in new window or tab). Note that Legacy portal cannot be enabled by customers if it has been disabled by the engineering team at the service level. customers still have the option to request enabling the legacy portal by raising the support ticket.

    A PATCH call can be sent with the appropriate fields depending on which portal the customer is trying to enable or disable.

    Here is a sample REST call that shows how to disable the legacy portal on an existing API Management service

    PATCH https://management.azure.com/subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.ApiManagement/service/xxxx?api-version=2023-03-01-preview
Authorization: Bearer <<redacted>>
Content-type: application/json

{
  "properties": {
        "LegacyPortalStatus": "Disabled"
   }
}

    Enabling or disabling the legacy developer portal does not have any side effects that would alter any existing new portal functionality. The new developer portal and the legacy developer portal are separate applications that do not share any code or functionality.

    let me know incase of further queries, I would be happy to assist you.

    Please "Accept Answer" and "upvote" if the answer is helpful so that it can help others in the community.

0 additional answers

Sort by: Most helpful
Most helpful Newest Oldest

Your answer

Answers can be marked as Accepted Answers by the question author, which helps users to know the answer solved the author's problem.