Skip to content

Commit 3096cd6

Browse files
authored
Merge pull request #311140 from japicket/main
Update ADME Docs with Upgrade Settings
2 parents 15ff560 + 190df02 commit 3096cd6

6 files changed

Lines changed: 118 additions & 1 deletion

File tree

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
title: How to manage upgrade settings - Azure Data Manager for Energy
3+
description: Learn how to configure upgrade settings to control how milestone upgrades are applied to your Azure Data Manager for Energy instance.
4+
author: japicket
5+
ms.author: japicket
6+
ms.service: azure-data-manager-energy
7+
ms.topic: how-to
8+
ms.date: 01/27/2026
9+
ms.custom:
10+
- template-how-to
11+
---
12+
13+
# Manage upgrade settings in Azure Data Manager for Energy
14+
15+
This article describes how to view and manage upgrade settings for your Azure Data Manager for Energy instance. Upgrade settings allow you to control how milestone upgrades are applied to your instance.
16+
17+
## What are milestone upgrades?
18+
19+
Milestone upgrades are major version upgrades to Azure Data Manager for Energy, such as moving from M25 to M26. These upgrades might include significant changes to functionality and features.
20+
21+
## Upgrade policy options
22+
23+
Azure Data Manager for Energy provides two upgrade policy options:
24+
25+
| Policy | Description |
26+
|--------|-------------|
27+
| **Automatic** | Instance is upgraded automatically when a new milestone release is available. This option is the default setting for all instances. |
28+
| **Deferred** | Upgrades are deferred for up to 30 days before instance is upgraded. |
29+
30+
If you have multiple Azure Data Manager for Energy instances, you can set different upgrade policies for each one. For example, you might set one instance to **Automatic** so it upgrades immediately when a new milestone is released, allowing you to test and validate the changes. Meanwhile, you can set your production instance to **Deferred** to delay the upgrade until you complete your testing. At any point during the 30-day window, you can mark your deferred instance as ready for upgrade. If you don't take action, the instance is automatically upgraded at the end of the 30-day window.
31+
32+
## View upgrade settings
33+
34+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Azure Data Manager for Energy instance.
35+
36+
1. In the left menu under **Advanced**, select **Upgrade Settings**.
37+
38+
1. On the **Upgrade Settings** page, you can view:
39+
- **Upgrade policy**: Whether your instance is set to **Automatic** or **Deferred** upgrades.
40+
- **Automatic upgrade after**: If your upgrade policy is set to **Deferred** and a milestone upgrade is available, this field shows the date when your instance is automatically upgraded.
41+
42+
> [!NOTE]
43+
> The current milestone version is displayed in the **Essentials** section on the **Overview** page for your Azure Data Manager for Energy instance.
44+
45+
## Configure upgrade settings during instance creation
46+
47+
You can configure upgrade settings when you create a new Azure Data Manager for Energy instance.
48+
49+
1. When creating a new instance, navigate to the **Advanced Settings** tab.
50+
51+
1. In the **Upgrade Settings** section, select either **Automatic** or **Deferred** for the **Upgrade Policy**.
52+
53+
1. Complete the remaining tabs and select **Create** to create your instance with the configured upgrade settings.
54+
55+
## Change the upgrade policy for an existing instance
56+
57+
You can change the upgrade policy for an existing Azure Data Manager for Energy instance at any time.
58+
59+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Azure Data Manager for Energy instance.
60+
61+
1. In the left menu under **Advanced**, select **Upgrade Settings**.
62+
63+
1. Select either **Automatic** or **Deferred** to change your upgrade policy.
64+
65+
1. Select **Save** to apply your changes.
66+
67+
## Mark your instance as ready for upgrade
68+
69+
If your upgrade policy is set to **Deferred** and a milestone upgrade is available, you can mark your instance as ready for upgrade at any time during the 30-day window.
70+
71+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Azure Data Manager for Energy instance.
72+
73+
1. In the left menu under **Advanced**, select **Upgrade Settings**.
74+
75+
1. Select the **Mark Ready for Upgrade** button.
76+
77+
> [!NOTE]
78+
> The **Mark Ready for Upgrade** button is only available when:
79+
> - Your upgrade policy is set to **Deferred**.
80+
> - The **Automatic upgrade after** date is set by the Azure Data Manager for Energy team.
81+
82+
1. Confirm that you want to mark your instance as ready for upgrade.
83+
84+
> [!IMPORTANT]
85+
> Once you mark your instance as ready for upgrade, this action can't be undone. Your instance will be upgraded during the next upgrade cycle.
86+
87+
## Understanding the 30-day upgrade window
88+
89+
When a new milestone release is available and your upgrade policy is set to **Deferred**, the following apply:
90+
91+
1. After all instances with the **Automatic** upgrade policy are upgraded, the Azure Data Manager for Energy team sets the **Automatic upgrade after** date, which is approximately 30 days from that point.
92+
93+
1. The **Automatic upgrade after** date is displayed on the **Upgrade Settings** page in the Azure portal for instances with a **Deferred** upgrade policy.
94+
95+
1. During this 30-day window, you can:
96+
- Test the new milestone release in a nonproduction environment.
97+
- Mark your instance as ready for upgrade when you're satisfied with your testing.
98+
- Take no action and let your instance be automatically upgraded at the end of the window.
99+
100+
1. After your instance is upgraded, the **Automatic upgrade after** date is cleared until the next milestone release.
101+
102+
## Frequently asked questions
103+
104+
### What happens if I find an issue with Azure Data Manager for Energy during the 30-day window?
105+
106+
If you discover an issue during the 30-day window, contact Azure support. Depending on the severity of the issue, the Azure Data Manager for Energy team might deploy a hotfix. If a hotfix is required, the 30-day timer is paused when the issue is identified and resumes once the hotfix is deployed.
107+
108+
## Next steps
109+
110+
Learn more about each milestone release and Azure Data Manager for Energy:
111+
112+
> [!div class="nextstepaction"]
113+
> [Release notes](release-notes.md)
48.7 KB
Loading
Loading
Loading

articles/energy-data-services/quickstart-create-microsoft-energy-data-services-instance.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,9 @@ OSDU® is a trademark of The Open Group.
9191

9292
[![Screenshot of the tab for specifying tags in Azure Data Manager for Energy.](media/quickstart-create-microsoft-energy-data-services-instance/input-tags.png)](media/quickstart-create-microsoft-energy-data-services-instance/input-tags.png#lightbox)
9393

94-
1. Move to the **Advanced Settings** tab to configure **cross-origin resource sharing** and **reference data values settings**. To learn more about cross-origin resource sharing (CORS), see [Use CORS for resource sharing in Azure Data Manager for Energy](../energy-data-services/how-to-enable-cors.md). To learn more about reference data values, see [Syncing Reference Data Values](../energy-data-services/concepts-reference-data-values.md).
94+
1. Move to the **Advanced Settings** tab to configure **cross-origin resource sharing**, **upgrade settings**, and, if available to you as a customer in the limited preview for the feature, **reference data values settings**. To learn more about cross-origin resource sharing (CORS), see [Use CORS for resource sharing in Azure Data Manager for Energy](../energy-data-services/how-to-enable-cors.md). To learn more about reference data values, see [Syncing Reference Data Values](../energy-data-services/concepts-reference-data-values.md). To learn more about upgrade settings, see [Manage upgrade settings](../energy-data-services/how-to-manage-upgrade-settings.md).
95+
96+
In the **Upgrade Settings** section, select either **Automatic** or **Deferred** for the **Upgrade Policy**. When set to **Deferred**, you have up to 30 days to validate new milestone releases before your instance is upgraded.
9597

9698
[![Screenshot of the tab for configuring cross-origin resource sharing in Azure Data Manager for Energy.](media/quickstart-create-microsoft-energy-data-services-instance/advanced-settings-tab.png)](media/quickstart-create-microsoft-energy-data-services-instance/advanced-settings-tab.png#lightbox)
9799

articles/energy-data-services/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@ items:
125125
href: how-to-generate-auth-token.md
126126
- name: Upload large files using file service
127127
href: how-to-upload-large-files-using-file-service.md
128+
- name: Manage upgrade settings
129+
href: how-to-manage-upgrade-settings.md
128130
- name: References
129131
items:
130132
- name: REST API

0 commit comments

Comments
 (0)