Skip to content

Commit 19fa0fc

Browse files
committed
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into advconn
2 parents edd80c8 + cd899d1 commit 19fa0fc

File tree

113 files changed

+1042
-513
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+1042
-513
lines changed

articles/api-management/TOC.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,16 +133,16 @@
133133
href: api-management-configuration-repository-git.md
134134
- name: DevOps and CI/CD
135135
href: devops-api-development-templates.md
136-
- name: Resiliency
136+
- name: Resiliency and reliability
137137
items:
138-
- name: High availability features
138+
- name: Reliability in API Management
139139
displayName: reliability, resilience, resiliency
140-
href: high-availability.md
140+
href: /azure/reliability/reliability-api-management?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
141141
- name: Deploy to multiple Azure regions
142142
href: api-management-howto-deploy-multi-region.md
143143
- name: Enable availability zones
144144
displayName: zonal, zone-redundant
145-
href: ../reliability/migrate-api-mgt.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
145+
href: enable-availability-zone-support.md
146146
- name: Set up DR using backup/restore
147147
displayName: disaster, recovery
148148
href: api-management-howto-disaster-recovery-backup-restore.md

articles/api-management/api-management-howto-deploy-multi-region.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to deploy a Premium tier Azure API Management instance to
55
author: dlepow
66
ms.service: azure-api-management
77
ms.topic: how-to
8-
ms.date: 07/29/2024
8+
ms.date: 07/07/2025
99
ms.author: danlep
1010
---
1111

@@ -19,7 +19,7 @@ When adding a region, you configure:
1919

2020
* The number of scale [units](upgrade-and-scale.md) that region will host.
2121

22-
* Optional [availability zones](../reliability/migrate-api-mgt.md), if that region supports it.
22+
* [Availability zones](enable-availability-zone-support.md), if that region supports it. By default, API Management automatically configures availability zones for the added region, which is recommended. You can also manually configure availability zones for the added region.
2323

2424
* [Virtual network](virtual-network-concepts.md) settings in the added region, if networking is configured in the existing region or regions.
2525

@@ -35,37 +35,38 @@ When adding a region, you configure:
3535

3636
## Prerequisites
3737

38+
* Thoroughly understand all requirements and considerations for enabling multi-region deployment in API Management by reading [Reliability in API Management](../reliability/reliability-api-management.md).
3839
* If you haven't created an API Management service instance, see [Create an API Management service instance](get-started-create-service-instance.md). Select the Premium service tier.
3940
* If your API Management instance is deployed in a virtual network, ensure that you set up a virtual network and subnet in the location that you plan to add, and within the same subscription. See [virtual network prerequisites](api-management-using-with-vnet.md#prerequisites).
4041

41-
## <a name="add-region"> </a>Deploy API Management service to an additional region
42+
## Deploy API Management service to an additional region
4243

4344
1. In the Azure portal, navigate to your API Management service and select **Locations** from the left menu.
4445
1. Select **+ Add** in the top bar.
4546
1. Select the added location from the dropdown list.
4647
1. Select the number of scale **[Units](upgrade-and-scale.md)** in the location.
47-
1. Optionally select one or more [**Availability zones**](../reliability/migrate-api-mgt.md).
48-
1. If the API Management instance is deployed in a [virtual network](api-management-using-with-vnet.md), configure virtual network settings in the location, including virtual network, subnet, and public IP address (if enabling availability zones).
48+
1. If the region supports [**Availability zones**](enable-availability-zone-support.md), 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.
49+
1. If the API Management instance is deployed in a [virtual network](api-management-using-with-vnet.md), configure virtual network settings in the location, including virtual network, subnet, and public IP address.
4950
1. Select **Add** to confirm.
5051
1. Repeat this process until you configure all locations.
5152
1. Select **Save** in the top bar to start the deployment process.
5253

53-
## <a name="remove-region"> </a>Remove an API Management service region
54+
## Remove an API Management service region
5455

5556
1. In the Azure portal, navigate to your API Management service and select **Locations** from the left menu.
5657
1. For the location you would like to remove, select the context menu using the **...** button at the right end of the table. Select **Delete**.
5758
1. Confirm the deletion and select **Save** to apply the changes.
5859

5960

60-
## <a name="route-backend"> </a>Route API calls to regional backend services
61+
## Route API calls to regional backend services
6162

6263
By default, each API routes requests to a single backend service URL. Even if you've configured Azure API Management gateways in various regions, the API gateway will still forward requests to the same backend service, which is deployed in only one region. In this case, the performance gain will come only from responses cached within Azure API Management in a region specific to the request; contacting the backend across the globe may still cause high latency.
6364

6465
To take advantage of geographical distribution of your system, you should have backend services deployed in the same regions as Azure API Management instances. Then, using policies and `@(context.Deployment.Region)` property, you can route the traffic to local instances of your backend.
6566

6667
1. Navigate to your Azure API Management instance and select **APIs** from the left menu.
6768
2. Select your desired API.
68-
3. Select **Code editor** from the arrow dropdown in the **Inbound processing**.
69+
3. On the **Design** tab, in the **Inbound processing** section, select **Code editor**.
6970

7071
![API code editor](./media/api-management-howto-deploy-multi-region/api-management-api-code-editor.png)
7172

@@ -109,7 +110,7 @@ You may also front your backend services with [Azure Traffic Manager](https://az
109110

110111
* For traffic control during maintenance operations, we recommend using the Priority routing method.
111112

112-
## <a name="custom-routing"> </a>Use custom routing to API Management regional gateways
113+
## Use custom routing to API Management regional gateways
113114

114115
API Management routes the requests to a regional gateway based on [the lowest latency](../traffic-manager/traffic-manager-routing-methods.md#performance). Although it isn't possible to override this setting in API Management, you can use your own Traffic Manager with custom routing rules.
115116

@@ -167,7 +168,7 @@ This section provides considerations for multi-region deployments when the API M
167168
* Configure each regional network independently. The [connectivity requirements](virtual-network-reference.md) such as required network security group rules for a virtual network in an added region are generally the same as those for a network in the primary region.
168169
* Virtual networks in the different regions don't need to be peered.
169170
> [!IMPORTANT]
170-
> When configured in internal VNet mode, each regional gateway must also have outbound connectivity on port 1433 to the Azure SQL database configured for your API Management instance, which is only in the *primary* region. Ensure that you allow connectivity to the FQDN or IP address of this Azure SQL database in any routes or firewall rules you configure for networks in your secondary regions; the Azure SQL service tag can't be used in this scenario. To find the Azure SQL database name in the primary region, go to the **Network** > **Network status** page of your API Management instance in the portal.
171+
> When configured in internal virtual network mode, each regional gateway must also have outbound connectivity on port 1433 to the Azure SQL database configured for your API Management instance, which is only in the *primary* region. Ensure that you allow connectivity to the FQDN or IP address of this Azure SQL database in any routes or firewall rules you configure for networks in your secondary regions; the Azure SQL service endpoint can't be used in this scenario. To find the Azure SQL database name in the primary region, go to the **Network** > **Network status** page of your API Management instance in the portal.
171172

172173
### IP addresses
173174

@@ -185,10 +186,10 @@ This section provides considerations for multi-region deployments when the API M
185186

186187
## Related content
187188

188-
* Learn more about configuring API Management for [high availability](high-availability.md).
189-
190-
* Learn more about configuring [availability zones](../reliability/migrate-api-mgt.md) to improve the availability of an API Management instance in a region.
189+
* Learn more about [reliability in API Management](../reliability/reliability-api-management.md)
191190

191+
* Learn more about enabling [availability zone support](enable-availability-zone-support.md) for an API Management instance.
192+
192193
* For more information about virtual networks and API Management, see:
193194

194195
* [Connect to a virtual network using Azure API Management](api-management-using-with-vnet.md)
Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
title: Enable availability zones for Azure API Management instances
3+
description: Learn how to enable availability zone support on your Premium tier Azure API Management instances.
4+
author: dlepow
5+
ms.service: azure-api-management
6+
ms.topic: how-to
7+
ms.date: 07/17/2025
8+
ms.author: danlep
9+
ms.custom: references_regions, subject-reliability
10+
#Customer intent: As an engineer responsible for business continuity, I want to learn how to enable zone redundancy for my Azure API Management instances.
11+
---
12+
13+
# Enable availability zone support on Azure API Management instances
14+
15+
[!INCLUDE [premium.md](../../includes/api-management-availability-premium.md)]
16+
17+
This how-to guide shows you how to enable and configure availability zones on an API Management instance.
18+
19+
For more detailed information about reliability features of API Management, such as availability zones and multi-region deployments, see [Reliability in Azure API Management](../reliability/reliability-api-management.md).
20+
21+
[!INCLUDE [api-management-service-update-behavior](../../includes/api-management-service-update-behavior.md)]
22+
23+
## Prerequisites
24+
25+
* To configure availability zones for API Management, your instance must be in one of the [Azure regions that support availability zones](../reliability/regions-list.md).
26+
27+
* 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.
28+
29+
* If you have an existing API Management instance, make sure that it's in the **Premium** (classic) tier. If it isn't, [upgrade to the Premium tier](../api-management/upgrade-and-scale.md#change-your-api-management-service-tier).
30+
31+
## Default availability zone support
32+
33+
When you create a new API Management instance in the **Premium** tier in a region that supports availability zones, or you [deploy API Management to an additional region](api-management-howto-deploy-multi-region.md), API Management offers two types of availability zone support:
34+
35+
*Automatic*. Azure API Management offers automatic availability zone support when you don't specify which availability zones to use.
36+
37+
*Manual*. Azure API Management offers manual availability zone support when you explicitly specify which availability zones to use.
38+
39+
> [!IMPORTANT]
40+
> To ensure the reliability of your API Management instance, we recommend that you use the automatic availability zone support. To achieve maximum zone redundancy, we recommend that you deploy a minimum of three units in each region where you deploy your API Management instances. For details, see [Reliability in API Management](../reliability/reliability-api-management.md).
41+
42+
## Manual availability zone support
43+
44+
While automatic availability zone configuration is recommended, you can manually configure or update availability zones for an existing location of your API Management instance. The following sections provide steps for manually configuring zone redundancy on an existing location of your API Management instance, depending on whether the instance is injected in a virtual network.
45+
46+
> [!NOTE]
47+
> You can optionally enable a *zonal* configuration, where the API Management instance or location is deployed in a single availability zone. Because it doesn't provide resiliency to an outage in that zone, this configuration generally isn't recommended except for specific scenarios. For more information, see [Reliability in API Management](../reliability/reliability-api-management.md).
48+
49+
> [!CAUTION]
50+
> If you manually configure availability zones on an API Management instance that's configured with autoscaling, you might need to adjust your autoscale settings after configuration. In this case, the number of API Management units in autoscale rules and limits must be a multiple of the number of zones. If you simply default to the automatic availability zone support, you don't need to adjust your autoscale settings.
51+
52+
### Instance not injected in a virtual network
53+
54+
To manually configure availability zone support on an existing location of an API Management instance:
55+
56+
1. Thoroughly understand all requirements and considerations for availability zones in API Management by reading [Reliability in API Management](../reliability/reliability-api-management.md).
57+
58+
1. In the Azure portal, go to your API Management instance.
59+
60+
1. On the **Deployment + infrastructure** menu, select **Locations**.
61+
62+
1. In the **Location** box, select the location to be enabled. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
63+
64+
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
65+
66+
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.
67+
68+
1. Select **Apply**, and then select **Save**.
69+
70+
:::image type="content" alt-text="Screenshot that shows availability zone configuration for an existing location of API Management instance that's not injected in a virtual network." source ="media/enable-availability-zone-support/option-one-not-injected-in-vnet.png":::
71+
72+
### Instance injected in a virtual network
73+
74+
To manually configure availability zone support on an existing location of an API Management instance that's injected in a virtual network:
75+
76+
1. Thoroughly understand all requirements and considerations for enabling zone redundancy in API Management by reading [Reliability in API Management](../reliability/reliability-api-management.md).
77+
78+
1. Create a public IP address in the location to enable availability zones. Detailed requirements are in the [virtual networking guidance](../api-management/api-management-using-with-vnet.md?tabs=stv2#prerequisites).
79+
80+
1. In the Azure portal, go to your API Management instance.
81+
82+
1. On the **Deployment + infrastructure** menu, select **Locations**.
83+
84+
1. In the **Location** box, select the location to be enabled. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
85+
86+
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
87+
88+
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.
89+
90+
1. In the **Public IP Address** box, select a public IP address in the location.
91+
92+
1. Select **Apply**, and then select **Save**.
93+
94+
:::image type="content" alt-text="Screenshot that shows availability zone configuration for an existing location of API Management instance that's injected in a virtual network." source ="media/enable-availability-zone-support/option-three-stv2-injected-in-vnet.png":::
95+
96+
## New gateway location
97+
98+
To add a new location to your API Management instance and to configure availability zones in that location:
99+
100+
1. Thoroughly understand all requirements and considerations for enabling availability zones in API Management by reading [Reliability in API Management](../reliability/reliability-api-management.md).
101+
102+
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 the new location where you plan to enable availability zones.
103+
104+
1. In the Azure portal, go to your API Management instance.
105+
106+
1. On the **Deployment + infrastructure** menu, select **Locations**.
107+
108+
1. Select **+ Add** to add a new location. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
109+
110+
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
111+
112+
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.
113+
114+
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.
115+
116+
1. Select **Add**, and then select **Save**.
117+
118+
:::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/enable-availability-zone-support/option-four-add-new-location.png":::
119+
120+
## Related content
121+
122+
- [Reliability in API Management](../reliability/reliability-api-management.md)
123+
- [Architecture best practices for API Management](/azure/well-architected/service-guides/azure-api-management)
124+
- [Design review checklist for reliability](/azure/architecture/framework/resiliency/app-design)
125+
- [Azure services with availability zones](../reliability/availability-zones-service-support.md)
126+
- [Azure regions with availability zones](../reliability/regions-list.md)

0 commit comments

Comments
 (0)