Skip to content

Commit 7791c12

Browse files
Merge pull request #300770 from dlepow/wkspcas
[APIM] Workspace gateway autoscaling
2 parents 421f972 + 35e8cf9 commit 7791c12

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

articles/api-management/api-management-howto-autoscale.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 02/06/2024
9+
ms.date: 06/03/2025
1010
ms.author: danlep
1111
ms.custom: engagement-fy23
1212
---
@@ -22,7 +22,6 @@ The article walks through the process of configuring autoscale and suggests opti
2222
> [!NOTE]
2323
> * In service tiers that support multiple scale units, you can also [manually scale](upgrade-and-scale.md) your API Management instance.
2424
> * An API Management service in the **Consumption** tier scales automatically based on the traffic - without any additional configuration needed.
25-
> * Currently, autoscale is not supported for the [workspace gateway](workspaces-overview.md#workspace-gateway) in API Management workspaces.
2625
2726
[!INCLUDE [api-management-service-update-behavior](../../includes/api-management-service-update-behavior.md)]
2827

@@ -41,15 +40,15 @@ Certain limitations and consequences of scaling decisions need to be considered
4140

4241
+ 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.
4342
+ If the service is locked by another operation, the scaling request will fail and retry automatically.
44-
+ 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.
45-
+ If your service instance is configured with [availability zones](zone-redundancy.md) in the **Primary location**, be aware of the number of zones when configuring autoscaling. The number of API Management units in autoscale rules and limits must be a multiple of the number of zones.
43+
+ 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 be scaled manually or using custom scaling tools.
44+
+ If your service instance is configured with [availability zones](zone-redundancy.md) in the **Primary location**, we recommend leaving the default **Automatic** setting for 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 configured.
4645

4746
## Enable and configure autoscale for an API Management instance
4847

4948
Follow these steps to configure autoscale for an Azure API Management service:
5049

5150
1. Sign in to the [Azure portal](https://portal.azure.com), and navigate to your API Management instance.
52-
1. In the left menu, select **Scale out (auto-scale)**, and then select **Custom autoscale**.
51+
1. In the left menu, select **Deployment + infrastructure** > **Scale out (auto-scale)**, and then select **Custom autoscale**.
5352

5453
:::image type="content" source="media/api-management-howto-autoscale/01.png" alt-text="Screenshot of scale-out options in the portal.":::
5554

articles/api-management/upgrade-and-scale.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 07/02/2024
9+
ms.date: 06/03/2025
1010
ms.author: danlep
1111
ms.custom:
1212
- engagement-fy23
@@ -20,7 +20,7 @@ ms.custom:
2020
Customers can scale an Azure API Management instance in a dedicated service tier by adding and removing units. A **unit** is composed of dedicated Azure resources and has a certain load-bearing capacity expressed as a number of API calls per second. This number doesn't represent a call limit, but rather an estimated maximum throughput value to allow for rough capacity planning. Actual throughput and latency vary broadly depending on factors such as number and rate of concurrent connections, the kind and number of configured policies, request and response sizes, and backend latency.
2121

2222
> [!NOTE]
23-
> * In the **Basic**, **Standard**, and **Premium** tiers of the API Management service, you can configure an instance to [scale automatically](api-management-howto-autoscale.md) based on a set of rules.
23+
> * In the **Basic**, **Standard**, and **Premium** tiers of the API Management service, and in [workspace gateways](workspaces-overview.md#workspace-gateway), you can configure an instance to [scale automatically](api-management-howto-autoscale.md) based on a set of rules.
2424
> * API Management instances in the **Consumption** tier scale automatically based on the traffic. Currently, you cannot upgrade from or downgrade to the Consumption tier.
2525
2626
The throughput and price of each unit depend on the [service tier](api-management-features.md) in which the unit exists. If you need to increase capacity for a service within a tier, you should add a unit. If the tier that is currently selected in your API Management instance doesn't allow adding more units, you need to upgrade to a higher-level tier.

articles/api-management/workspaces-overview.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: concept-article
9-
ms.date: 05/14/2025
9+
ms.date: 06/03/2025
1010
ms.author: danlep
1111
#customer intent: As administrator of an API Management instance, I want to learn about using workspaces to manage APIs in a decentralized way, so that I can enable my development teams to manage and productize their own APIs.
1212
ms.custom:
@@ -112,7 +112,7 @@ For detailed requirements, see [Network resource requirements for workspace gate
112112

113113
### Scale capacity
114114

115-
Manage gateway capacity by manually adding or removing scale units, similar to the [units](upgrade-and-scale.md) that can be added to the API Management instance in certain service tiers. The costs of a workspace gateway are based on the number of units you select.
115+
Manage gateway capacity by adding or removing scale units, similar to the [units](upgrade-and-scale.md) that can be added to the API Management instance in certain service tiers. The costs of a workspace gateway are based on the number of units you select.
116116

117117
### Regional availability
118118

@@ -131,7 +131,6 @@ The following constraints currently apply to workspace gateways:
131131
* Workspace gateways don't support creating APIs directly from Azure resources such as Azure OpenAI Service, App Service, Function Apps, and so on
132132
* Request metrics can't be split by workspace in Azure Monitor; all workspace metrics are aggregated at the service level
133133
* Workspace gateways don't support CA certificates
134-
* Workspace gateways don't support autoscaling
135134
* Workspace gateways don't support managed identities, including related features like storing secrets in Azure Key Vault and using the `authentication-managed-identity` policy
136135

137136
## RBAC roles for workspaces

0 commit comments

Comments
 (0)