Legacy portal deprecation
If you have questions, comments, or concerns related to deprecation of the old developer portal, please post them here.
Aggregate:
- Concerns around a possibility of breaking existing DevOps pipelines
- Disabling the old portal in API Management service
- VNET configuration changes
Is there a timeline for deprecation, i.e. months or a year after GA?
@dcbrown16 - not at this moment. Any concerns whether it's for example 6 months vs 1 year?
@mikebudzynski I'm checking in for a customer in Japan through support. They don't have any particular requests regarding the period, as long as it is announced clearly. Thanks!
We have some additional detailed questions:
- Are there any changes in the network configuration required for API Management instances in virtual networks (internal or external) when switching from the old to new portal?
- Do we specifically know what notifications will be provided to users when deprecation is determined/approaching? Documents/Portal notifications/emails (to whom)?
@dcbrown16 Thanks, good points. Just to clarify - there won't be an automatic switch to the new version. It's a manual process to configure the new portal in a similar manner to the old one, as indicated here: https://docs.microsoft.com/azure/api-management/api-management-howto-developer-portal#faq
- Yes, VNET configuration needs to be modified. We're working on clear documentation on this subject.
- API Management updates are posted here: http://aka.ms/apimupdates We'll consider sending emails as well.
Once the new developer portal is GA, how do we disable the legacy developer portal explicitly if we wanted to? Say for instance that we wanted to avoid having 2 locations for documentation, and instead simply migrate exclusively to the new portal. Im wondering if this is an option.
This will be possible after GA - probably a few months after the release.
A workaround in the meantime would be to use the Application Gateway with API Management in VNET and not expose the old developer portal to the public.
thank you @mikebudzynski , Im happy to hear this will be supported after GA. Thank you as well for the secondary idea for isolating the old developer portal from public.
Hello, Currently, we are building our new API Product which will be released at the end of 2019. Here, we do have a dilemma.:
- Having in mind that MS plans to launch the GA version at the end of the year and we plan to launch our API platform at the same time, what your general advice would be for customizing/and preparing dev portal? Should we develop our Dev Portal based on New Dev Portal or should we go with both?
Many thanks, Donatas
@DonatasMaz
Having in mind that MS plans to launch the GA version at the end of the year and we plan to launch our API platform at the same time, what your general advice would be for customizing/and preparing dev portal? Should we develop our Dev Portal based on New Dev Portal or should we go with both?
We plan to have a production-ready version of the portal in mid-November and the new version will include significant changes to the widgets (some are already there) and default content and structure. If this timeline works for you, I suggest that you hold off until then and go with the new developer portal - especially because there won't be an automated migration between the old and the new portals.
Any idea on timing of the old portal deprecation? It would be good to know for planning purposes. We would prefer at least 8 months notice - 12 months preferred.
The deprecation plans are not finalized yet. Any deprecation will be announced at least 6 month in advance
What are the migration steps to convert an existing APIM instance to use the new dev portal? Or does a new APIM instance have to be created at this time as a replacement?
What are the migration steps to convert an existing APIM instance to use the new dev portal? Or does a new APIM instance have to be created at this time as a replacement?
https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal#how-can-i-migrate-from-the-old-developer-portal-to-the-new-developer-portal No need to recreate API Management service.
Hi Mike, thanks for all the work on the new Developer Portal! Do you have a timeline for enabling social login providers for sign-up and sign-in? I've noticed you have a card titled "[Later] Sign in/up with online identity providers", is it planned in the short-term? We came to rely on Google for sign in since AD is not supported in some tiers of the API Management.
@ilyabelkin That's valuable feedback, thanks for sharing it. We don't have a timeline yet, but we'll prioritize this work item; I'll update you once we know more. Realistically, we can aim at January/February.
Thank you Mike, please don't deprecate the old portal before you implement this!
We're not deprecating the old portal yet and any deprecation will be announced more than 6 months in advance.
In the new portal, the "Try it" functionality seems more limited compared to the "legacy" portal: I couldn't find a way to test authorization for example.
Another problem I've found, related to authorization also on the legacy portal, but couldn't find any place to report it: when doing the authorization once I select my configured Oauth2 from the dropdown, in the token I get in the end, the aud (audience) value gets prepended with the domain of the AAD. My WebApi is configured with the ApplicationID as Audience, and checks are made against this one. When authorizing with the developer portal, the Audience value is https://tenant.onmicrosoft.com/ApplicationID and this causes the token validation to fail.
So, are there any plans to match the capabilities of the new portal with the old one and have ability to test authorization also? And where can I report the issue with the authorization token audience value in the legacy portal? (and if it is an issue?)
In the new portal, the "Try it" functionality seems more limited compared to the "legacy" portal: I couldn't find a way to test authorization for example.
If you mean OAuth - it's a duplicate of #208
And where can I report the issue with the authorization token audience value in the legacy portal?
Please open a separate issue here and we'll triage it accordingly.
Will samples be still available in the new API Details page?
@ngobw, representation and code samples are there already. You need to click on the "Try it" button. Is there anything in particular that's missing?
@mikebudzynski, Any idea on by when we should switch to new developer portal to avoid service interruption?
We may need at least 12 months from now to customize and roll out to new developer portal to our customers.
@mikebudzynski, Any idea on by when we should switch to new developer portal to avoid service interruption? We may need at least 12 months from now to customize and roll out to new developer portal to our customers.
We haven't announced the legacy portal deprecation and after we announce it, you'll have at least one year to migrate to the new portal. Please, monitor this thread or aka.ms/apimupdates for updates.
However, be aware that the legacy portal won't be receiving new features. We recommend using the new portal, especially if you'd like to benefit from its extended capabilities.
Hi @mikebudzynski, Hope you are doing well! Do we have any latest update till when the Developer porta(legacy) will be supported from the mS azure side? Also, I have a simple web application hosted on legacy one currently. I want it to migrate it to new Developer portal entirely. How to achieve this?. Do we have some configuration changes to be done for the new one?. Also since I am only the developer, and am not even knowing where the current legacy application backend/db part is managed, Please suggest how to handle this. Any documentation/support aprreciated.The application is developed in HTML, CSS, VueJS, Templates, JavaScript. Thanks in advance.
-
No updates on the deprecation timeline.
-
I have a simple web application hosted on legacy one currently
Sorry, I don't understand this part. Your APIs are managed through API Management, so whatever they are, they will also be displayed in the new portal. You need to redo all customizations in the new portal manually. I suggest that you contact Azure support for assistance.
I have a simple web application hosted on legacy one currently
Sorry, I don't understand this part. Your APIs are managed through API Management, so whatever they are, they will also be displayed in the new portal. You need to redo all customizations in the new portal manually. I suggest that you contact Azure support for assistance.
Thank you @mikebudzynski for your answer. Do we have any specific documentation that helps in migration of the existing legacy version application to developer potal latest version end to end?
Thank you @mikebudzynski for your answer. Do we have any specific documentation that helps in migration of the existing legacy version application to developer potal latest version end to end?
You need to redo the customizations and content in the new portal - there's no workarounds. You can learn how to do it by following this tutorial: https://aka.ms/apimdocs/customizeportal The new portal will automatically have the same users accounts, APIs, Products etc. as the legacy portal.
to be honest, I like the new developer portal style and love the on-page designer, but so far it nearly covers 50% of the functionality of the current aka legacy one. And there are some bug which does not allow production use and as well there are some important features missing.
Hi @fsettele, do you mind listing all the features you specifically need from the legacy portal?