Skip to content

Commit 1d08857

Browse files
Merge pull request #304630 from johndowns/reliability-apim-update
Reliability guide - API Management - Minor updates
2 parents 54cbd34 + e901d2f commit 1d08857

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

articles/reliability/reliability-api-management.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ With availability zone support, API Management replicates service components acr
6868

6969
You can use automatic availability zone support to choose either a single unit or multiunit instance configuration to achieve zone redundancy:
7070

71-
- **Multiunit configuration** (Recommended): If your instance has two or more units, API Management 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. For maximum benefit of availability zones, we recommend that you deploy a minimum of three units, which can be distributed across all available zones in a region.
71+
- **Multiunit configuration** (Recommended): If your instance has two or more units, API Management 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. We recommend that you deploy a minimum of two units, which can be distributed across two zones.
72+
73+
The following diagram shows an API Management instance with three units that's configured for automatic availability zone support:
7274

7375
:::image type="complex" border="false" source="./media/reliability-api-management/zone-redundant-automatic-multi-unit.png" alt-text="Diagram that shows three API Management units distributed across availability zones for automatic availability zone support." lightbox="./media/reliability-api-management/zone-redundant-automatic-multi-unit.png":::
7476
The diagram shows three boxes labeled Unit 1, Unit 2, and Unit 3 deployed in an API Management instance. Each unit box contains two icons that represent VMs. Three larger boxes are labeled Availability Zone 1, Availability Zone 2, and Availability Zone 3. Zone 1 contains unit 1, zone 2 contains unit 2, and zone 3 contains unit 3.
@@ -114,7 +116,7 @@ You must use the Premium (classic) tier to configure availability zone support.
114116

115117
- **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.
116118

117-
If you use the automatic availability zone support, there's no requirement to use a specific number of units. The units that 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.
119+
If you use the automatic availability zone support, there's no requirement to use a specific number of units. The units that you deploy are distributed among the availability zones in a best-effort manner. For maximum zone redundancy, we recommend that you use at least two units to ensure that an availability zone outage doesn't affect your instance.
118120

119121
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 API Management instance](/azure/api-management/upgrade-and-scale).
120122

@@ -179,7 +181,9 @@ This section describes what to expect when API Management instances are configur
179181

180182
- **Active requests:** When an availability zone is unavailable, any requests in progress that are connected to an API Management unit in the faulty availability zone are terminated and need to be retried.
181183

182-
- **Notification:** Zone-level outages are reflected in Azure Resource Health and Azure Service Health.
184+
- **Notification**: Azure API Management doesn't notify you when a zone is down. However, you can use [Azure Resource Health](/azure/service-health/resource-health-overview) to monitor for the health of your gateway. You can also use [Azure Service Health](/azure/service-health/overview) to understand the overall health of the Azure API Management service, including any zone failures.
185+
186+
Set up alerts on these services to receive notifications of zone-level problems. For more information, see [Create Service Health alerts in the Azure portal](/azure/service-health/alerts-activity-log-service-notifications-portal) and [Create and configure Resource Health alerts](/azure/service-health/resource-health-alert-arm-template-guide).
183187

184188
- **Expected data loss:** API Management stores the following data.
185189

0 commit comments

Comments
 (0)