You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/reliability/migrate-api-mgt.md
+18-42Lines changed: 18 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn how to migrate your Azure API Management instances to availab
4
4
author: shaunjacob
5
5
ms.service: azure-api-management
6
6
ms.topic: how-to
7
-
ms.date: 10/16/2024
7
+
ms.date: 05/09/2025
8
8
ms.author: anaharris
9
9
ms.custom: subject-reliability
10
10
@@ -18,38 +18,39 @@ The Azure API Management service supports [availability zones](../reliability/av
18
18
19
19
***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.
20
20
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).
* To configure availability zones for API Management, your instance must be in one of the [Azure regions that support availability zones](regions-list.md).
28
28
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.
30
30
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).
32
32
33
33
34
34
## Downtime requirements
35
35
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.
37
37
38
38
## Considerations
39
39
40
-
* Changes can take 15 to 45 minutes to apply. The API Management gateway can continue to handle API requests during this time.
41
-
42
40
* 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).
43
41
44
42
* 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).
45
43
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.
* 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.
51
52
52
-
## Existing gateway location not injected in a virtual network
53
+
## Existing gateway location not injected in a virtual network
53
54
54
55
To migrate an existing location of your API Management instance to availability zones when the instance is not injected in a virtual network:
55
56
@@ -61,40 +62,15 @@ To migrate an existing location of your API Management instance to availability
61
62
62
63
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
63
64
64
-
1. In the **Availability zones** box, select *Automatic*.
65
-
66
-
>[!IMPORTANT]
67
-
>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.
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.
68
66
69
67
1. Select **Apply**, and then select **Save**.
70
68
71
69
:::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":::
72
70
73
-
## Existing gateway location (stv1 platform) injected in a virtual network
74
-
75
-
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.
76
-
77
-
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).
78
-
79
-
1. In the Azure portal, go to your API Management instance.
80
-
81
-
1. On the **Deployment + infrastructure** menu, select **Locations**.
82
-
83
-
1. In the **Location** box, select the location to be migrated. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
84
-
85
-
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
86
-
87
-
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.
88
-
89
-
1. In the respective boxes under **Network**, select the new subnet and optional public IP address in the location.
90
-
91
-
1. Select **Apply**, and then select **Save**.
92
-
93
-
:::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":::
94
-
95
-
## Existing gateway location (stv2 platform) injected in a virtual network
71
+
## Existing gateway location injected in a virtual network
96
72
97
-
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:
98
74
99
75
1. In the Azure portal, go to your API Management instance.
100
76
@@ -104,19 +80,19 @@ To migrate an existing location of your API Management instance to availability
104
80
105
81
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
106
82
107
-
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.
108
84
109
85
1. In the **Public IP Address** box, optionally select a public IP address in the location.
110
86
111
87
1. Select **Apply**, and then select **Save**.
112
88
113
-
:::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":::
114
90
115
91
## New gateway location
116
92
117
93
To add a new location to your API Management instance and enable availability zones in that location:
118
94
119
-
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.
120
96
121
97
1. In the Azure portal, go to your API Management instance.
122
98
@@ -126,7 +102,7 @@ To add a new location to your API Management instance and enable availability zo
126
102
127
103
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
128
104
129
-
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.
130
106
131
107
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.
0 commit comments