Save customisation of the Azure APIM Developer portal as a template?

Question

Hello! We are creating a deployment of an API Management that will involve a customised appearance of the new developer portal. However these customisations (background colour, title, logos etc) are lost whenever the API management is destroyed and recreated. My question is, is there any way to save the changes made to the developer portal when deleting and recreating the API Management? Or a way of saving a "template" of the customised dev portal, which can then be imported onto a newly created API Management. It is the hassle to have to change the appearance of the dev portal and I can't believe there isn't some way of saving these changes in the scenario the API Management needs to be recreated.

Ideally the changes to the dev portal can be saved and passed over to a new API management, a way to store this "template" in terraform would be the best...

Many thanks!

Answer 1

@Rob Wilson Thank you for reaching out to Microsoft Q&A. I assume you are performing the customization on the managed developer portal (not self-hosted).

Have you explored migration script in our docs: https://learn.microsoft.com/en-us/azure/api-management/automate-portal-deployments? This script relies on multiple other scripts underneath and perform steps like copying portal's content such as customizations, configuration etc., copying media files such as images (stored in azure blob storage) etc. from one service to other. Please note, things like users, user groups etc. aren't captured as part of this. Based on your scenario, you can just use the backup part, skip the upload to destination service and then configure to run in your CI/CD pipeline. If you have any questions on this, let me know. I am happy to help :).

Unfortunately, there is no option to save as a template and I recommend you share feedback in aka.ms/apimwish so that others can upvote on it for our product team to take it forward.

I hope this answers your question and feel free to add if you have any questions.