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
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ When adding a region, you configure:
34
34
35
35
## Prerequisites
36
36
37
-
* 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).
37
+
* Thoroughly understand all [requirements and considerations for enabling multi-region deployment in API Management](../reliability/reliability-api-management.md).
38
38
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
@@ -64,7 +64,7 @@ By default, each API routes requests to a single back-end service URL. Even if y
64
64
65
65
To take advantage of geographical distribution of your system, you should deploy back-end services in the same regions as API Management instances. Then, by using policies and the `@(context.Deployment.Region)` property, you can route the traffic to local instances of your back end.
66
66
67
-
1.Navigate to your API Management instance and select **APIs** from the left menu.
67
+
1.Go to your API Management instance and select **APIs** from the left menu.
68
68
2. Select your desired API.
69
69
3. On the **Design** tab, in the **Inbound processing** section, select **Code editor**.
70
70
@@ -115,7 +115,7 @@ You can also front your back-end services with [Azure Traffic Manager](https://a
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
117
117
1. Create your own [Traffic Manager](https://azure.microsoft.com/services/traffic-manager/).
118
-
1. If you use a custom domain, [use it with the Traffic Manager](../traffic-manager/traffic-manager-point-internet-domain.md) instead of the API Management service.
118
+
1. If you use a custom domain, [use it with Traffic Manager](../traffic-manager/traffic-manager-point-internet-domain.md) instead of the API Management service.
119
119
1. [Configure the API Management regional endpoints in Traffic Manager](../traffic-manager/traffic-manager-manage-endpoints.md). The regional endpoints follow the URL pattern of `https://<service-name>-<region>-01.regional.azure-api.net`, for example `https://contoso-westus2-01.regional.azure-api.net`.
120
120
1. [Configure the API Management regional status endpoints in Traffic Manager](../traffic-manager/traffic-manager-monitoring.md). The regional status endpoints follow the URL pattern of `https://<service-name>-<region>-01.regional.azure-api.net/status-0123456789abcdef`, for example `https://contoso-westus2-01.regional.azure-api.net/status-0123456789abcdef`.
121
121
1. Specify [the routing method](../traffic-manager/traffic-manager-routing-methods.md) of the Traffic Manager.
@@ -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 the requirements 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 you configure regional gateways in internal virtual network mode, each 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 fully qualified domain name (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.
171
+
> When you configure your API Management instance to use 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 fully qualified domain name (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.
This how-to guide describes how to enable and configure availability zones on an Azure API Management instance.
18
18
19
-
For more detailed information about reliability features of API Management, such as availability zones and multiple-region deployments, see [Reliability in API Management](../reliability/reliability-api-management.md).
19
+
For more detailed information about reliability features of API Management, such as availability zones and multi-region deployments, see [Reliability in API Management](../reliability/reliability-api-management.md).
@@ -30,7 +30,7 @@ For more detailed information about reliability features of API Management, such
30
30
31
31
## Default availability zone support
32
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 provides two types of availability zone support:
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 multiple regions](api-management-howto-deploy-multi-region.md), API Management provides two types of availability zone support:
34
34
35
35
-**Automatic:** API Management provides automatic availability zone support when you don't specify which availability zones to use.
36
36
@@ -51,53 +51,53 @@ We recommend automatic availability zone configuration, but you can manually con
51
51
52
52
### Instance not injected in a virtual network
53
53
54
-
To manually configure availability zone support on an existing location of an API Management instance:
54
+
To manually configure availability zone support on an existing location of an API Management instance, follow these steps:
55
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).
56
+
1. Thoroughly understand all [requirements and considerations for availability zones in API Management](../reliability/reliability-api-management.md).
57
57
58
58
1. In the Azure portal, go to your API Management instance.
59
59
60
60
1. On the **Deployment + infrastructure** menu, select **Locations**.
61
61
62
-
1.In the **Location** box, select the location that you want to enable. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
62
+
1.Select the location that you want to enable. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
63
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.
64
+
1.Under **Units**, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
65
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 select must distribute evenly across the availability zones. For example, if you select three units, you must select three zones so that each zone hosts one unit.
66
+
1.Under **Availability zones**, leave the **Automatic** setting (recommended), or optionally select one or more zones. If you select specific zones, the number of units that you select must distribute evenly across the availability zones. For example, if you select three units, you must select three zones so that each zone hosts one unit.
67
67
68
68
1. Select **Apply**, and then select **Save**.
69
69
70
70
:::image type="content" alt-text="Screenshot that shows availability zone configuration for an existing location of an API Management instance that's not injected in a virtual network." source ="media/enable-availability-zone-support/option-one-not-injected-in-vnet.png" lightbox="media/enable-availability-zone-support/option-one-not-injected-in-vnet.png":::
71
71
72
72
### Instance injected in a virtual network
73
73
74
-
To manually configure availability zone support on an existing location of an API Management instance that's injected in a virtual network:
74
+
To manually configure availability zone support on an existing location of an API Management instance that's injected in a virtual network, follow these steps:
75
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).
76
+
1. Thoroughly understand all [requirements and considerations for enabling zone redundancy in API Management](../reliability/reliability-api-management.md).
77
77
78
78
1. Create a public IP address in the location to enable availability zones. For detailed requirements, see the [virtual networking guidance](../api-management/api-management-using-with-vnet.md?tabs=stv2#prerequisites).
79
79
80
80
1. In the Azure portal, go to your API Management instance.
81
81
82
82
1. On the **Deployment + infrastructure** menu, select **Locations**.
83
83
84
-
1.In the **Location** box, select the location that you want to enable. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
84
+
1.Select the location that you want to enable. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
85
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.
86
+
1.Under **Units**, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
87
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 select must distribute evenly across the availability zones. For example, if you select three units, you must select three zones so that each zone hosts one unit.
88
+
1.Under **Availability zones**, leave the **Automatic** setting (recommended), or optionally select one or more zones. If you select specific zones, the number of units that you select must distribute evenly across the availability zones. For example, if you select three units, you must select three zones so that each zone hosts one unit.
89
89
90
-
1.In the **Public IP Address** box, select a public IP address in the location.
90
+
1.Under **Public IP Address**, select a public IP address in the location.
91
91
92
92
1. Select **Apply**, and then select **Save**.
93
93
94
-
:::image type="content" alt-text="Screenshot that shows availability zone configuration for an existing location of an API Management instance that's injected in a virtual network." source ="media/enable-availability-zone-support/option-three-stv2-injected-in-vnet.png":::
94
+
:::image type="content" alt-text="Screenshot that shows availability zone configuration for an existing location of an API Management instance that's injected in a virtual network." source ="media/enable-availability-zone-support/option-three-stv2-injected-in-vnet.png" lightbox="media/enable-availability-zone-support/option-three-stv2-injected-in-vnet.png":::
95
95
96
96
## New gateway location
97
97
98
-
To add a new location to your API Management instance and to configure availability zones in that location:
98
+
To add a new location to your API Management instance and to configure availability zones in that location, follow these steps:
99
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).
100
+
1. Thoroughly understand all [requirements and considerations for enabling availability zones in API Management](../reliability/reliability-api-management.md).
101
101
102
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
103
@@ -107,15 +107,15 @@ To add a new location to your API Management instance and to configure availabil
107
107
108
108
1. Select **+ Add** to add a new location. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites).
109
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.
110
+
1.Under **Units**, select the number of scale [units](../api-management/upgrade-and-scale.md) that you want in the location.
111
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 select must distribute evenly across the availability zones. For example, if you select three units, you must select three zones so that each zone hosts one unit.
112
+
1.Under **Availability zones**, leave the **Automatic** setting (recommended), or optionally select one or more zones. If you select specific zones, the number of units that you select must distribute evenly across the availability zones. For example, if you select three units, you must select three zones so that each zone hosts one unit.
113
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.
114
+
1. If your API Management instance is deployed in a virtual network, under **Network**, select the virtual network, subnet, and public IP address that are available in the location.
115
115
116
116
1. Select **Add**, and then select **Save**.
117
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":::
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" lightbox="media/enable-availability-zone-support/option-four-add-new-location.png":::
0 commit comments