Breyta

Deila með

How to move Azure API Management across regions

  • Grein

APPLIES TO: Developer | Basic | Standard | Premium

This article describes how to move an API Management instance to a different Azure region. You might move your instance to another region for many reasons. For example:

  • Locate your instance closer to your API consumers
  • Deploy features available in specific regions only
  • Meet internal policy and governance requirements

To move API Management instances from one Azure region to another, use the service's backup and restore operations. You can use a different API Management instance name or the existing name.

Note

API Management also supports multi-region deployment, which distributes a single Azure API management service across multiple Azure regions. Multi-region deployment helps reduce request latency perceived by geographically distributed API consumers and improves service availability if one region goes offline.

Considerations

  • Choose the same API Management pricing tier in the source and target regions.
  • Backup and restore won't work when migrating between different cloud types. For that scenario, export the resource as a template. Then, adapt the exported template for the target Azure region and re-create the resource.

Prerequisites

  • Review requirements and limitations of the API Management backup and restore operations.
  • See What is not backed up. Record settings and data that you will need to recreate manually after moving the instance.
  • Create a storage account in the source region. You will use this account to back up the source instance.

Prepare and move

Option 1: Use a different API Management instance name

  1. In the target region, create a new API Management instance with the same pricing tier as the source API Management instance. Use a different name for the new instance.
  2. Back up the existing API Management instance to the storage account.
  3. Restore the source instance's backup to the new API Management instance.
  4. If you have a custom domain pointing to the source region API Management instance, update the custom domain CNAME to point to the new API Management instance.

Option 2: Use the same API Management instance name

Warning

This option deletes the original API Management instance and results in downtime during the migration. Ensure that you have a valid backup before deleting the source instance.

  1. Back up the existing API Management instance to the storage account.
  2. Delete the API Management instance in the source region.
  3. Create a new API Management instance in the target region with the same name as the one in the source region.
  4. Restore the source instance's backup to the new API Management instance in the target region.

Verify

  1. Ensure that the restore operation completes successfully before accessing your API Management instance in the target region.
  2. Configure settings that are not automatically moved during the restore operation. Examples: virtual network configuration, managed identities, developer portal content, and custom domain and custom CA certificates.
  3. Access your API Management endpoints in the target region. For example, test your APIs, or access the developer portal.

Clean up source resources

If you moved the API Management instance using Option 1, after you successfully restore and configure the target instance, you may delete the source instance.

Next steps