You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/api-management-howto-autoscale.md
+12-13Lines changed: 12 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,19 @@
1
1
---
2
-
# Mandatory fields. See more on aka.ms/skyeye/meta.
3
2
title: Configure autoscale of an Azure API Management instance | Microsoft Docs
4
-
description: This article describes how to set up autoscale behavior for an Azure API Management instance.
3
+
description: This article describes how to set up rules to control autoscale behavior for an Azure API Management instance.
5
4
services: api-management
6
5
author: dlepow
7
6
8
7
ms.service: api-management
9
8
ms.topic: how-to
10
-
ms.date: 03/30/2023
9
+
ms.date: 02/06/2024
11
10
ms.author: danlep
12
11
ms.custom: engagement-fy23
13
12
---
14
13
15
14
# Automatically scale an Azure API Management instance
16
15
17
-
An Azure API Management service instance can scale automatically based on a set of rules. This behavior can be enabled and configured through [Azure Monitor autoscale](../azure-monitor/autoscale/autoscale-overview.md#supported-services-for-autoscale) and is currently supported only in the **Standard** and **Premium** tiers of the Azure API Management service.
16
+
An Azure API Management service instance can scale automatically based on a set of rules. This behavior can be enabled and configured through [Azure Monitor autoscale](../azure-monitor/autoscale/autoscale-overview.md#supported-services-for-autoscale) and is currently supported only in the **Basic**, **Standard**, and **Premium** tiers of the Azure API Management service.
18
17
19
18
The article walks through the process of configuring autoscale and suggests optimal configuration of autoscale rules.
20
19
@@ -31,13 +30,13 @@ To follow the steps from this article, you must:
31
30
+ Understand the concept of [capacity](api-management-capacity.md) of an API Management instance.
32
31
+ Understand [manual scaling](upgrade-and-scale.md) of an API Management instance, including cost consequences.
Certain limitations and consequences of scaling decisions need to be considered before configuring autoscale behavior.
39
38
40
-
+ The pricing tier of your API Management instance determines the [maximum number of units](upgrade-and-scale.md#upgrade-and-scale) you may scale to. For example, the **Standard tier** can be scaled to 4 units. You can add any number of units to the **Premium** tier.
39
+
+ The [pricing tier](api-management-features.md) of your API Management instance determines the [maximum number of units](upgrade-and-scale.md#upgrade-and-scale) you may scale to. For example, the **Standard tier** can be scaled to 4 units. You can add any number of units to the **Premium** tier.
41
40
+ The scaling process takes at least 20 minutes.
42
41
+ If the service is locked by another operation, the scaling request will fail and retry automatically.
43
42
+ If your service instance is deployed in multiple regions (locations), only units in the **Primary location** can be autoscaled with Azure Monitor autoscale. Units in other locations can only be scaled manually.
@@ -58,16 +57,16 @@ Follow these steps to configure autoscale for an Azure API Management service:
58
57
59
58
1. Define a new scale-out rule.
60
59
61
-
For example, a scale-out rule could trigger addition of 1 API Management unit, when the average capacity metric over the previous 30 minutes exceeds 80%. The following table provides configuration for such a rule.
60
+
For example, a scale-out rule could trigger addition of 1 API Management unit, when the average capacity metric over the previous 30 minutes exceeds 80%. The following table provides an example configuration for such a rule. Review the preceding [limitations](#azure-api-management-autoscale-limitations) when defining a scale-out rule in your environment.
| Metric source | Current resource | Define the rule based on the current API Management resource metrics. |
66
65
|*Criteria*|||
67
-
| Metric name | Capacity | Capacity metric is an API Management metric reflecting usage of resources by an Azure API Management instance. |
66
+
| Metric name | Capacity |[Capacity metric](api-management-capacity.md) is an API Management metric reflecting usage of resources by an Azure API Management instance. |
68
67
| Location | Select the primary location of the API Management instance ||
69
68
| Operator | Greater than ||
70
-
| Metric threshold |80% | The threshold for the averaged capacity metric. |
69
+
| Metric threshold |70% | The threshold for the averaged capacity metric. For considerations on setting this threshold, see [Using capacity for scaling decisions](api-management-capacity.md#use-capacity-for-scaling-decisions).|
71
70
| Duration (in minutes) | 30 | The timespan to average the capacity metric over is specific to usage patterns. The longer the duration, the smoother the reaction will be. Intermittent spikes will have less effect on the scale-out decision. However, it will also delay the scale-out trigger. |
72
71
| Time grain statistic | Average ||
73
72
|*Action*|||
@@ -78,11 +77,11 @@ Follow these steps to configure autoscale for an Azure API Management service:
78
77
1. Select **Add** to save the rule.
79
78
1. To add another rule, select **Add a rule**.
80
79
81
-
This time, a scale-in rule needs to be defined. It will ensure resources aren't being wasted, when the usage of APIs decreases.
80
+
This time, a scale-in rule needs to be defined. It ensures that resources aren't being wasted, when the usage of APIs decreases.
82
81
83
82
1. Define a new scale-in rule.
84
83
85
-
For example, a scale-in rule could trigger a removal of 1 API Management unit when the average capacity metric over the previous 30 minutes has been lower than 35%. The following table provides configuration for such a rule.
84
+
For example, a scale-in rule could trigger a removal of 1 API Management unit when the average capacity metric over the previous 30 minutes is lower than 35%. The following table provides an example configuration for such a rule.
@@ -108,9 +107,9 @@ Follow these steps to configure autoscale for an Azure API Management service:
108
107
109
108
:::image type="content" source="media/api-management-howto-autoscale/07.png" alt-text="Screenshot showing how to set instance limits in the portal.":::
110
109
111
-
1. Select **Save**. Your autoscale has been configured.
110
+
1. Select **Save**. Your autoscale is configured.
112
111
113
-
## Next steps
112
+
## Related content
114
113
115
114
-[How to deploy an Azure API Management service instance to multiple Azure regions](api-management-howto-deploy-multi-region.md)
116
115
-[Optimize and save on your cloud spending](../cost-management-billing/costs/quick-acm-cost-analysis.md?WT.mc_id=costmanagementcontent_docsacmhorizontal_-inproduct-learn)
> This feature is available in the **Premium**, **Standard**, and **Basic** tiers of API Management.
13
+
>
14
+
> For feature availability in the v2 tiers (preview), see the [v2 tiers overview](../articles/api-management/v2-service-tiers-overview.md#features-and-limitations).
0 commit comments