Backing up API Manager settings, using Export Template or View as JSON to a supported secure location?

EnterpriseArchitect 4,866 Reputation points
2023-10-18T11:36:48.21+00:00

What is the best way to automate and securely store the API manager settings?

User's image

Using JSON View

or

User's image

Export Template

I need to backup all API manager settings in my subscriptions nightly to a secure location, I wonder if this can be automated with PowerShell or any other Azure function.

Like Private GitHub repository, Azure KeyVault or even Azure Storage Account file share?

Any help would be greatly appreciated.

Azure Key Vault
Azure Key Vault
An Azure service that is used to manage and protect cryptographic keys and other secrets used by cloud apps and services.
1,141 questions
Azure API Management
Azure API Management
An Azure service that provides a hybrid, multi-cloud management platform for APIs.
1,792 questions
PowerShell
PowerShell
A family of Microsoft task automation and configuration management frameworks consisting of a command-line shell and associated scripting language.
2,132 questions
0 comments No comments
{count} votes

1 answer

Sort by: Most helpful
  1. Sonny Gillissen 3,346 Reputation points
    2023-10-21T19:09:48.7966667+00:00

    Hi EnterpriseArchitect ,

    Thank you for reaching out on Microsoft Q&A!

    I would advise you to use the ‘export template’ functionality, as this contains your entire API Management service. The advantage of this option in favor of JSON view is the fact that JSON view is usable within your APIM, whereas an exported template could also be used to redeploy your entire APIM (in case of).

    Please refer to the documentation below on the PowerShell equivalent of the ‘export template’ button in the Portal:

    https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/export-template-powershell

    And for deploying again:

    https://harvestingclouds.com/post/step-by-step-arm-templates-deploying-template-using-azure-powershell/

    Please click “Accept answer” if you find this helpful. Feel free to drop additional queries in the comments below!

    Kind regards,

    Sonny