Skip to content

Commit 3a52234

Browse files
authored
Merge pull request #299633 from dlepow/pv2mr
[APIM] Misc updates for Automatic AZ setting and stv1 retirement
2 parents 6efeaaf + 604438a commit 3a52234

File tree

5 files changed

+18
-39
lines changed

5 files changed

+18
-39
lines changed
12.3 KB
Loading
18.2 KB
Loading
10.2 KB
Loading
Binary file not shown.

articles/reliability/migrate-api-mgt.md

Lines changed: 18 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to migrate your Azure API Management instances to availab
44
author: shaunjacob
55
ms.service: azure-api-management
66
ms.topic: how-to
7-
ms.date: 10/16/2024
7+
ms.date: 05/09/2025
88
ms.author: anaharris
99
ms.custom: subject-reliability
1010

@@ -18,38 +18,39 @@ The Azure API Management service supports [availability zones](../reliability/av
1818

1919
* **Zone-redundant** - the gateway and the control plane of your API Management instance (management API, developer portal, Git configuration) are replicated across two or more physically separated zones within an Azure region. Zone redundancy provides resiliency and high availability to a service instance.
2020

21-
This article describes four scenarios for migrating an API Management instance to availability zones. For more information about configuring API Management for high availability, see [Ensure API Management availability and reliability](../api-management/high-availability.md).
21+
This article describes three scenarios for migrating an API Management instance to availability zones. For more information about configuring API Management for high availability, see [Ensure API Management availability and reliability](../api-management/high-availability.md).
2222

2323
[!INCLUDE [api-management-service-update-behavior](../../includes/api-management-service-update-behavior.md)]
2424

2525
## Prerequisites
2626

2727
* To configure availability zones for API Management, your instance must be in one of the [Azure regions that support availability zones](regions-list.md).
2828

29-
* 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.
29+
* 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.
3030

31-
* 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).
31+
* 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).
3232

3333

3434
## Downtime requirements
3535

36-
There are no downtime requirements for any of the migration options.
36+
There are no gateway downtime requirements for any of the migration options.
3737

3838
## Considerations
3939

40-
* Changes can take 15 to 45 minutes to apply. The API Management gateway can continue to handle API requests during this time.
41-
4240
* When you're migrating an API Management instance that's deployed in an external or internal virtual network to availability zones, you can optionally 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).
4341

4442
* Migrating to availability zones or changing the configuration of availability zones triggers a public and private [IP address change](../api-management/api-management-howto-ip-addresses.md#changes-to-the-ip-addresses).
4543

46-
* 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.
44+
* By default, API Management sets availability zones automatically to distribute your scale [units](../api-management/upgrade-and-scale.md) and adjust to changes in zone availability in the region. If you select specific zones, make sure the scale units distribute evenly across the zones. For example, if you select two specific zones, you can configure two units, four units, or another multiple of two units.
45+
46+
>[!IMPORTANT]
47+
>If you select specific zones, your resources will be pinned to those zones. Should all your resources in the selected zones become unavailable, your API Management instance will be unavailable.
4748
4849
[!INCLUDE [api-management-az-notes](../../includes/api-management-az-notes.md)]
4950

50-
* If you configured autoscaling for your API Management instance in the primary location, you might need to adjust your autoscale settings after configuring availability zones. The number of API Management units in autoscale rules and limits must be a multiple of the number of zones.
51+
* If you configured autoscaling for your API Management instance in the primary location, you might need to adjust your autoscale settings after selecting availability zones. If you select specific zones, the number of API Management units in autoscale rules and limits must be a multiple of the number of zones.
5152

52-
## Existing gateway location not injected in a virtual network
53+
## Existing gateway location not injected in a virtual network
5354

5455
To migrate an existing location of your API Management instance to availability zones when the instance is not injected in a virtual network:
5556

@@ -61,37 +62,15 @@ To migrate an existing location of your API Management instance to availability
6162

6263
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
6364

64-
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.
65+
1. In the **Availability zones** box, leave the **Automatic** setting (recommended), or optionally select one or more zones. If you select specific zones, the number of units that you selected must distribute evenly across the availability zones. For example, if you selected three units, you would select three zones so that each zone hosts one unit.
6566

6667
1. Select **Apply**, and then select **Save**.
6768

6869
:::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":::
6970

70-
## Existing gateway location (stv1 platform) injected in a virtual network
71-
72-
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.
73-
74-
1. Create a new subnet and optional 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).
75-
76-
1. In the Azure portal, go to your API Management instance.
77-
78-
1. On the **Deployment + infrastructure** menu, select **Locations**.
79-
80-
1. In the **Location** box, select the location to be migrated. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
81-
82-
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
83-
84-
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.
85-
86-
1. In the respective boxes under **Network**, select the new subnet and optional public IP address in the location.
87-
88-
1. Select **Apply**, and then select **Save**.
89-
90-
:::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":::
91-
92-
## Existing gateway location (stv2 platform) injected in a virtual network
71+
## Existing gateway location injected in a virtual network
9372

94-
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:
73+
To migrate an existing location of your API Management instance to availability zones when the instance is currently injected in a virtual network:
9574

9675
1. In the Azure portal, go to your API Management instance.
9776

@@ -101,19 +80,19 @@ To migrate an existing location of your API Management instance to availability
10180

10281
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
10382

104-
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.
83+
1. In the **Availability zones** box, leave the **Automatic** setting (recommended), or optionally select one or more zones. If you select specific zones, the number of units that you selected must distribute evenly across the availability zones. For example, if you selected three units, you would select three zones so that each zone hosts one unit.
10584

10685
1. In the **Public IP Address** box, optionally select a public IP address in the location.
10786

10887
1. Select **Apply**, and then select **Save**.
10988

110-
:::image type="content" alt-text="Screenshot that shows selections to migrate existing location of API Management instance (stv2 platform) that's injected in a virtual network." source ="media/migrate-api-mgt/option-three-stv2-injected-in-vnet.png":::
89+
:::image type="content" alt-text="Screenshot that shows selections to migrate existing location of API Management instance that's injected in a virtual network." source ="media/migrate-api-mgt/option-three-stv2-injected-in-vnet.png":::
11190

11291
## New gateway location
11392

11493
To add a new location to your API Management instance and enable availability zones in that location:
11594

116-
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 optional public IP address in any new location where you plan to enable availability zones.
95+
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), subnet, and optional public IP address in any new location where you plan to enable availability zones.
11796

11897
1. In the Azure portal, go to your API Management instance.
11998

@@ -123,7 +102,7 @@ To add a new location to your API Management instance and enable availability zo
123102

124103
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
125104

126-
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.
105+
In the **Availability zones** box, leave the **Automatic** setting (recommended), or optionally select one or more zones. If you select specific zones, the number of units that you selected must distribute evenly across the availability zones. For example, if you selected three units, you would select three zones so that each zone hosts one unit.
127106

128107
1. If your API Management instance is deployed in a virtual network, use the boxes under **Network** to select the virtual network, subnet, and optional public IP address that are available in the location.
129108

0 commit comments

Comments
 (0)