Skip to content

Commit d33cec1

Browse files
authored
Merge pull request #308760 from dlepow/relch
[APIM] Improve release channel descriptions
2 parents ed5d403 + 37dc834 commit d33cec1

1 file changed

Lines changed: 26 additions & 18 deletions

File tree

articles/api-management/configure-service-update-settings.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to configure settings for applying service updates to you
44
author: dlepow
55
ms.service: azure-api-management
66
ms.topic: how-to
7-
ms.date: 04/08/2025
7+
ms.date: 11/25/2025
88
ms.author: danlep
99
---
1010

@@ -13,41 +13,49 @@ ms.author: danlep
1313
[!INCLUDE [api-management-availability-premium-standard-basic](../../includes/api-management-availability-premium-standard-basic.md)]
1414

1515

16-
This article shows you how to configure *service update* settings (preview) in your API Management instance. Azure periodically applies service updates automatically to API Management instances, using a phased rollout approach. These updates include new features, security enhancements, and reliability improvements.
16+
This article shows you how to configure *service update* settings (preview) in your API Management instance. Azure periodically applies service updates automatically to API Management instances by using a phased rollout approach. These updates include new features, security enhancements, and reliability improvements.
1717

18-
You can't control exactly when Azure updates each API Management instance, but in select service tiers you can choose an *update group* (also called a *release channel*) for your instance so that it receives updates earlier or later than it usually would during an update rollout. You can also configure a *maintenance window* during the day when you want your instance to receive updates.
18+
You can't control exactly when Azure updates each API Management instance, but in select service tiers you can choose an *update group* for your instance so that it receives updates earlier or later than it usually would during an update rollout. You can also configure a *maintenance window* during the day when you want your instance to receive updates.
1919

20-
* **Update group** - A set of instances that receive API Management service updates during a production rollout, which can take from several days to several weeks to complete.
20+
## Update group
2121

22-
Choose from:
23-
* **Early** - Receive updates early in the rollout, for testing and early access to new features. This option is not recommended for production deployments.
24-
* **Default** - Receive updates as part of the regular release rollout. This option is recommended for most services, including production deployments.
25-
* **Late** - Receive updates later than the previous groups, typically weeks after the initial rollout. This option is recommended for mission-critical deployments only.
26-
* **AI Gateway Early** (GenAI release channel) - Get early access to the latest [AI gateway features and updates](genai-gateway-capabilities.md) before they reach other update groups. Receive other service updates as part of the **Late** rollout group.
22+
An update group (also called a *release channel*) is a set of instances that receive API Management service updates during a production rollout, which can take from several days to several weeks to complete.
2723

28-
> [!NOTE]
29-
> Azure deploys all updates using a [safe deployment practices (SDP) framework](https://azure.microsoft.com/blog/advancing-safe-deployment-practices/). Updates released early in a rollout might be less stable and replaced later by stable releases. All instances are eventually updated to the most stable release builds.
24+
| Update group | Description |
25+
|--------------|-------------|
26+
| **AI Gateway Early** (GenAI release channel) | Gets early access to the latest [AI gateway features and updates](genai-gateway-capabilities.md) before they reach other update groups.<br/><br/>Combines the most stable mainline service updates with the newest AI-specific features. Receives other service updates as part of the **Late** update group, enabling faster deployment of AI-related capabilities. |
27+
| **Early** | Receives updates early in the rollout, for testing and early access to new features. This option isn't recommended for production deployments. |
28+
| **Default** | Receives updates as part of the regular release rollout. This option is recommended for most services, including production deployments. |
29+
| **Late** | Receives updates later than the previous groups, typically weeks after the initial rollout. This option is recommended for mission-critical deployments only. |
30+
31+
32+
> [!NOTE]
33+
> * Azure deploys all updates by using a [safe deployment practices (SDP) framework](https://azure.microsoft.com/blog/advancing-safe-deployment-practices/). Updates released early in a rollout might be less stable and replaced later by stable releases. All instances are eventually updated to the most stable release builds.
34+
> * All update groups can include features in preview. Preview features are clearly noted in the Azure portal and documentation.
35+
> * Features propagate through update groups in this sequence: **AI Gateway Early** (AI features only) → **Early****Default****Late**.
36+
37+
For example, you might want to add a test instance to the **Early** update group. This instance receives updates before your production instances, which you put in the **Default** or **Late** update group. You can monitor the test instance for any issues caused by the updates before they reach your production instances. [Learn more about canary deployments](#canary-deployment-strategies) with API Management
3038

31-
For example, you might want to add a test instance to the **Early** update group. This instance receives updates before your production instances, which you put in the **Default** or **Late** update group. You can monitor the test instance for any issues caused by the updates before they reach your production instances. [Learn more about canary deployments](#canary-deployment-strategies) with API Management
39+
## Maintenance window
3240

33-
* **Maintenance window** - An 8-hour daily period when you want your instance to receive updates. By default, the maintenance window is 10 PM to 6 AM in the instance's timezone.
41+
A maintenance window is an 8-hour daily period when you want your instance to receive updates. By default, the maintenance window is 10 PM to 6 AM in the instance's timezone.
3442

35-
Service disruptions are rare during an update, but you might want to reduce risk by selecting times of low service use. For example, for production instances, set a maintenance window during weekday evenings and weekend mornings.
43+
Service disruptions are rare during an update, but you might want to reduce risk by selecting times of low service use. For example, for production instances, set a maintenance window during weekday evenings and weekend mornings.
3644

3745
## Configure service update settings
3846

3947
1. Sign in to the [Azure portal](https://portal.azure.com) and go to your API Management instance.
4048
1. In the left menu, select **Deployment + infrastructure** > **Service update settings**.
4149
1. Under **Update group**, review the current setting and select **Edit** to change it.
42-
1. Under **Maintenance window**, review the current settings and select **Edit** to change them. For each day you can select the default window, a different standard window, or a custom window by day.
50+
1. Under **Maintenance window**, review the current settings and select **Edit** to change them. For each day, you can select the default window, a different standard window, or a custom window by day.
4351

44-
## Know when your instances are receiving updates
52+
## Know when your instances receive updates
4553

46-
Here's how to know about service updates that are expected or are in progress.
54+
Here's how you can learn about service updates that are expected or are in progress.
4755

4856
* API Management updates are announced on the [API Management GitHub repo](https://github.com/Azure/API-Management/releases). Subscribe to receive notifications from this repository to know when update rollouts begin.
4957

50-
* Monitor service updates that are taking place in your API Management instance by using the Azure [Activity log](/azure/azure-monitor/essentials/activity-log). The "Scheduled maintenance" event is emitted when an update begins.
58+
* Use the Azure [Activity log](/azure/azure-monitor/essentials/activity-log) to monitor service updates that take place in your API Management instance. The "Scheduled maintenance" event is emitted when an update begins.
5159

5260
:::image type="content" source="media/configure-service-update-settings/scheduled-maintenance.png" alt-text="Scheduled maintenance event in Activity log in the portal.":::
5361

0 commit comments

Comments
 (0)