Skip to content

Commit d8f4808

Browse files
author
gitName
committed
Az doc updates; move images
1 parent 40cf4c0 commit d8f4808

File tree

5 files changed

+18
-14
lines changed

5 files changed

+18
-14
lines changed

articles/api-management/enable-availability-zone-support.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,20 @@ For more detailed information about reliability features of API Management, such
2828

2929
* 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).
3030

31+
## Default availability zone support
3132

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.
3334

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.
3541

3642
### Gateway not injected in a virtual network
3743

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:
3945

4046
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).
4147

@@ -51,16 +57,15 @@ To enable zone-redundancy on an existing location of an API Management instance
5157

5258
1. Select **Apply**, and then select **Save**.
5359

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":::
5561

5662
### Gateway injected in a virtual network
5763

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:
6065

6166
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).
6267

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).
6469

6570
1. In the Azure portal, go to your API Management instance.
6671

@@ -72,7 +77,7 @@ To migrate an existing location of your API Management instance to availability
7277

7378
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.
7479

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.
7681

7782
1. Select **Apply**, and then select **Save**.
7883

@@ -96,7 +101,7 @@ To add a new location to your API Management instance and enable zone redundancy
96101

97102
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.
98103

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.
100105

101106
1. Select **Add**, and then select **Save**.
102107

articles/reliability/reliability-api-management.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ You must use the Premium (classic) tier to configure availability zone support.
9191

9292
- **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.
9393

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).
9595

9696
### Cost
9797

@@ -165,13 +165,12 @@ This section describes what to expect when Azure API Management instances are co
165165

166166
- *Zonal:* For zonal instances, when a zone is unavailable, your instance is unavailable until the availability zone recovers.
167167

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 -->
170169

171170
- *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+
173172
- *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+
175174
- *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.
176175

177176
### Failback

0 commit comments

Comments
 (0)