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/api-management/api-management-howto-deploy-multi-region.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Learn how to deploy a Premium tier Azure API Management instance to
5
5
author: dlepow
6
6
ms.service: azure-api-management
7
7
ms.topic: how-to
8
-
ms.date: 06/28/2025
8
+
ms.date: 07/07/2025
9
9
ms.author: danlep
10
10
---
11
11
@@ -39,34 +39,34 @@ When adding a region, you configure:
39
39
* 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.
40
40
* 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).
41
41
42
-
## <aname="add-region"> </a>Deploy API Management service to an additional region
42
+
## Deploy API Management service to an additional region
43
43
44
44
1. In the Azure portal, navigate to your API Management service and select **Locations** from the left menu.
45
45
1. Select **+ Add** in the top bar.
46
46
1. Select the added location from the dropdown list.
47
47
1. Select the number of scale **[Units](upgrade-and-scale.md)** in the location.
48
48
1. If the region supports availability zones, leave the **Automatic** setting (recommended), or optionally select one or more [**Availability zones**](enable-availability-zone-support.md). 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 (if enabling availability zones).
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.
50
50
1. Select **Add** to confirm.
51
51
1. Repeat this process until you configure all locations.
52
52
1. Select **Save** in the top bar to start the deployment process.
53
53
54
-
## <aname="remove-region"> </a>Remove an API Management service region
54
+
## Remove an API Management service region
55
55
56
56
1. In the Azure portal, navigate to your API Management service and select **Locations** from the left menu.
57
57
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**.
58
58
1. Confirm the deletion and select **Save** to apply the changes.
59
59
60
60
61
-
## <aname="route-backend"> </a>Route API calls to regional backend services
61
+
## Route API calls to regional backend services
62
62
63
63
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.
64
64
65
65
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.
66
66
67
67
1. Navigate to your Azure API Management instance and select **APIs** from the left menu.
68
68
2. Select your desired API.
69
-
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**.
@@ -110,7 +110,7 @@ You may also front your backend services with [Azure Traffic Manager](https://az
110
110
111
111
* For traffic control during maintenance operations, we recommend using the Priority routing method.
112
112
113
-
## <aname="custom-routing"> </a>Use custom routing to API Management regional gateways
113
+
## Use custom routing to API Management regional gateways
114
114
115
115
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.
116
116
@@ -168,7 +168,7 @@ This section provides considerations for multi-region deployments when the API M
168
168
* 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.
169
169
* Virtual networks in the different regions don't need to be peered.
170
170
> [!IMPORTANT]
171
-
> 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 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.
#Customer intent: As an engineer responsible for business continuity, I want to learn how to enable zone redundancy for my Azure API Management instances.
@@ -35,18 +35,18 @@ When you create a new API Management instance in the **Premium** tier in a regio
35
35
Under normal operating conditions, all scale units in all enabled zones are active and serve gateway traffic.
36
36
37
37
> [!IMPORTANT]
38
-
> To ensure the reliability of your API Management instance, we recommend that you use the default availability zone support and 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).
38
+
> To ensure the reliability of your API Management instance, we recommend that you use the default 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).
39
39
40
40
## Manually configure availability zone support for an existing gateway location
41
41
42
-
While automatic availability zone configuration is recommended, you can manually configure or update availability zones for an existing location of your API Management instance. There are two configuring availability zones on an existing location of your API Management instance, depending on whether the instance is injected in a virtual network.
42
+
While automatic availability zone configuration is recommended, you can manually configure or update availability zones for an existing location of your API Management instance. There are two configurations for availability zones on an existing location of your API Management instance, depending on whether the instance is injected in a virtual network.
43
43
44
44
> [!CAUTION]
45
45
> 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.
46
46
47
47
### Gateway not injected in a virtual network
48
48
49
-
To manually enable availability support on an existing location of an API Management instance that's not injected in a virtual network:
49
+
To manually enable availability zone support on an existing location of an API Management instance that's not injected in a virtual network:
50
50
51
51
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).
52
52
@@ -66,11 +66,11 @@ To manually enable availability support on an existing location of an API Manage
66
66
67
67
### Gateway injected in a virtual network
68
68
69
-
To manually enable availability support on an existing location of an API Management instance that's injected in a virtual network:
69
+
To manually enable availability zone support on an existing location of an API Management instance that's injected in a virtual network:
70
70
71
71
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).
72
72
73
-
1. Create a new subnet and public IP address in the location to enable to availability zones. Detailed requirements are in the [virtual networking guidance](../api-management/api-management-using-with-vnet.md?tabs=stv2#prerequisites).
73
+
1. Create a new subnet and 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).
74
74
75
75
1. In the Azure portal, go to your API Management instance.
76
76
@@ -94,7 +94,7 @@ To add a new location to your API Management instance and to manually enable ava
94
94
95
95
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).
96
96
97
-
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.
97
+
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.
98
98
99
99
1. In the Azure portal, go to your API Management instance.
100
100
@@ -104,7 +104,7 @@ To add a new location to your API Management instance and to manually enable ava
104
104
105
105
1. In the **Units** box, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
106
106
107
-
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.
107
+
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
108
109
109
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.
0 commit comments