Merge pull request #276203 from ShawnJackson/migrate-api-mgt

ktoliver · web-flow · commit 3717cbd38361 · 2024-06-11T09:45:30.000-07:00
[AQ] edit pass: migrate-api-mgt
diff --git a/articles/reliability/migrate-api-mgt.md b/articles/reliability/migrate-api-mgt.md
@@ -1,6 +1,6 @@
 ---
-title: Migrate Azure API Management to availability zone support
-description: Learn how to migrate your Azure API Management instances to availability zone support.
+title: Migrate Azure API Management to availability zones
+description: Learn how to migrate your Azure API Management instances to availability zones for zone redundancy.
 author: shaunjacob 
 ms.service: api-management
 ms.topic: how-to
@@ -10,127 +10,126 @@ ms.custom: references_regions, subject-reliability
 
 ---
 
-# Migrate Azure API Management to availability zone support
+# Migrate Azure API Management to availability zones
 
-This guide describes how to enable availability zone support for your API Management instance. The API Management service supports [Zone redundancy](../reliability/availability-zones-overview.md), which provides resiliency and high availability to a service instance in a specific Azure region. With zone redundancy, the gateway and the control plane of your API Management instance (Management API, developer portal, Git configuration) are replicated across datacenters in physically separated zones, making it resilient to a zone failure.
+The Azure API Management service supports [zone redundancy](../reliability/availability-zones-overview.md), which provides resiliency and high availability to a service instance in a specific Azure region. With zone redundancy, the gateway and the control plane of your API Management instance (management API, developer portal, Git configuration) are replicated across datacenters in physically separated zones, so they're resilient to a zone failure.
 
-In this article, we'll take you through the different options for availability zone migration. For background about configuring API Management for high availability, see [Ensure API Management availability and reliability](../api-management/high-availability.md).
+This article describes four options for migrating an API Management instance to availability zones. For background about configuring API Management for high availability, see [Ensure API Management availability and reliability](../api-management/high-availability.md).
 
 ## Prerequisites
 
-* To configure API Management for zone redundancy, your instance must be in one of the Azure regions with [availability zone support](availability-zones-service-support.md#azure-regions-with-availability-zone-support).
+* To configure API Management for zone redundancy, your instance must be in one of the [Azure regions that support availability zones](availability-zones-service-support.md#azure-regions-with-availability-zone-support).
 
-* If you haven't yet created an API Management service instance, see [Create an API Management service instance](../api-management/get-started-create-service-instance.md). Select the Premium service tier.
+* If you don't have an API Management instance, create one by following the [Create a new Azure API Management instance by using the Azure portal](../api-management/get-started-create-service-instance.md) quickstart. Select the Premium service tier.
 
-* API Management service must be in the Premium tier. If it isn't, you can [upgrade](../api-management/upgrade-and-scale.md#change-your-api-management-service-tier) to the Premium tier.
+* If you have an existing API Management instance, make sure that it's in the Premium tier. If it isn't, [upgrade to the Premium tier](../api-management/upgrade-and-scale.md#change-your-api-management-service-tier).
 
-* If your API Management instance is deployed (injected) in a [Azure virtual network (VNet)](../api-management/api-management-using-with-vnet.md), check the version of the [compute platform](../api-management/compute-infrastructure.md) (stv1 or stv2) that hosts the service.
+* If your API Management instance is deployed (injected) in an [Azure virtual network](../api-management/api-management-using-with-vnet.md), check the version of the [compute platform](../api-management/compute-infrastructure.md) (`stv1` or `stv2`) that hosts the service.
 
 ## Downtime requirements
 
 There are no downtime requirements for any of the migration options.
 
 ## Considerations
 
-* Changes can take from 15 to 45 minutes to apply. The API Management gateway can continue to handle API requests during this time.
+* Changes can take 15 to 45 minutes to apply. The API Management gateway can continue to handle API requests during this time.
 
-* When migrating an API Management deployed in an external or internal virtual network to availability zones, a new public IP address resource must be specified. In an internal VNet, the public IP address is used only for management operations, not for API requests. Learn more about [IP addresses of API Management](../api-management/api-management-howto-ip-addresses.md). 
+* When you're migrating an API Management instance that's deployed in an external or internal virtual network to availability zones, you must specify a new public IP address resource. In an internal virtual network, the public IP address is used only for management operations, not for API requests. [Learn more about IP addresses of API Management](../api-management/api-management-howto-ip-addresses.md).
 
-* Migrating to availability zones or changing the availability zone configuration will trigger a public [IP address change](../api-management/api-management-howto-ip-addresses.md#changes-to-the-ip-addresses).
+* Migrating to availability zones or changing the configuration of availability zones triggers a public [IP address change](../api-management/api-management-howto-ip-addresses.md#changes-to-the-ip-addresses).
 
-* When enabling availability zones in a region, you configure a number of API Management scale [units](../api-management/upgrade-and-scale.md) that can be distributed evenly across the zones. For example, if you configure 2 zones, you could configure 2 units, 4 units, or another multiple of 2 units. Adding units incurs additional costs. For details, see [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/).
+* When you're enabling availability zones in a region, you configure API Management scale [units](../api-management/upgrade-and-scale.md) that you can distribute evenly across the zones. For example, if you configure two zones, you can configure two units, four units, or another multiple of two units.
 
-* If you've configured autoscaling for your API Management instance in the primary location, you might need to adjust your autoscale settings after enabling zone redundancy. The number of API Management units in autoscale rules and limits must be a multiple of the number of zones.
+  Adding units incurs additional costs. For details, see [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/).
 
-## Option 1: Migrate existing location of API Management instance, not injected in VNet
+* If you configured autoscaling for your API Management instance in the primary location, you might need to adjust your autoscale settings after enabling zone redundancy. The number of API Management units in autoscale rules and limits must be a multiple of the number of zones.
 
-Use this option to migrate an existing location of your API Management instance to availability zones when it’s not injected (deployed) in a virtual network.
+## Existing gateway location not injected in a virtual network
 
-1.	In the Azure portal, navigate to your API Management service.
+To migrate an existing location of your API Management instance to availability zones when the instance is not injected in a virtual network:
 
-1.	Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
+1. In the Azure portal, go to your API Management instance.
 
-1.	Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
+1. On the **Deployment + infrastructure** menu, select **Locations**.
 
-1.	In **Availability zones**, select one or more zones. The number of units selected must be distributed evenly across the availability zones. For example, if you selected 3 units, select 3 zones so that each zone hosts one unit.
+1. In the **Location** box, select the location to be migrated. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
 
-1.	Select **Apply**, and then select **Save**.
+1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
 
-     :::image type="content" alt-text="Screenshot of how to migrate existing location of API Management instance not injected in VNet." source ="media/migrate-api-mgt/option-one-not-injected-in-vnet.png":::
-    
+1. In the **Availability zones** box, select one or more zones. The number of units that you selected must be distributed evenly across the availability zones. For example, if you selected three units, select three zones so that each zone hosts one unit.
 
+1. Select **Apply**, and then select **Save**.
 
-## Option 2: Migrate existing location of API Management instance (stv1 platform), injected in VNet
+:::image type="content" alt-text="Screenshot that shows selections for migrating an existing location of API Management instance that's not injected in a virtual network." source ="media/migrate-api-mgt/option-one-not-injected-in-vnet.png":::
 
-Use this option to migrate an existing location of your API Management instance to availability zones when it is currently injected (deployed) in a virtual network. The following steps are needed when the API Management instance is currently hosted on the stv1 platform. Migrating to availability zones will also migrate the instance to the stv2 platform.
+## Existing gateway location (stv1 platform) injected in a virtual network
 
-1.	Create a new subnet and public IP address in location to migrate to availability zones. Detailed requirements are in [virtual networking guidance](../api-management/api-management-using-with-vnet.md?tabs=stv2#prerequisites).
+To migrate an existing location of your API Management instance to availability zones when the instance is currently injected in a virtual network and is currently hosted on the `stv1` platform, use the following steps. Migrating to availability zones also migrates the instance to the `stv2` platform.
 
-1.	In the Azure portal, navigate to your API Management service.
+1. Create a new subnet and public IP address in the location to migrate to availability zones. Detailed requirements are in the [virtual networking guidance](../api-management/api-management-using-with-vnet.md?tabs=stv2#prerequisites).
 
-1.	Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
+1. In the Azure portal, go to your API Management instance.
 
-1.	Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
+1. On the **Deployment + infrastructure** menu, select **Locations**.
 
-1.	In **Availability zones**, select one or more zones. The number of units selected must be distributed evenly across the availability zones. For example, if you selected 3 units, select 3 zones so that each zone hosts one unit.
+1. In the **Location** box, select the location to be migrated. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
 
-1.	Select the new subnet and new public IP address in the location. 
+1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
 
-1.	Select **Apply**, and then select **Save**.
+1. In the **Availability zones** box, select one or more zones. The number of units that you selected must be distributed evenly across the availability zones. For example, if you selected three units, select three zones so that each zone hosts one unit.
 
+1. In the respective boxes under **Network**, select the new subnet and new public IP address in the location.
 
-     :::image type="content" alt-text="Screenshot of how to migrate existing location of API Management instance injected in VNet." source ="media/migrate-api-mgt/option-two-injected-in-vnet.png":::
+1. Select **Apply**, and then select **Save**.
 
-## Option 3: Migrate existing location of API Management instance (stv2 platform), injected in VNet
+:::image type="content" alt-text="Screenshot that shows selections for migrating an existing location of an API Management instance that's injected in a virtual network." source ="media/migrate-api-mgt/option-two-injected-in-vnet.png":::
 
-Use this option to migrate an existing location of your API Management instance to availability zones when it is currently injected (deployed) in a virtual network. The following steps are used when the API Management instance is already hosted on the stv2 platform.
+## Existing gateway location (stv2 platform) injected in a virtual network
 
-1.	Create a new subnet and public IP address in location to migrate to availability zones. Detailed requirements are in [virtual networking guidance](../api-management/api-management-using-with-vnet.md?tabs=stv2#prerequisites).
+To migrate an existing location of your API Management instance to availability zones when the instance is currently injected in a virtual network and is already hosted on the `stv2` platform:
 
-1.	In the Azure portal, navigate to your API Management service.
+1. Create a new subnet and public IP address in the location to migrate to availability zones. Detailed requirements are in the [virtual networking guidance](../api-management/api-management-using-with-vnet.md?tabs=stv2#prerequisites).
 
-1.	Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
+1. In the Azure portal, go to your API Management instance.
 
-1.	Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
+1. On the **Deployment + infrastructure** menu, select **Locations**.
 
-1.	In **Availability zones**, select one or more zones. The number of units selected must be distributed evenly across the availability zones. For example, if you selected 3 units, select 3 zones so that each zone hosts one unit.
+1. In the **Location** box, select the location to be migrated. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
 
-1.	Select the new public IP address in the location. 
+1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
 
-1.	Select **Apply**, and then select **Save**.
+1. In the **Availability zones** box, select one or more zones. The number of units that you selected must be distributed evenly across the availability zones. For example, if you selected three units, select three zones so that each zone hosts one unit.
 
-     :::image type="content" alt-text="Screenshot of how to migrate existing location of API Management instance (stv2 platform) injected in VNet." source ="media/migrate-api-mgt/option-three-stv2-injected-in-vnet.png":::
+1. In the **Public IP Address** box, select the new public IP address in the location.
 
-## Option 4. Add new location for API Management instance (with or without VNet) with availability zones
+1. Select **Apply**, and then select **Save**.
 
-Use this option to add a new location to your API Management instance and enable availability zones in that location. 
+:::image type="content" alt-text="Screenshot that shows selections for migrating an existing location of an API Management instance (stv2 platform) that's injected in a virtual network." source ="media/migrate-api-mgt/option-three-stv2-injected-in-vnet.png":::
 
-If your API Management instance is deployed in a virtual network in the primary location, ensure that you set up a [virtual network](../api-management/api-management-using-with-vnet.md?tabs=stv2), subnet, and public IP address in any new location where you plan to enable zone redundancy.
+## New gateway location
 
-1.	In the Azure portal, navigate to your API Management service.
+To add a new location to your API Management instance and enable availability zones in that location:
 
-1.	Select **+ Add** in the top bar to add a new location. The location must [support availability zones](#prerequisites).
+1. If your API Management instance is deployed in a virtual network in the primary location, set up a [virtual network](../api-management/api-management-using-with-vnet.md?tabs=stv2), subnet, and public IP address in any new location where you plan to enable zone redundancy.
 
-1.	Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
+1. In the Azure portal, go to your API Management instance.
 
-1.	In **Availability zones**, select one or more zones. The number of units selected must be distributed evenly across the availability zones. For example, if you selected 3 units, select 3 zones so that each zone hosts one unit.
+1. On the **Deployment + infrastructure** menu, select **Locations**.
 
-1. If your API Management instance is deployed in a [virtual network](../api-management/api-management-using-with-vnet.md?tabs=stv2), select the virtual network, subnet, and public IP address that are available in the location. 
+1. Select **+ Add** to add a new location. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
 
-1. Select **Add**, and then select **Save**.
-
-     :::image type="content" alt-text="Screenshot of how to add new location for API Management instance with or without VNet." source ="media/migrate-api-mgt/option-four-add-new-location.png":::
+1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
 
-## Next steps
+1. In the **Availability zones** box, select one or more zones. The number of units that you selected must be distributed evenly across the availability zones. For example, if you selected three units, select three zones so that each zone hosts one unit.
 
-Learn more about:
+1. If your API Management instance is deployed in a virtual network, use the boxes under **Network** to select the virtual network, subnet, and public IP address that are available in the location.
 
-> [!div class="nextstepaction"]
-> [Deploying an Azure API Management service instance to multiple Azure regions](../api-management/api-management-howto-deploy-multi-region.md).
+1. Select **Add**, and then select **Save**.
 
-> [!div class="nextstepaction"]
-> [Building for reliability](/azure/architecture/framework/resiliency/app-design) in Azure.
+:::image type="content" alt-text="Screenshot that shows selections for adding a new location for an API Management instance with or without a virtual network." source ="media/migrate-api-mgt/option-four-add-new-location.png":::
 
-> [!div class="nextstepaction"]
-> [Azure services and regions that support availability zones](availability-zones-service-support.md)
+## Related content
 
+* [Deploy an Azure API Management instance to multiple Azure regions](../api-management/api-management-howto-deploy-multi-region.md)
+* [Design review checklist for reliability](/azure/architecture/framework/resiliency/app-design)
+* [Azure services and regions that support availability zones](availability-zones-service-support.md)
