| title | description | author | ms.service | ms.custom | ms.topic | ms.date | ms.author |
|---|---|---|---|---|---|---|---|
Migrate Azure API Management instance to stv2 platform | Microsoft Docs |
Find guidance to migrate your Azure API Management instance from the stv1 compute platform to the stv2 platform. Migration steps depend on whether the instance is injected in a VNet. |
dlepow |
api-management |
how-to |
03/14/2024 |
danlep |
[!INCLUDE api-management-availability-premium-dev-standard-basic]
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 migration scenarios, depending on whether or not your API Management instance is currently deployed (injected) in an external or internal VNet. Choose the migration guide for your scenario. Both scenarios migrate an existing instance in-place to the stv2 platform.
[!INCLUDE api-management-migration-alert]
-
Scenario 1: Migrate a non-VNet-injected API Management instance - Migrate your instance to the
stv2platform using the portal or the Migrate to stv2 REST API. -
Scenario 2: Migrate a VNet-injected API Management instance - Migrate your instance to the
stv2platform by updating the VNet configuration settings using the portal.
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.
:::image type="content" source="media/migrate-stv1-to-stv2/side-by-side.gif" alt-text="Diagram of in-place migration to a new subnet.":::
[!INCLUDE api-management-migration-support]
[!INCLUDE api-management-migration-related-content]