Skip to content

Commit 2d96889

Browse files
authored
Merge pull request #200119 from anaharris-ms/az-api-mgt
API Management AZ Migration doc
2 parents 0850686 + bb97a96 commit 2d96889

File tree

7 files changed

+168
-1
lines changed

7 files changed

+168
-1
lines changed

articles/availability-zones/TOC.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
href: az-region.md
1717
- name: Migration Guidance
1818
items:
19+
- name: API Management
20+
href: migrate-api-mgt.md
1921
- name: App Service Environment
2022
href: migrate-app-service-environment.md
2123
- name: App Service
@@ -26,6 +28,8 @@
2628
href: migrate-vm.md
2729
- name: Storage accounts
2830
href: migrate-storage.md
31+
- name: Virtual Machines and Virtual Machine Scale Sets
32+
href: migrate-vm.md
2933
- name: Terminology
3034
href: glossary.md
3135
- name: High Availability

articles/availability-zones/az-region.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ In the Product Catalog, always-available services are listed as "non-regional" s
9393
| **Products** | **Resiliency** |
9494
| --- | --- |
9595
| [Azure Active Directory Domain Services](../active-directory-domain-services/overview.md) | ![An icon that signifies this service is zone redundant.](media/icon-zone-redundant.svg) |
96-
| [Azure API Management](../api-management/zone-redundancy.md) | ![An icon that signifies this service is zone redundant.](media/icon-zone-redundant.svg) |
96+
| [Azure API Management](migrate-api-mgt.md) | ![An icon that signifies this service is zone redundant.](media/icon-zone-redundant.svg) |
9797
| [Azure App Configuration](../azure-app-configuration/faq.yml#how-does-app-configuration-ensure-high-data-availability) | ![An icon that signifies this service is zone redundant.](media/icon-zone-redundant.svg) |
9898
| [Azure App Service](migrate-app-service.md) | ![An icon that signifies this service is zone redundant.](media/icon-zone-redundant.svg) |
9999
| [Azure App Service: App Service Environment](migrate-app-service-environment.md) | ![An icon that signifies this service is zone redundant.](media/icon-zone-redundant.svg) ![An icon that signifies this service is zonal](media/icon-zonal.svg) |
65 KB
Loading
57.6 KB
Loading
64.1 KB
Loading
75.2 KB
Loading
Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
---
2+
title: Migrate Azure API Management to availability zone support
3+
description: Learn how to migrate your Azure API Management instances to availability zone support.
4+
author: anaharris-ms
5+
ms.service: api-management
6+
ms.topic: how-to
7+
ms.date: 07/07/2022
8+
ms.author: anaharris
9+
ms.custom: references_regions
10+
11+
---
12+
13+
# Migrate Azure API Management to availability zone support
14+
15+
This guide describes how to enable availability zone support for your API Management instance. The API Management service supports [Zone redundancy](../availability-zones/az-overview.md#availability-zones), 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.
16+
17+
In this article, we'll take you through the different options for availability zone migration.
18+
19+
## Prerequisites
20+
21+
* To configure API Management for zone redundancy, your instance must be in one of the following regions:
22+
23+
* Australia East
24+
* Brazil South
25+
* Canada Central
26+
* Central India
27+
* Central US
28+
* East Asia
29+
* East US
30+
* East US 2
31+
* France Central
32+
* Germany West Central
33+
* Japan East
34+
* Korea Central (*)
35+
* North Europe
36+
* Norway East (*)
37+
* South Africa North (*)
38+
* South Central US
39+
* Southeast Asia
40+
* Switzerland North
41+
* UK South
42+
* West Europe
43+
* West US 2
44+
* West US 3
45+
46+
> [!IMPORTANT]
47+
> The regions with * against them have restrictive access in an Azure subscription to enable availability zone support. Please work with your Microsoft sales or customer representative.
48+
49+
* 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.
50+
51+
* 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.
52+
53+
* 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.
54+
55+
## Downtime requirements
56+
57+
There are no downtime requirements for any of the migration options.
58+
59+
## Considerations
60+
61+
* Changes can take from 15 to 45 minutes to apply. The API Management gateway can continue to handle API requests during this time.
62+
63+
* Migrating to availability zones or changing the availability zone configuration will trigger a public IP address change.
64+
65+
* 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.
66+
67+
68+
## Option 1: Migrate existing location of API Management instance, not injected in VNet
69+
70+
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.
71+
72+
### How to migrate API Management in a VNet
73+
74+
1. In the Azure portal, navigate to your API Management service.
75+
76+
1. Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
77+
78+
1. Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
79+
80+
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.
81+
82+
1. Select **Apply**, and then select **Save**.
83+
84+
:::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":::
85+
86+
87+
88+
## Option 2: Migrate existing location of API Management instance (stv1 platform), injected in VNet
89+
90+
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.
91+
92+
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).
93+
94+
1. In the Azure portal, navigate to your API Management service.
95+
96+
1. Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
97+
98+
1. Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
99+
100+
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.
101+
102+
1. Select the new subnet and new public IP address in the location.
103+
104+
1. Select **Apply**, and then select **Save**.
105+
106+
107+
:::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":::
108+
109+
## Option 3: Migrate existing location of API Management instance (stv2 platform), injected in VNet
110+
111+
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.
112+
113+
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).
114+
115+
1. In the Azure portal, navigate to your API Management service.
116+
117+
1. Select **Locations** in the menu, and then select the location to be migrated. The location must [support availability zones](#prerequisites).
118+
119+
1. Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
120+
121+
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.
122+
123+
1. Select the new public IP address in the location.
124+
125+
1. Select **Apply**, and then select **Save**.
126+
127+
:::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":::
128+
129+
## Option 4. Add new location for API Management instance (with or without VNet) with availability zones
130+
131+
Use this option to add a new location to your API Management instance and enable availability zones in that location.
132+
133+
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.
134+
135+
1. In the Azure portal, navigate to your API Management service.
136+
137+
1. Select **+ Add** in the top bar to add a new location. The location must [support availability zones](#prerequisites).
138+
139+
1. Select the number of scale [Units](../api-management/upgrade-and-scale.md) desired in the location.
140+
141+
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.
142+
143+
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.
144+
145+
1. Select **Add**, and then select **Save**.
146+
147+
:::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":::
148+
149+
## Next steps
150+
151+
Learn more about:
152+
153+
> [!div class="nextstepaction"]
154+
> [deploying an Azure API Management service instance to multiple Azure regions](../api-management/api-management-howto-deploy-multi-region.md).
155+
156+
> [!div class="nextstepaction"]
157+
> [building for reliability](/azure/architecture/framework/resiliency/app-design) in Azure.
158+
159+
> [!div class="nextstepaction"]
160+
> [Regions and Availability Zones in Azure](az-overview.md)
161+
162+
> [!div class="nextstepaction"]
163+
> [Azure Services that support Availability Zones](az-region.md)

0 commit comments

Comments
 (0)