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
# Migrate Azure API Management to availability zone support
13
+
# Migrate Azure API Management to availability zones
14
14
15
-
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.
15
+
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, so they're resilient to a zone failure.
16
16
17
-
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).
17
+
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).
18
18
19
19
## Prerequisites
20
20
21
21
* 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).
22
22
23
-
* 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.
23
+
* 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.
24
24
25
-
* 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.
25
+
*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).
26
26
27
-
* 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.
27
+
* 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.
28
28
29
29
## Downtime requirements
30
30
@@ -34,103 +34,94 @@ There are no downtime requirements for any of the migration options.
34
34
35
35
* Changes can take from 15 to 45 minutes to apply. The API Management gateway can continue to handle API requests during this time.
36
36
37
-
* 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).
37
+
* When you're migrating an API Management instance 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).
38
38
39
-
* 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).
39
+
* Migrating to availability zones or changing the availability zone configuration triggers a public [IP address change](../api-management/api-management-howto-ip-addresses.md#changes-to-the-ip-addresses).
40
40
41
-
* 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/).
41
+
* 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 could configure two units, four units, or another multiple of two units.
42
42
43
-
* 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.
43
+
Adding units incurs additional costs. For details, see [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/).
44
44
45
-
## Option 1: Migrate existing location of API Management instance, not injected in VNet
45
+
* 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.
46
46
47
-
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.
47
+
## Migrate an existing location of an API Management instance that's not injected in a virtual network
48
48
49
-
1. In the Azure portal, navigate to your API Management service.
49
+
To migrate an existing location of your API Management instance to availability zones when it's not injected in a virtual network:
50
50
51
-
1. Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
51
+
1. In the Azure portal, go to your API Management service.
52
52
53
-
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
53
+
1.Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
54
54
55
-
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.
55
+
1. Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
56
56
57
-
1. Select **Apply**, and then select **Save**.
57
+
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.
58
58
59
-
:::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":::
60
-
59
+
1. Select **Apply**, and then select **Save**.
61
60
61
+
:::image type="content" alt-text="Screenshot of how to migrate existing location of API Management instance not injected in a virtual network." source ="media/migrate-api-mgt/option-one-not-injected-in-vnet.png":::
62
62
63
-
## Option 2: Migrate existing location of API Management instance (stv1 platform), injected in VNet
63
+
## Migrate an existing location of API Management instance (stv1 platform) that's injected in a virtual network
64
64
65
-
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.
65
+
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 will also migrate the instance to the stv2 platform.
66
66
67
-
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).
67
+
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).
68
68
69
-
1.In the Azure portal, navigate to your API Management service.
69
+
1.In the Azure portal, go to your API Management service.
70
70
71
-
1.Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
71
+
1.Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
72
72
73
-
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
73
+
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
74
74
75
-
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.
75
+
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.
76
76
77
-
1.Select the new subnet and new public IP address in the location.
77
+
1.Select the new subnet and new public IP address in the location.
78
78
79
-
1.Select **Apply**, and then select **Save**.
79
+
1.Select **Apply**, and then select **Save**.
80
80
81
+
:::image type="content" alt-text="Screenshot of how to migrate existing location of API Management instance injected in a virtual network." source ="media/migrate-api-mgt/option-two-injected-in-vnet.png":::
81
82
82
-
:::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":::
83
+
## Migrate an existing location of an API Management instance (stv2 platform) that's injected in a virtual network
83
84
84
-
## Option 3: Migrate existing location of API Management instance (stv2 platform), injected in VNet
85
+
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:
85
86
86
-
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.
87
+
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).
87
88
88
-
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).
89
+
1. In the Azure portal, go to your API Management service.
89
90
90
-
1. In the Azure portal, navigate to your API Management service.
91
+
1. Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
91
92
92
-
1.Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
93
+
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
93
94
94
-
1. Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
95
+
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.
95
96
96
-
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.
97
+
1. Select the new public IP address in the location.
97
98
98
-
1.Select the new public IP address in the location.
99
+
1.Select **Apply**, and then select **Save**.
99
100
100
-
1. Select **Apply**, and then select **Save**.
101
+
:::image type="content" alt-text="Screenshot of how to migrate existing location of API Management instance (stv2 platform) injected in a virtual network." source ="media/migrate-api-mgt/option-three-stv2-injected-in-vnet.png":::
101
102
102
-
:::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":::
103
+
## Add a new location for an API Management instance (with or without a virtual network) with availability zones
103
104
104
-
## Option 4. Add new location for API Management instance (with or without VNet) with availability zones
105
-
106
-
Use this option to add a new location to your API Management instance and enable availability zones in that location.
105
+
To add a new location to your API Management instance and enable availability zones in that location, use the following steps.
107
106
108
107
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.
109
108
110
-
1.In the Azure portal, navigate to your API Management service.
109
+
1.In the Azure portal, go to your API Management service.
111
110
112
-
1.Select **+ Add** in the top bar to add a new location. The location must [support availability zones](#prerequisites).
111
+
1.Select **+ Add** in the top bar to add a new location. The location must [support availability zones](#prerequisites).
113
112
114
-
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
113
+
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
115
114
116
-
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.
115
+
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.
117
116
118
-
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.
117
+
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.
119
118
120
119
1. Select **Add**, and then select **Save**.
121
120
122
-
:::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":::
123
-
124
-
## Next steps
125
-
126
-
Learn more about:
127
-
128
-
> [!div class="nextstepaction"]
129
-
> [Deploying an Azure API Management service instance to multiple Azure regions](../api-management/api-management-howto-deploy-multi-region.md).
130
-
131
-
> [!div class="nextstepaction"]
132
-
> [Building for reliability](/azure/architecture/framework/resiliency/app-design) in Azure.
121
+
:::image type="content" alt-text="Screenshot of how to add new location for API Management instance with or without a virtual network." source ="media/migrate-api-mgt/option-four-add-new-location.png":::
133
122
134
-
> [!div class="nextstepaction"]
135
-
> [Azure services and regions that support availability zones](availability-zones-service-support.md)
123
+
## Related content
136
124
125
+
*[Deploy an Azure API Management instance to multiple Azure regions](../api-management/api-management-howto-deploy-multi-region.md).
126
+
*[Design review checklist for reliability](/azure/architecture/framework/resiliency/app-design).
127
+
*[Azure services and regions that support availability zones](availability-zones-service-support.md)
0 commit comments