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 zones
14
14
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.
15
+
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.
16
16
17
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
-
* 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).
21
+
* 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).
22
22
23
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
@@ -32,96 +32,104 @@ There are no downtime requirements for any of the migration options.
32
32
33
33
## Considerations
34
34
35
-
* Changes can take from 15 to 45 minutes to apply. The API Management gateway can continue to handle API requests during this time.
35
+
* Changes can take 15 to 45 minutes to apply. The API Management gateway can continue to handle API requests during this time.
36
36
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).
37
+
* 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).
38
38
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).
39
+
* 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).
40
40
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.
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 can configure two units, four units, or another multiple of two units.
42
42
43
43
Adding units incurs additional costs. For details, see [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/).
44
44
45
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
47
## Migrate an existing location of an API Management instance that's not injected in a virtual network
48
48
49
-
To migrate an existing location of your API Management instance to availability zones when it's not injected in a virtual network:
49
+
To migrate an existing location of your API Management instance to availability zones when the instance is not injected in a virtual network:
50
50
51
-
1. In the Azure portal, go to your API Management service.
51
+
1. In the Azure portal, go to your API Management instance.
52
52
53
-
1.Select **Locations**in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
53
+
1.On the **Deployment + infrastructure** menu, select **Locations**.
54
54
55
-
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
55
+
1.In the **Location** box, select the location to be migrated. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
56
56
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.
57
+
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
58
+
59
+
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.
58
60
59
61
1. Select **Apply**, and then select **Save**.
60
62
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":::
63
+
:::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":::
64
+
65
+
## Migrate an existing location of an API Management instance (stv1 platform) that's injected in a virtual network
62
66
63
-
## Migrate an existing location of API Management instance (stv1 platform) that's injected in a virtual network
67
+
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.
64
68
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.
69
+
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).
66
70
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).
71
+
1.In the Azure portal, go to your API Management instance.
68
72
69
-
1.In the Azure portal, go to your API Management service.
73
+
1.On the **Deployment + infrastructure** menu, select **Locations**.
70
74
71
-
1.Select **Locations**in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
75
+
1.In the **Location**box, select the location to be migrated. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
72
76
73
-
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md)desired in the location.
77
+
1.In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md)that you want in the location.
74
78
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.
79
+
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.
76
80
77
-
1.Select the new subnet and new public IP address in the location.
81
+
1.In the respective boxes under **Network**, select the new subnet and new public IP address in the location.
78
82
79
83
1. Select **Apply**, and then select **Save**.
80
84
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":::
85
+
:::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":::
82
86
83
87
## Migrate an existing location of an API Management instance (stv2 platform) that's injected in a virtual network
84
88
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:
89
+
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:
86
90
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).
91
+
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).
88
92
89
-
1. In the Azure portal, go to your API Management service.
93
+
1. In the Azure portal, go to your API Management instance.
90
94
91
-
1.Select **Locations**in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
95
+
1.On the **Deployment + infrastructure** menu, select **Locations**.
92
96
93
-
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
97
+
1.In the **Location** box, select the location to be migrated. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
94
98
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.
99
+
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
96
100
97
-
1. Select the new public IP address in the location.
101
+
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.
102
+
103
+
1. In the **Public IP Address** box, select the new public IP address in the location.
98
104
99
105
1. Select **Apply**, and then select **Save**.
100
106
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":::
107
+
:::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":::
102
108
103
109
## Add a new location for an API Management instance (with or without a virtual network) with availability zones
104
110
105
-
To add a new location to your API Management instance and enable availability zones in that location, use the following steps.
111
+
To add a new location to your API Management instance and enable availability zones in that location:
112
+
113
+
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.
106
114
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.
115
+
1. In the Azure portal, go to your API Management instance.
108
116
109
-
1.In the Azure portal, go to your API Management service.
117
+
1.On the **Deployment + infrastructure** menu, select **Locations**.
110
118
111
-
1. Select **+ Add**in the top bar to add a new location. The location must [support availability zones](#prerequisites).
119
+
1. Select **+ Add** to add a new location. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
112
120
113
-
1.Select the number of scale [Units](../api-management/upgrade-and-scale.md)desired in the location.
121
+
1.In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md)that you want in the location.
114
122
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.
123
+
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.
116
124
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.
125
+
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.
118
126
119
127
1. Select **Add**, and then select **Save**.
120
128
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":::
129
+
:::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":::
122
130
123
131
## Related content
124
132
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).
133
+
*[Deploy an Azure API Management instance to multiple Azure regions](../api-management/api-management-howto-deploy-multi-region.md)
134
+
*[Design review checklist for reliability](/azure/architecture/framework/resiliency/app-design)
127
135
*[Azure services and regions that support availability zones](availability-zones-service-support.md)
0 commit comments