Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Azure API Management service supports availability zones in both zonal and zone-redundant configurations:
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 you select within an Azure region.
Zone-redundant - the gateway and the control plane of your API Management instance (management API, developer portal, Git configuration) are replicated across two or more physically separated zones within an Azure region. Zone redundancy provides resiliency and high availability to a service instance.
This article describes three scenarios for migrating an API Management instance to availability zones. For more information about configuring API Management for high availability, see Ensure API Management availability and reliability.
Important
Changes to your API Management service's infrastructure (such as configuring custom domains, adding CA certificates, scaling, virtual network configuration, availability zone changes, and region additions) can take 15 minutes or longer to complete, depending on the service tier and the size of the deployment. Expect longer times for an instance with a greater number of scale units or multi-region configuration. Rolling changes to API Management are executed carefully to preserve capacity and availability.
While the service is updating, other service infrastructure changes can't be made. However, you can configure APIs, products, policies, and user settings. The service will not experience gateway downtime, and API Management will continue to service API requests without interruption (except in the Developer tier).
Prerequisites
To configure availability zones for API Management, your instance must be in one of the Azure regions that support availability zones.
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 quickstart. Select the Premium service tier.
If you have an existing API Management instance, make sure that it's in the Premium tier. If it isn't, upgrade to the Premium tier.
Downtime requirements
There are no gateway downtime requirements for any of the migration options.
Considerations
When you're migrating an API Management instance that's deployed in an external or internal virtual network to availability zones, you can optionally specify a new public IP address resource. 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.
Migrating to availability zones or changing the configuration of availability zones triggers a public and private IP address change.
By default, API Management sets availability zones automatically to distribute your scale units and adjust to changes in zone availability in the region. If you select specific zones, make sure the scale units distribute evenly across the zones. For example, if you select two specific zones, you can configure two units, four units, or another multiple of two units.
Important
If you select specific zones, your resources will be pinned to those zones. Should all your resources in the selected zones become unavailable, your API Management instance will be unavailable.
Note
Use capacity metrics and your own testing to decide the number of scale units that will provide the gateway performance for your needs. Adding units incurs additional costs. Learn more about scaling and upgrading your service instance.
Note
When availability zones are configured for your API Management instance, under normal operating conditions all scale units in all configured zones are active and serve gateway traffic.
If you configured autoscaling for your API Management instance in the primary ___location, you might need to adjust your autoscale settings after selecting availability zones. If you select specific zones, the number of API Management units in autoscale rules and limits must be a multiple of the number of zones.
Existing gateway ___location not injected in a virtual network
To migrate an existing ___location of your API Management instance to availability zones when the instance is not injected in a virtual network:
In the Azure portal, go to your API Management instance.
On the Deployment + infrastructure menu, select Locations.
In the Location box, select the ___location to be migrated. The ___location must support availability zones, as mentioned earlier in the prerequisites.
In the Units box, select the number of scale units that you want in the ___location.
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.
Select Apply, and then select Save.
Existing gateway ___location injected in a virtual network
To migrate an existing ___location of your API Management instance to availability zones when the instance is currently injected in a virtual network:
In the Azure portal, go to your API Management instance.
On the Deployment + infrastructure menu, select Locations.
In the Location box, select the ___location to be migrated. The ___location must support availability zones, as mentioned earlier in the prerequisites.
In the Units box, select the number of scale units that you want in the ___location.
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.
In the Public IP Address box, optionally select a public IP address in the ___location.
Select Apply, and then select Save.
New gateway ___location
To add a new ___location to your API Management instance and enable availability zones in that ___location:
If your API Management instance is deployed in a virtual network in the primary ___location, set up a virtual network, subnet, and optional public IP address in any new ___location where you plan to enable availability zones.
In the Azure portal, go to your API Management instance.
On the Deployment + infrastructure menu, select Locations.
Select + Add to add a new ___location. The ___location must support availability zones, as mentioned earlier in the prerequisites.
In the Units box, select the number of scale units that you want in the ___location.
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.
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.
Select Add, and then select Save.
