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/enable-availability-zone-support.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,14 +28,20 @@ For more detailed information about reliability features of API Management, such
28
28
29
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
30
31
+
## Default availability zone support
31
32
32
-
## Enable availability zone support for an existing gateway location
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 a new region](api-management-howto-deploy-multi-region.md), availability zones are enabled automatically **by default**. With automatic availability zone support, the Azure API Management platform makes a best-effort attempt to spread your instance's units among the region's availability zones. There's no way to determine which availability zones your units are placed into.
33
34
34
-
There are two configuration options for zone redundancy on an existing location of your API Management instance, depending on whether the instance is injected in a virtual network.
35
+
> [!IMPORTANT]
36
+
> To ensure the reliability of your API Management gateway, 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).
37
+
38
+
## Manually configure availability zone support for an existing gateway location
39
+
40
+
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 configuration options for zone redundancy on an existing location of your API Management instance, depending on whether the instance is injected in a virtual network.
35
41
36
42
### Gateway not injected in a virtual network
37
43
38
-
To enable zone-redundancy on an existing location of an API Management instance that's not injected in a virtual network:
44
+
To manually enable zone-redundancy on an existing location of an API Management instance that's not injected in a virtual network:
39
45
40
46
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).
41
47
@@ -51,16 +57,15 @@ To enable zone-redundancy on an existing location of an API Management instance
51
57
52
58
1. Select **Apply**, and then select **Save**.
53
59
54
-
:::image type="content" alt-text="Screenshot that shows selections for migrating an existing location of API Management instance that's not injected in a virtual network." source ="media/enable-zone-redundancy/option-one-not-injected-in-vnet.png":::
60
+
:::image type="content" alt-text="Screenshot that shows selections for migrating 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":::
55
61
56
62
### Gateway injected in a virtual network
57
63
58
-
To migrate an existing location of your API Management instance to availability zones when the instance is currently injected in a virtual network:
59
-
64
+
To manually enable zone-redundancy on an existing location of an API Management instance that's injected in a virtual network:
60
65
61
66
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).
62
67
63
-
1. Create a new subnet and optional 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).
68
+
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).
64
69
65
70
1. In the Azure portal, go to your API Management instance.
66
71
@@ -72,7 +77,7 @@ To migrate an existing location of your API Management instance to availability
72
77
73
78
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.
74
79
75
-
1. In the **Public IP Address** box, optionally select a public IP address in the location.
80
+
1. In the **Public IP Address** box, select a public IP address in the location.
76
81
77
82
1. Select **Apply**, and then select **Save**.
78
83
@@ -96,7 +101,7 @@ To add a new location to your API Management instance and enable zone redundancy
96
101
97
102
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.
98
103
99
-
1. If your API Management instance is deployed in a virtual network, use the boxes under **Network** to select the virtual network, subnet, and optional public IP address that are available in the location.
104
+
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.
Copy file name to clipboardExpand all lines: articles/reliability/reliability-api-management.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,7 +91,7 @@ You must use the Premium (classic) tier to configure availability zone support.
91
91
92
92
-**Autoscaling:** 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. U you simply default to the automatic availability zone support, you don't need to adjust your autoscale settings.
93
93
94
-
-**IP address requirements:** When you're enabling availability zone support on an API Management instance that's deployed in an external or internal virtual network, you must specify a public IP address resource for the instance to use. In an internal virtual network, the public IP address is used only for management operations, not for API requests. [Learn more about IP addresses of API Management](../api-management/api-management-howto-ip-addresses.md).
94
+
-**IP address requirements:** When you're enabling availability zone support on an API Management instance that's deployed in an external or internal virtual network, currently you must specify a public IP address resource for the instance to use. In an internal virtual network, the public IP address is used only for management operations, not for API requests. [Learn more about IP addresses of API Management](../api-management/api-management-howto-ip-addresses.md).
95
95
96
96
### Cost
97
97
@@ -165,13 +165,12 @@ This section describes what to expect when Azure API Management instances are co
165
165
166
166
-*Zonal:* For zonal instances, when a zone is unavailable, your instance is unavailable until the availability zone recovers.
167
167
168
-
-**Traffic rerouting:** The traffic rerouting behavior depends on the availability zone configuration that your instance uses.
169
-
<!-- Not sure about these points -->
168
+
-**Traffic rerouting:** The traffic rerouting behavior depends on the availability zone configuration that your instance uses. <!-- Not sure about these points -->
170
169
171
170
-*Automatic:* Instances that use automatic availability zone support don't automatically recover into another zone. Any units in the affected zone will be unavailable. You can choose to scale your instance to add more units
172
-
171
+
173
172
-*Zone-redundant:* For instances that are configured to be zone-redundant, when a zone is unavailable, Azure API Management detects the lost units from that zone. It automatically attempts to find new replacement units. Then, it spreads traffic across the new units as needed. <!-- Dan: Please confirm this is accurate -->
174
-
173
+
175
174
-*Zonal*: For zonal instances, when a zone is unavailable, your instance is unavailable. If you have a secondary instance in another availability zone, you're responsible for rerouting traffic to that secondary instance.
0 commit comments