|
| 1 | +--- |
| 2 | +title: Enable availability zones for Azure API Management instances |
| 3 | +description: Learn how to enable availability zone support on your Premium tier Azure API Management instances. |
| 4 | +author: dlepow |
| 5 | +ms.service: azure-api-management |
| 6 | +ms.topic: how-to |
| 7 | +ms.date: 07/17/2025 |
| 8 | +ms.author: danlep |
| 9 | +ms.custom: references_regions, subject-reliability |
| 10 | +#Customer intent: As an engineer responsible for business continuity, I want to learn how to enable zone redundancy for my Azure API Management instances. |
| 11 | +--- |
| 12 | + |
| 13 | +# Enable availability zone support on Azure API Management instances |
| 14 | + |
| 15 | +[!INCLUDE [premium.md](../../includes/api-management-availability-premium.md)] |
| 16 | + |
| 17 | +This how-to guide shows you how to enable and configure availability zones on an API Management instance. |
| 18 | + |
| 19 | +For more detailed information about reliability features of API Management, such as availability zones and multi-region deployments, see [Reliability in Azure API Management](../reliability/reliability-api-management.md). |
| 20 | + |
| 21 | +[!INCLUDE [api-management-service-update-behavior](../../includes/api-management-service-update-behavior.md)] |
| 22 | + |
| 23 | +## Prerequisites |
| 24 | + |
| 25 | +* To configure availability zones for API Management, your instance must be in one of the [Azure regions that support availability zones](../reliability/regions-list.md). |
| 26 | + |
| 27 | +* If you don't have an API Management instance, create one by following the [Create a new Azure API Management instance by using the Azure portal](../api-management/get-started-create-service-instance.md) quickstart. Select the **Premium** service tier. |
| 28 | + |
| 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 | + |
| 31 | +## Default availability zone support |
| 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 offers two types of availability zone support: |
| 34 | + |
| 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. |
| 38 | + |
| 39 | +> [!IMPORTANT] |
| 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 |
| 43 | + |
| 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. |
| 45 | + |
| 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). |
| 48 | +
|
| 49 | +> [!CAUTION] |
| 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. |
| 51 | +
|
| 52 | +### Instance not injected in a virtual network |
| 53 | + |
| 54 | +To manually configure availability zone support on an existing location of an API Management instance: |
| 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). |
| 57 | + |
| 58 | +1. In the Azure portal, go to your API Management instance. |
| 59 | + |
| 60 | +1. On the **Deployment + infrastructure** menu, select **Locations**. |
| 61 | + |
| 62 | +1. In the **Location** box, select the location to be enabled. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites). |
| 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. |
| 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 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. |
| 67 | + |
| 68 | +1. Select **Apply**, and then select **Save**. |
| 69 | + |
| 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"::: |
| 71 | + |
| 72 | +### Instance injected in a virtual network |
| 73 | + |
| 74 | +To manually configure availability zone support on an existing location of an API Management instance that's injected in a virtual network: |
| 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). |
| 77 | + |
| 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). |
| 79 | + |
| 80 | +1. In the Azure portal, go to your API Management instance. |
| 81 | + |
| 82 | +1. On the **Deployment + infrastructure** menu, select **Locations**. |
| 83 | + |
| 84 | +1. In the **Location** box, select the location to be enabled. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites). |
| 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. |
| 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 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. |
| 89 | + |
| 90 | +1. In the **Public IP Address** box, select a public IP address in the location. |
| 91 | + |
| 92 | +1. Select **Apply**, and then select **Save**. |
| 93 | + |
| 94 | +:::image type="content" alt-text="Screenshot that shows availability zone configuration for an existing location of API Management instance that's injected in a virtual network." source ="media/enable-availability-zone-support/option-three-stv2-injected-in-vnet.png"::: |
| 95 | + |
| 96 | +## New gateway location |
| 97 | + |
| 98 | +To add a new location to your API Management instance and to configure availability zones in that location: |
| 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). |
| 101 | + |
| 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 | + |
| 104 | +1. In the Azure portal, go to your API Management instance. |
| 105 | + |
| 106 | +1. On the **Deployment + infrastructure** menu, select **Locations**. |
| 107 | + |
| 108 | +1. Select **+ Add** to add a new location. The location must support availability zones, as mentioned earlier in the [prerequisites](#prerequisites). |
| 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. |
| 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 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. |
| 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. |
| 115 | + |
| 116 | +1. Select **Add**, and then select **Save**. |
| 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"::: |
| 119 | + |
| 120 | +## Related content |
| 121 | + |
| 122 | +- [Reliability in API Management](../reliability/reliability-api-management.md) |
| 123 | +- [Architecture best practices for API Management](/azure/well-architected/service-guides/azure-api-management) |
| 124 | +- [Design review checklist for reliability](/azure/architecture/framework/resiliency/app-design) |
| 125 | +- [Azure services with availability zones](../reliability/availability-zones-service-support.md) |
| 126 | +- [Azure regions with availability zones](../reliability/regions-list.md) |
0 commit comments