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
#Customer intent: As an engineer responsible for business continuity, I want to learn how to enable zone redundancy for my Azure API Management instances.
@@ -30,23 +30,28 @@ 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 a new region](api-management-howto-deploy-multi-region.md), availability zones are automatically enabled **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
+
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), API Management offers two types of availability zone support:
34
34
35
-
Under normal operating conditions, all scale units in all enabled zones are active and serve gateway traffic.
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.
36
38
37
39
> [!IMPORTANT]
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).
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
39
43
40
-
## Manually configure availability zone support for an existing gateway location
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.
41
45
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.
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).
43
48
44
49
> [!CAUTION]
45
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.
46
51
47
-
### Gateway not injected in a virtual network
52
+
### Instance not injected in a virtual network
48
53
49
-
To manually enable availability zone support on an existing location of an API Management instance that's not injected in a virtual network:
54
+
To manually configure availability zone support on an existing location of an API Management instance:
50
55
51
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).
52
57
@@ -64,13 +69,13 @@ To manually enable availability zone support on an existing location of an API M
64
69
65
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":::
66
71
67
-
### Gateway injected in a virtual network
72
+
### Instance injected in a virtual network
68
73
69
-
To manually enable 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:
70
75
71
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).
72
77
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).
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).
74
79
75
80
1. In the Azure portal, go to your API Management instance.
76
81
@@ -90,7 +95,7 @@ To manually enable availability zone support on an existing location of an API M
90
95
91
96
## New gateway location
92
97
93
-
To add a new location to your API Management instance and to manually enable availability support in that location:
98
+
To add a new location to your API Management instance and to configure availability zones in that location:
94
99
95
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).
@@ -69,9 +69,9 @@ With automatic availability zone support, you can choose either a single unit or
69
69
70
70
If you want to explicitly select the availability zones to use, you can choose between zone-redundant and zonal configurations:
71
71
72
-
-*Zone-redundant*: Manually configure zone redundancy for an API Management instance in a supported region to provide redundancy for all service components, including the gateway, management plane, and developer portal. When you select two or more availability zones to use, Azure automatically replicates the service components across the selected zones.
72
+
-*Zone-redundant*: Manually configure zone redundancy for an API Management instance in a supported region to provide redundancy for service components. In the primary region, these components include the gateway, management plane, and developer portal. In secondary regions, only the gateway is replicated. When you select two or more availability zones to use, Azure automatically replicates the service components across the selected zones.
73
73
74
-
-*Zonal*: The API Management gateway and the control plane of your API Management instance (management API, developer portal, Git configuration) are deployed in a single zone that you select within an Azure region. All of the units are placed into the same availability zone.
74
+
-*Zonal*: The API Management service components are deployed in a single zone that you select within an Azure region. All of the units are placed into the same availability zone.
75
75
76
76
> [!IMPORTANT]
77
77
> Pinning to a single availability zone is only recommended when [cross-zone latency](./availability-zones-overview.md#inter-zone-latency) is too high for your needs, and when you have verified that the latency doesn't meet your requirements. By itself, a zonal instance doesn’t provide resiliency to an availability zone outage. To improve the resiliency of a zonal API Management deployment, you need to explicitly deploy separate instances into multiple availability zones and configure traffic routing and failover.
@@ -91,11 +91,11 @@ You must use the Premium (classic) tier to configure availability zone support.
91
91
92
92
-**Number of units for zone-redundant instances:** If you manually configure zone redundancy for an instance, you also need to configure a number of API Management units that can be distributed evenly across all of your selected availability zones. For example, if you select two zones, you must configure at least two units. You can instead configure four units, or another multiple of two units. If you select three availability zones, you must configure three units, six units, or another multiple of three units.
93
93
94
-
If you simply default to the automatic availability zone support, there's no requirement to use a specific number of units. The units you deploy are distributed among the availability zones in a best-effort manner. For maximum zone redundancy, we recommend that you use at least three units to ensure that an availability zone outage doesn't affect your instance.
94
+
If you simply use the automatic availability zone support, there's no requirement to use a specific number of units. The units you deploy are distributed among the availability zones in a best-effort manner. For maximum zone redundancy, we recommend that you use at least three units to ensure that an availability zone outage doesn't affect your instance.
95
95
96
96
To determine the number of units that provide your required gateway performance, use [capacity metrics](/azure/api-management/api-management-capacity) and your own testing. For more information about scaling and upgrading your service instance, see [Upgrade and scale an Azure API Management instance](/azure/api-management/upgrade-and-scale).
97
97
98
-
-**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. If you simply default to the automatic availability zone support, you don't need to adjust your autoscale settings.
98
+
-**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. If you simply use the automatic availability zone support, you don't need to adjust your autoscale settings.
99
99
100
100
-**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).
101
101
@@ -110,7 +110,7 @@ This section explains how to configure availability zone support for your Azure
110
110
> [!NOTE]
111
111
> [!INCLUDE [Availability zone numbering](./includes/reliability-availability-zone-numbering-include.md)]
112
112
113
-
-**Create an API Management instance with availability zone support:** When you create a Premium (classic) API Management instance in a region that supports availability zones, by default it's created with automatic availability zone support. You can optionally select whether the instance is zonal or zone-redundant.
113
+
-**Create an API Management instance with availability zone support:** When you create a Premium (classic) API Management instance in a region that supports availability zones, by default it's created with availability zone support. You can select automatic availability zone support or manually configure zonal or zone-redundant support.
114
114
115
115
-**Enable or reconfigure availability zone support:** You can change the availability zone configuration for an API Management instance, including adding availability zones and moving a zonal instance between availability zones. To configure availability zone support on an API Management instance, see [Enable availability zone support on Azure API Management instances](../api-management/enable-availability-zone-support.md). There are no downtime requirements for any of the configuration options.
0 commit comments