Skip to content

Commit ebe4012

Browse files
committed
rough draft
1 parent e0a1f79 commit ebe4012

File tree

2 files changed

+39
-16
lines changed

2 files changed

+39
-16
lines changed

articles/api-management/TOC.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@
6666
href: api-management-howto-policies.md
6767
- name: Self-hosted gateway
6868
href: self-hosted-gateway-overview.md
69+
- name: High availability
70+
href: high-availability.md
71+
displayName: reliability, resilience, resiliency
6972
- name: Networking
7073
href: virtual-network-concepts.md
7174
- name: Security
@@ -76,6 +79,7 @@
7679
href: /security/benchmark/azure/baselines/api-management-security-baseline?toc=/azure/api-management/&bc=/azure/api-management/breadcrumb/toc.json
7780
- name: Observability
7881
href: observability.md
82+
displayName: monitoring
7983
- name: APIs
8084
items:
8185
- name: API design ebook

articles/api-management/high-availability.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,51 +16,70 @@ This article introduces service capabilities and considerations to ensure that y
1616

1717
API Management supports the following key service capabilities that are recommended for [reliable](../availability-zones/overview.md) Azure solutions. Use them individually, or together, to improve the availability of your API Management solution:
1818

19-
* Availability zones, to provide resilience to datacenter-level outages
20-
* Multiregion deployment, to provide resilience to regional outages.
19+
* **Availability zones**, to provide resilience to datacenter-level outages
2120

22-
[!INCLUDE [premium.md](../../includes/api-management-availability-premium.md)]
21+
* **Multi-region deployment**, to provide resilience to regional outages
2322

23+
[!INCLUDE [premium.md](../../includes/api-management-availability-premium.md)]
2424

2525
## Availability zones
2626

27-
Azure [availability zones](../availability-zones/az-overview.md) are physically separate locations within an Azure region that are tolerant to datacenter-level failures. To ensure resiliency, a minimum of three separate availability zones are present in all availability zone-enabled regions.
27+
Azure [availability zones](../availability-zones/az-overview.md) are physically separate locations within an Azure region that are tolerant to datacenter-level failures. Each zone is composed of one or more datacenters equipped with independent power, cooling, and networking infrastructure. To ensure resiliency, a minimum of three separate availability zones are present in all availability zone-enabled regions.
28+
2829

30+
Enabling [zone redundancy](../availability-zones/migrate-api-mgt.md) for an API Management instance in a supported region provides redundancy for all [service components](api-management-key-concepts.md#api-management-components): gateway, management plane, and developer portal. Azure automatically replicates all service components across the zones that you select.
2931

30-
When enabling [zone redundancy](../availability-zones/migrate-api-mgt.md) for an API Management instance in a supported region, consider the number of [units] you want. Minimally, select the same number of units as the number of availability zones you want to enable, or a multiple so that the units are distributed evenly across the zones. For example, if you selected 3 units, select 3 zones so that each zone hosts one unit.
32+
When you enable zone redundancy in a region, consider the number of API Mangement scale [units](upgrade-and-scale.md) that need to be distributed. Minimally, configure the same number of units as the number of availability zones, or a multiple so that the units are distributed evenly across the zones. For example, if you select 3 availability zones in a region, you could have 3 units so that each zone hosts one unit.
3133

3234
> [!NOTE]
33-
> Use the [capacity](api-management-capacity.md) metric and your own testing to decide on the number of service units that will provide the required gateway performance. Learn more about [scaling and upgrading](upgrade-and-scale.md) your service instance.
35+
> Use the [capacity](api-management-capacity.md) metric and your own testing to decide on the number of scale units that will provide the gateway performance for your needs. Learn more about [scaling and upgrading](upgrade-and-scale.md) your service instance.
3436
35-
## Multiregion deployment
37+
## Multi-region deployment
3638

37-
With [multiregion deployment](api-management-howto-deploy-multi-regions.md), API publishers can add gateways to their API Management instance in any number of supported Azure regions. The service instance's management plane and developer portal remain hosted only in the *primary* region, the region originally used for the service deployment. Gateway configurations such as APIs and policy definitions are regularly synchronized between the gateways in the primary and secondary regions.
39+
With [multi-region deployment](api-management-howto-deploy-multi-regions.md), you add regional gateways to your existing API Management instance in any number of supported Azure regions. The service instance's management plane and developer portal remain hosted only in the *primary* region, the region where you originally deployed the service. Gateway configurations such as APIs and policy definitions are regularly synchronized between the primary and secondary regions you add.
3840

3941

40-
* Multiregion deployment ensures the availability of the API gateway in more than one region, providing service availability if one region goes offline
42+
* Multi-region deployment ensures the availability of the API gateway in more than one region and provides service availability if one region goes offline.
4143

42-
* API Management routes API requests to regional gateways based on lowest latency, which can reduce latency experienced by geographically distributed API consumers
44+
* API Management routes API requests to regional gateways based on lowest latency, which can reduce latency experienced by geographically distributed API consumers.
4345

4446
* If a region goes offline, API requests are automatically routed around the failed region to the next closest gateway.
4547

4648
* If the primary region goes offline, the API Management management plane and developer portal become unavailable, but secondary regions continue to serve API requests using the most recent gateway configuration.
4749

48-
## Availability zones
50+
## Combine availability zones and multi-region deployment
51+
52+
The combination of availability zones for redundancy within a region, and multi-region deployments to improve the gateway availability if there is a regional outage, helps enhance both the reliability and performance of your API Management instance.
53+
54+
Examples:
55+
56+
* Use availability zones to improve the resilience of the primary region in a multi-region deployment
57+
58+
* Distribute scale units across availability zones and regions to enhance regional gateway performance
4959

50-
Optionally enable [zone redundancy](../availability-zones/migrate-api-mgt.md) to improve the availability and resiliency of the Primary or Secondary regions.
5160

5261
## SLA considerations
5362

54-
API Management provides an SLA of 99.99% when you deploy at least one unit in two or more availability zones or regions.
63+
API Management provides an SLA of 99.99% when you deploy at least one unit in two or more availability zones or regions. For more information, see [Pricing](https://azure.microsoft.com/pricing/details/api-management/).
5564

5665
> [!NOTE]
57-
> While Azure continually strives for highest possible resiliency in SLA for the cloud platform, you must define your own target SLAs for other components of your solution, such as backend APIs.
66+
> While Azure continually strives for highest possible resiliency in SLA for the cloud platform, you must define your own target SLAs for other components of your solution.
67+
68+
## Backend availability
69+
70+
Depending on where and how your backend services are hosted, you may need to set up redundant backends in different regions to meet your requirements for service availability. You can manage backend failover through API Management to maintain availability. For example:
71+
72+
* In multi-region deployments, use [policies to route requests](api-management-howto-deploy-multi-region.md#-route-api-calls-to-regional-backend-services) through regional gateways to regional backends.
5873

74+
* Configure policies to route requests conditionally to different backends in case of backend failure in a particular region.
5975

76+
* Use caching to reduce failing calls.
6077

61-
API Management routes the requests to a regional _gateway_ based on [the lowest latency](../traffic-manager/traffic-manager-routing-methods.md#performance). Although it is not possible to override this setting in API Management, you can use your own Traffic Manager with custom routing rules.
78+
For details, see the blog post [Back-end API redundancy with Azure API Manager](https://devblogs.microsoft.com/premier-developer/back-end-api-redundancy-with-azure-api-manager/).
6279

6380
## Next steps
6481

6582
* Learn more about [resiliency in Azure](../availability-zones/overview.md)
66-
* Learn more about [designing reliable Azure applications](/azure/architecture/framework/resiliency/app-design)
83+
* Learn more about [designing reliable Azure applications](/azure/architecture/framework/resiliency/app-design)
84+
* Read [API Management and reliability](/azure/architecture/framework/services/networking/api-management/reliability) in the Azure Well-Architected Framework
85+
*

0 commit comments

Comments
 (0)