Skip to content

Commit 016af50

Browse files
author
gitName
committed
rename, link
1 parent c7ced4b commit 016af50

8 files changed

+89
-131
lines changed

articles/api-management/TOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@
9191
href: migrate-stv1-to-stv2-no-vnet.md
9292
- name: Migrate a VNet-injected instance
9393
href: migrate-stv1-to-stv2-vnet.md
94-
- name: Validate service updates
95-
href: validate-service-updates.md
94+
- name: Configure update settings
95+
href: configure-update-settings.md
9696
- name: Move instances between regions
9797
href: api-management-howto-migrate.md
9898
- name: Recover a deleted instance
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: Configure API Management settings for service updates
3+
description: Learn how to configure settings for applying service updates to your Azure API Management instance. Settings include the upgrade group and the maintenance window.
4+
author: dlepow
5+
ms.service: azure-api-management
6+
ms.topic: how-to
7+
ms.date: 03/18/2025
8+
ms.author: danlep
9+
---
10+
11+
# Configure service update settings for your API Management instances
12+
13+
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
14+
15+
This article shows you how to configure service update settings 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+
17+
You can't control exactly when Azure updates each instance, but API Management lets you select an *update group* for your instance, and also a *maintenance window* during the day when you want your instance to receive updates.
18+
19+
* **Update group** - A set of instances that receive updates during a production rollout, which can take from several days to several weeks. Choose from:
20+
* **Early** - Receive updates early. Updates might include preview builds.
21+
* **Default** - Receive updates according to the usual phased rollout.
22+
* **Late** - Receive updates later. Updates include the most stable builds.
23+
24+
> [!NOTE]
25+
> 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.
26+
27+
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 might put in the **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
28+
29+
* **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.
30+
31+
Service disruptions are rare during an update, but you might want to reduce risk by selecting times of low service use. For example, set a maintenance window during weekday evenings and weekend mornings for your production instances.
32+
33+
34+
## Configure service update settings
35+
36+
1. Sign in to the [Azure portal](https://portal.azure.com) and go to your API Management instance.
37+
1. In the left menu, select **Deployment + infrastructure** > **Service update settings**.
38+
1. Under **Update group**, review the current setting and select **Edit** to change it.
39+
> [!NOTE]
40+
> Only the **Early** update group is available for API Management instances in the Developer tier.
41+
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.
43+
44+
## Know when your instances are receiving updates
45+
46+
Here's how to know about service updates that are expected or are in progress.
47+
48+
* 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.
49+
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.
51+
52+
:::image type="content" source="media/configure-service-update-settings/scheduled-maintenance.png" alt-text="Scheduled maintenance event in Activity log in the portal.":::
53+
54+
To receive notifications automatically, [set up an alert](/azure/azure-monitor/alerts/alerts-activity-log) on the Activity log.
55+
56+
* Updates roll out to regions in the following phases: Azure EUAP regions, followed by West Central US, followed by remaining regions in several later phases. The sequence of regions updated in the later deployment phases differs from service to service. You can expect at least 24 hours between each phase of the production rollout.
57+
58+
* Within a region, API Management instances in the Premium tier receive updates several hours later than those in other service tiers.
59+
60+
> [!TIP]
61+
> If your API Management instance is deployed to multiple locations (regions), the timing of updates is determined by the instance's **Primary** location.
62+
63+
## Canary deployment strategies
64+
65+
Here are example strategies to use an API Management instance as a canary deployment that receives updates earlier than your production instances.
66+
67+
* **Add instance to Early update group** - Use an API Management instance in the Early update group to validate updates early in the production pipeline. This instance is effectively your canary deployment.
68+
69+
* **Deploy in canary region** - If you have access to an Azure EUAP region, use an instance there to validate updates as soon as they're released to the production pipeline. Learn about the [Azure region access request process](/troubleshoot/azure/general/region-access-request-process).
70+
71+
> [!NOTE]
72+
> Because of capacity constraints in EUAP regions, you might not be able to scale API Management instances as needed.
73+
74+
* **Deploy in pilot region** - Use an instance in the West Central US to simulate your production environment, or use it in production for noncritical API traffic. While this region receives updates after the EUAP regions, a deployment there is more likely to identify regressions that are specific to your service configuration.
75+
76+
* **Deploy duplicate instances in a region** - If your production workload is a Premium tier instance in a specific region, consider deploying a similarly configured instance in a lower tier that receives updates earlier. For example, configure a preproduction instance in the Developer tier to validate updates.
77+
78+
## Related content
79+
80+
* Learn [how to monitor](api-management-howto-use-azure-monitor.md) your API Management instance.
81+
* Learn about other options to [observe](observability.md) your API Management instance.

articles/api-management/self-hosted-gateway-support-policies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The following table shows Microsoft's responsibilities, shared responsibilities,
3636
We have the following tagging strategy for the [self-hosted gateway container image](self-hosted-gateway-overview.md#packaging), following the major, minor, patch convention: `{major}.{minor}.{patch}`. You can find a full list of [available tags](https://mcr.microsoft.com/product/azure-api-management/gateway/tags). As a best practice, we recommend that customers run the latest stable version of our container image. Given the continuous releases of our container image, we'll provide official support for the following versions:
3737

3838
> [!TIP]
39-
> We highly encourage customers to upgrade to a newer self-hosted gateway by following [Safe Deployment Practices (SDP)](validate-service-updates.md#what-is-the-azure-safe-deployment-practices-framework).
39+
> We highly encourage customers to upgrade to a newer self-hosted gateway by following [Safe Deployment Practices (SDP)](https://azure.microsoft.com/blog/advancing-safe-deployment-practices/).
4040
4141
### Supported versions
4242

articles/api-management/validate-service-updates.md

Lines changed: 0 additions & 128 deletions
This file was deleted.

redirects/.openpublishing.redirection.api-management.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
{
22
"redirections": [
33
{
4+
"source_path_from_root": "/articles/api-management/validate-service-updates.md",
5+
"redirect_url": "/azure/api-management/configure-update-setting",
6+
"redirect_document_id": false
7+
},
8+
{
49
"source_path_from_root": "/articles/api-management/api-management-in-workspace.md",
510
"redirect_url": "/azure/api-management/how-to-create-workspace",
611
"redirect_document_id": false

0 commit comments

Comments
 (0)