Migrate an API Management instance hosted on the stv1 platform to stv2

  • Article

APPLIES TO: Developer | Basic | Standard | Premium

Here we help you find guidance to migrate your API Management instance hosted on the stv1 compute platform to the newer stv2 platform. Find out if you need to do this.

There are two different in-place migration scenarios, depending on whether or not your API Management instance is currently deployed (injected) in a VNet. Choose the migration guide for your scenario.

Important

Support for API Management instances hosted on the stv1 platform is being retired. In global Azure, the retirement date is 31 August 2024. In Azure Government and in Azure operated by 21Vianet (Azure in China), the retirement date is 24 February 2025. If you have instances hosted on the stv1 platform, migrate them to the stv2 platform before the retirement date to avoid service disruptions.

In-place migration scenarios

Migrate your instance in-place to the stv2 platform using the Platform migration blade in the portal or the Migrate to stv2 REST API.

Alternative: Side-by-side deployment

While we strongly recommend using in-place migration to the stv2 platform, you can also choose to deploy a new stv2 instance side-by-side with your original API Management instance. Use API Management's backup and restore capabilities to back up your original instance and restore onto the new instance.

With side-by-side deployment, you can control the timing of deploying and verifying the new instance, whether to roll back (if needed) to the original instance, and when to decommission the original instance. This approach increases the costs because you run an additional instance for a period and requires more effort, but gives you full control over the migration process. For limitations and considerations, see A guide to creating a copy of an API Management instance.

The following image shows a high level overview of what happens during side-by-side migration.

Diagram of in-place migration to a new subnet.

Help and support

We're here to help you migrate to the stv2 platform with minimal disruptions to your services.

If you have questions, get fast answers from community experts in Microsoft Q&A. If you have a support plan and you need technical help, create a support request.

  1. For Summary, type a description of your issue, for example, "stv1 retirement".
  2. Under Issue type, select Technical.
  3. Under Subscription, select your subscription.
  4. Under Service, select My services, then select API Management Service.
  5. Under Resource, select the Azure resource that you’re creating a support request for.
  6. For Problem type, select Administration and Management.
  7. For Problem subtype, select Upgrade, Scale or SKU Changes.

Related content