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
+26-23Lines changed: 26 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,16 +12,15 @@ ms.author: danlep
12
12
13
13
# Deploy an Azure API Management instance to multiple Azure regions
14
14
15
-
Azure API Management supports multi-region deployment, which enables API publishers to add regional API gateways to an existing API Management instance in any number of supported Azure regions. Multi-region deployment helps reduce request latency perceived by geographically distributed API consumers and improves service availability if one region goes offline.
15
+
Azure API Management supports multi-region deployment, which enables API publishers to add regional API gateways to an existing API Management instance in one or more supported Azure regions. Multi-region deployment helps reduce request latency perceived by geographically distributed API consumers and improves service availability if one region goes offline.
16
16
17
17
When adding a region, you configure:
18
18
19
-
* The number of scale [units](upgrade-and-scale.md) that region will host.
20
-
21
-
*[Virtual network](../articles/api-management/virtual-network-concepts.md) settings in the added region, if networking is configured in the existing region or regions.
19
+
* The number of scale [units](upgrade-and-scale.md) that region will host.
22
20
23
21
* Optional [zone redundancy](../articles/availability-zones/migrate-api-mgt.md), if that region supports it.
24
22
23
+
*[Virtual network](../articles/api-management/virtual-network-concepts.md) settings in the added region, if networking is configured in the existing region or regions.
25
24
26
25
>[!IMPORTANT]
27
26
> The feature to enable storing customer data in a single region is currently only available in the Southeast Asia Region (Singapore) of the Asia Pacific Geo. For all other regions, customer data is stored in Geo.
@@ -34,8 +33,8 @@ When adding a region, you configure:
34
33
35
34
## Prerequisites
36
35
37
-
* If you haven't yet created an API Management service instance, see [Create an API Management service instance](get-started-create-service-instance.md). Select the Premium service tier.
38
-
* If your API Management instance is deployed in a [virtual network](api-management-using-with-vnet.md), ensure that you set up a virtual network, subnet, and public IP address in the location that you plan to add.
36
+
* 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.
37
+
* If your API Management instance is deployed in a virtual network, ensure that you set up a virtual network, subnet, and public IP address in the location that you plan to ad?d. See [virtual network prerequisites](api-management-using-with-vnet.md#prerequisites).
39
38
40
39
## <aname="add-region"> </a>Deploy API Management service to an additional location
41
40
@@ -52,7 +51,7 @@ When adding a region, you configure:
52
51
## <aname="remove-region"> </a>Delete an API Management service location
53
52
54
53
1. In the Azure portal, navigate to your API Management service and select **Locations** from the left menu.
55
-
2. For the location you would like to remove, select the context menu using the **...** button at the right end of the table. Select**Delete**.
54
+
2. For the location you would like to remove, select the context menu using the **...** button at the right end of the table. Select**Delete**.
56
55
3. Confirm the deletion and select **Save** to apply the changes.
57
56
58
57
## <aname="route-backend"> </a>Route API calls to regional backend services
@@ -61,6 +60,9 @@ By default, each API routes requests to a single backend service URL. Even if yo
61
60
62
61
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.
63
62
63
+
> [!TIP]
64
+
> Optionally set the `disableGateway` property in a regional gateway to disable routing of API traffic there. For example, disable a regional gateway when testing or updating a regional backend service.
65
+
64
66
1. Navigate to your Azure API Management instance and select **APIs** from the left menu.
65
67
2. Select your desired API.
66
68
3. Select **Code editor** from the arrow dropdown in the **Inbound processing**.
@@ -77,13 +79,13 @@ To take advantage of geographical distribution of your system, you should have b
@@ -114,33 +116,34 @@ API Management routes the requests to a regional gateway based on [the lowest la
114
116
115
117
## Virtual networking
116
118
117
-
This section provides considerations for using virtual networks in a multi-region deployment.
119
+
The [connectivity requirements](virtual-network-reference.md) such as required network security group rules for a virtual network in an added region are the same as those for a network in the primary region.
118
120
119
-
In general, the prerequisites, configurations, and connectivity requirements for a virtual network in an added region are the same as those for a network in the primary region.
121
+
Note the following considerations for addressing and routing:
120
122
121
-
For more information, see:
123
+
### IP addresses
122
124
123
-
* [Connect to a virtual networkusing Azure API Management](api-management-using-with-vnet.md)
125
+
* A public virtual IP address is created in every region added with a virtual network. For virtual networks in either [external mode](api-management-using-with-vnet.md) or [internal mode](api-management-using-with-internal-vnet.md), this public IP address is required for management traffic on port `3443`.
124
126
125
-
* [Connect to a virtual network in internal mode using Azure API Management](api-management-using-with-internal-vnet.md)
127
+
In external VNet mode, the public IP address is also used to route API gateway traffic.
126
128
127
-
* [IP addresses of API Management](api-management-howto-ip-addresses.md)
129
+
* In internal VNet mode, a private IP address is also created in every region added with a virtual network. Use these addresses to connect within the network to the service endpoints in the primary and secondary regions.
128
130
131
+
### Routing
129
132
130
-
### External VNet mode
133
+
* In external VNet mode, API Management by default handles routing of API traffic to the regional gateways using Azure Traffic Manager.
131
134
132
-
* A public virtual IP address is created in every region added with a virtual network. This address is used for management traffic and for runtime API traffic.
135
+
* In internal VNet mode, private HTTP traffic isn't routed or load-balanced to the regional gateways by default. Users own the routing and are responsible for bringing their own solution to manage private load balancing across multiple regions. For example,
133
136
137
+
## Next steps
134
138
135
-
### Internal VNet mode
139
+
For more information about virtual networks and API Management, see:
136
140
137
-
* A public virtual IP address is created in every region added with a virtual network. This address is used for management traffic on port `3443`.
141
+
* [Connect to a virtual network using Azure API Management](api-management-using-with-vnet.md)
138
142
139
-
* A private IP address is also created in every region added with a virtual network. These addresses are used to connect within the network to the service endpoints in the primary and secondary regions.
143
+
* [Connect to a virtual networkin internal mode using Azure API Management](api-management-using-with-internal-vnet.md)
140
144
141
-
* In internal VNet mode, private HTTP traffic isn't routed or load-balanced to the regional gateways by default. Users own the routing and are responsible for bringing their own solution to manage private load balancing across multiple regions.
145
+
* [IP addresses of API Management](api-management-howto-ip-addresses.md)
142
146
143
-
## Next steps
144
147
145
148
[create an api management service instance]: get-started-create-service-instance.md
146
149
[get started with azure api management]: get-started-create-service-instance.md
0 commit comments