Skip to content

Commit c6da936

Browse files
authored
Merge pull request #210610 from dlepow/freshscale
[APIM] Freshness: Upgrade and scale
2 parents ff85000 + f84829a commit c6da936

File tree

2 files changed

+37
-42
lines changed

2 files changed

+37
-42
lines changed

articles/api-management/troubleshoot-response-timeout-and-errors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ General strategies for mitigating SNAT port exhaustion are discussed in [Trouble
3939

4040
### Scale your APIM instance
4141

42-
Each API Management instance is allocated a number of SNAT ports, based on APIM units. You can allocate additional SNAT ports by scaling your API Management instance with additional units. For more info, see [Scale your API Management service](upgrade-and-scale.md#scale-your-api-management-service)
42+
Each API Management instance is allocated a number of SNAT ports, based on APIM units. You can allocate additional SNAT ports by scaling your API Management instance with additional units. For more info, see [Scale your API Management service](upgrade-and-scale.md#scale-your-api-management-instance).
4343

4444
> [!NOTE]
4545
> SNAT port usage is currently not available as a metric for autoscaling API Management units.
@@ -79,4 +79,4 @@ See [API Management access restriction policies](api-management-access-restricti
7979
## See also
8080

8181
* [Azure Load Balancer: Troubleshooting outbound connections failures](../load-balancer/troubleshoot-outbound-connection.md)
82-
* [Azure App Service: Troubleshooting intermittent outbound connection errors](../app-service/troubleshoot-intermittent-outbound-connection-errors.md)
82+
* [Azure App Service: Troubleshooting intermittent outbound connection errors](../app-service/troubleshoot-intermittent-outbound-connection-errors.md)

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

Lines changed: 35 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,80 @@
11
---
2-
# Mandatory fields. See more on aka.ms/skyeye/meta.
32
title: Upgrade and scale an Azure API Management instance | Microsoft Docs
4-
description: This topic describes how to upgrade and scale an Azure API Management instance.
5-
services: api-management
6-
documentationcenter: ''
3+
description: This article describes how to upgrade and scale an Azure API Management instance.
74
author: dlepow
8-
manager: anneta
9-
editor: ''
5+
106

117
ms.service: api-management
12-
ms.workload: integration
13-
ms.topic: article
14-
ms.date: 04/20/2020
8+
ms.topic: how-to
9+
ms.date: 09/14/2022
1510
ms.author: danlep
1611
---
1712

1813
# Upgrade and scale an Azure API Management instance
1914

20-
Customers can scale an Azure API Management instance 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 month. This number does not represent a call limit, but rather a 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.
15+
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.
16+
17+
[!INCLUDE [premium-dev-standard-basic.md](../../includes/api-management-availability-premium-dev-standard-basic.md)]
2118

22-
Capacity and price of each unit depends on the **tier** in which the unit exists. You can choose between four tiers: **Developer**, **Basic**, **Standard**, **Premium**. 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 does not allow adding more units, you need to upgrade to a higher-level tier.
19+
> [!NOTE]
20+
> API Management instances in the **Consumption** tier scale automatically based on the traffic. Currently, you cannot upgrade from or downgrade to the Consumption tier.
2321
24-
The price of each unit and the available features (for example, multi-region deployment) depends on the tier that you chose for your API Management instance. The [pricing details](https://azure.microsoft.com/pricing/details/api-management/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio) article, explains the price per unit and features you get in each tier.
22+
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.
2523

2624
>[!NOTE]
27-
>The [pricing details](https://azure.microsoft.com/pricing/details/api-management/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio) article shows approximate numbers of unit capacity in each tier. To get more accurate numbers, you need to look at a realistic scenario for your APIs. See the [Capacity of an Azure API Management instance](api-management-capacity.md) article.
25+
>See [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio) for features, scale limits, and estimated throughput in each tier. To get more accurate throughput numbers, you need to look at a realistic scenario for your APIs. See [Capacity of an Azure API Management instance](api-management-capacity.md).
2826
2927
## Prerequisites
3028

3129
To follow the steps from this article, you must:
3230

33-
+ Have an active Azure subscription.
34-
35-
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
36-
37-
+ Have an API Management instance. For more information, see [Create an Azure API Management instance](get-started-create-service-instance.md).
31+
+ Have an API Management instance. For more information, see [Create an Azure API Management instance](get-started-create-service-instance.md).
3832

3933
+ Understand the concept of [Capacity of an Azure API Management instance](api-management-capacity.md).
4034

41-
[!INCLUDE [premium-dev-standard-basic.md](../../includes/api-management-availability-premium-dev-standard-basic.md)]
42-
4335
## Upgrade and scale
4436

45-
You can choose between four tiers: **Developer**, **Basic**, **Standard**, and **Premium**. The **Developer** tier should be used to evaluate the service; it should not be used for production. The **Developer** tier does not have SLA and you cannot scale this tier (add/remove units).
37+
You can choose between four dedicated tiers: **Developer**, **Basic**, **Standard**, and **Premium**.
4638

47-
**Basic**, **Standard**, and **Premium** are production tiers that have SLA and can be scaled. The **Basic** tier is the cheapest tier with an SLA and it can be scaled up to two units, **Standard** tier can be scaled to up to four units. You can add any number of units to the **Premium** tier.
39+
* The **Developer** tier should be used to evaluate the service; it shouldn't be used for production. The **Developer** tier doesn't have SLA and you can't scale this tier (add/remove units).
4840

49-
The **Premium** tier enables you to distribute a single Azure API Management instance across any number of desired Azure regions. When you initially create an Azure API Management service, the instance contains only one unit and resides in a single Azure region. The initial region is designated as the **primary** region. Additional regions can be easily added. When adding a region, you specify the number of units you want to allocate. For example, you can have one unit in the **primary** region and five units in some other region. You can tailor the number of units to the traffic you have in each region. For more information, see [How to deploy an Azure API Management service instance to multiple Azure regions](api-management-howto-deploy-multi-region.md).
41+
* **Basic**, **Standard**, and **Premium** are production tiers that have SLA and can be scaled. For pricing details and scale limits, see [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/#pricing).
5042

51-
You can upgrade and downgrade to and from any tier. Upgrading or downgrading can remove some features - for example, VNETs or multi-region deployment, when downgrading to Standard or Basic from the Premium tier.
43+
* The **Premium** tier enables you to distribute a single Azure API Management instance across any number of desired Azure regions. When you initially create an Azure API Management service, the instance contains only one unit and resides in a single Azure region (the **primary** region).
5244

53-
> [!NOTE]
54-
> The upgrade or scale process can take from 15 to 45 minutes to apply. You get notified when it is done.
45+
Additional regions can be easily added. When adding a region, you specify the number of units you want to allocate. For example, you can have one unit in the primary region and five units in some other region. You can tailor the number of units to the traffic you have in each region. For more information, see [How to deploy an Azure API Management service instance to multiple Azure regions](api-management-howto-deploy-multi-region.md).
46+
47+
* You can upgrade and downgrade to and from any dedicated service tier. Downgrading can remove some features. For example, downgrading to Standard or Basic from the Premium tier can remove virtual networks or multi-region deployment.
5548

5649
> [!NOTE]
57-
> API Management service in the **Consumption** tier scales automatically based on the traffic.
50+
> The upgrade or scale process can take from 15 to 45 minutes to apply. You get notified when it is done.
5851
59-
## Scale your API Management service
52+
## Scale your API Management instance
6053

6154
![Scale API Management service in Azure portal](./media/upgrade-and-scale/portal-scale.png)
6255

63-
1. Navigate to your API Management service in the [Azure portal](https://portal.azure.com/).
64-
2. Select **Locations** from the menu.
65-
3. Click on the row with the location you want to scale.
66-
4. Specify the new number of **units** - either use the slider or type the number.
67-
5. Click **Apply**.
56+
1. Navigate to your API Management instance in the [Azure portal](https://portal.azure.com/).
57+
1. Select **Locations** from the menu.
58+
1. Select the row with the location you want to scale.
59+
1. Specify the new number of **Units** - use the slider if available, or type the number.
60+
1. Select **Apply**.
61+
62+
> [!NOTE]
63+
> In the Premium service tier, you can optionally configure availability zones and a virtual network in a selected location. For more information, see [Deploy API Management service to an additional location](api-management-howto-deploy-multi-region.md#-deploy-api-management-service-to-an-additional-location).
6864
6965
## Change your API Management service tier
7066

71-
1. Navigate to your API Management service in the [Azure portal](https://portal.azure.com/).
72-
2. Click on the **Pricing tier** in the menu.
73-
3. Select the desired service tier from the dropdown. Use the slider to specify the scale of your API Management service after the change.
74-
4. Click **Save**.
67+
1. Navigate to your API Management instance in the [Azure portal](https://portal.azure.com/).
68+
1. Select **Pricing tier** in the menu.
69+
1. Select the desired service tier from the dropdown. Use the slider to specify the number of units for your API Management service after the change.
70+
1. Select **Save**.
7571

7672
## Downtime during scaling up and down
77-
If you are scaling from or to the Developer tier, there will be downtime. Otherwise, there is no downtime.
73+
If you're scaling from or to the Developer tier, there will be downtime. Otherwise, there is no downtime.
7874

7975
## Compute isolation
80-
If your security requirements include [compute isolation](../azure-government/azure-secure-isolation-guidance.md#compute-isolation), you can use the **Isolated** pricing tier. This tier ensures the compute resources of an API Management service instance consume the entire physical host and provide the necessary level of isolation required to support, for example, US Department of Defense Impact Level 5 (IL5) workloads. To get access to the Isolated tier, please [create a support ticket](../azure-portal/supportability/how-to-create-azure-support-request.md).
81-
8276

77+
If your security requirements include [compute isolation](../azure-government/azure-secure-isolation-guidance.md#compute-isolation), you can use the **Isolated** pricing tier. This tier ensures the compute resources of an API Management service instance consume the entire physical host and provide the necessary level of isolation required to support, for example, US Department of Defense Impact Level 5 (IL5) workloads. To get access to the Isolated tier, [create a support request](../azure-portal/supportability/how-to-create-azure-support-request.md).
8378

8479
## Next steps
8580

0 commit comments

Comments
 (0)