Skip to content

Commit 20b183f

Browse files
authored
Merge pull request #112014 from Justinha/control-maintenance-portal
Control maintenance portal
2 parents 68ba3e3 + 0200836 commit 20b183f

22 files changed

+159
-72
lines changed

articles/virtual-machines/linux/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,10 +438,14 @@
438438
href: ../maintenance-notifications-powershell.md?toc=/azure/virtual-machines/linux/toc.json&bc=/azure/virtual-machines/linux/breadcrumb/toc.json
439439
- name: Maintenance control
440440
items:
441+
- name: Overview
442+
href: ../maintenance-control.md?toc=/azure/virtual-machines/linux/toc.json&bc=/azure/virtual-machines/linux/breadcrumb/toc.json
441443
- name: CLI
442444
href: ../maintenance-control-cli.md?toc=/azure/virtual-machines/linux/toc.json&bc=/azure/virtual-machines/linux/breadcrumb/toc.json
443445
- name: PowerShell
444446
href: ../maintenance-control-powershell.md?toc=/azure/virtual-machines/linux/toc.json&bc=/azure/virtual-machines/linux/breadcrumb/toc.json
447+
- name: Portal
448+
href: ../maintenance-control-portal.md?toc=/azure/virtual-machines/linux/toc.json&bc=/azure/virtual-machines/linux/breadcrumb/toc.json
445449
- name: Scheduled events
446450
href: scheduled-events.md
447451
- name: Monitor VMs

articles/virtual-machines/maintenance-control-cli.md

Lines changed: 6 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,18 @@
11
---
2-
title: Maintenance control
3-
description: Learn how to control when maintenance is applied to your Azure VMs using Maintenance Control.
2+
title: Maintenance control for Azure virtual machines using CLI
3+
description: Learn how to control when maintenance is applied to your Azure VMs using Maintenance control and CLI.
44
author: cynthn
55
ms.service: virtual-machines
66
ms.topic: article
77
ms.workload: infrastructure-services
8-
ms.date: 11/21/2019
8+
ms.date: 04/20/2020
99
ms.author: cynthn
1010
#pmcontact: shants
1111
---
1212

13-
# Preview: Control updates with Maintenance Control and the Azure CLI
14-
15-
Manage platform updates, that don't require a reboot, using maintenance control. Azure frequently updates its infrastructure to improve reliability, performance, security or launch new features. Most updates are transparent to users. Some sensitive workloads, like gaming, media streaming, and financial transactions, can’t tolerate even few seconds of a VM freezing or disconnecting for maintenance. Maintenance control gives you the option to wait on platform updates and apply them within a 35-day rolling window.
16-
17-
Maintenance control lets you decide when to apply updates to your isolated VMs and Azure Dedicated Hosts.
18-
19-
With maintenance control, you can:
20-
- Batch updates into one update package.
21-
- Wait up to 35 days to apply updates.
22-
- Automate platform updates for your maintenance window using Azure Functions.
23-
- Maintenance configurations work across subscriptions and resource groups.
24-
25-
> [!IMPORTANT]
26-
> Maintenance Control is currently in public preview.
27-
> This preview version is provided without a service level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
28-
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
29-
>
30-
31-
## Limitations
32-
33-
- VMs must be on a [dedicated host](./linux/dedicated-hosts.md), or be created using an [isolated VM size](./linux/isolation.md).
34-
- After 35 days, an update will automatically be applied.
35-
- User must have **Resource Contributor** access.
36-
37-
38-
## Install the maintenance extension
39-
40-
If you choose to install the [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli) locally, you need version 2.0.76 or later.
41-
42-
Install the `maintenance` preview CLI extension locally or in Cloud Shell.
43-
44-
```azurecli-interactive
45-
az extension add -n maintenance
46-
```
13+
# Control updates with Maintenance Control and the Azure CLI
4714

15+
Maintenance control lets you decide when to apply updates to your isolated VMs and Azure dedicated hosts. This topic covers the Azure CLI options for Maintenance control. For more about benefits of using Maintenance control, its limitations, and other management options, see [Managing platform updates with Maintenance Control](maintenance-control.md).
4816

4917
## Create a maintenance configuration
5018

@@ -58,7 +26,7 @@ az maintenance configuration create \
5826
-g myMaintenanceRG \
5927
--name myConfig \
6028
--maintenanceScope host\
61-
--location eastus
29+
--location eastus
6230
```
6331

6432
Copy the configuration ID from the output to use later.
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: Maintenance control for Azure virtual machines using the Azure portal
3+
description: Learn how to control when maintenance is applied to your Azure VMs using Maintenance control and the Azure portal.
4+
author: cynthn
5+
ms.service: virtual-machines
6+
ms.topic: article
7+
ms.workload: infrastructure-services
8+
ms.date: 04/22/2020
9+
ms.author: cynthn
10+
#pmcontact: shants
11+
---
12+
13+
# Control updates with Maintenance Control and the Azure portal
14+
15+
Maintenance control lets you decide when to apply updates to your isolated VMs and Azure dedicated hosts. This topic covers the Azure portal options for Maintenance control. For more about benefits of using Maintenance control, its limitations, and other management options, see [Managing platform updates with Maintenance Control](maintenance-control.md).
16+
17+
## Create a maintenance configuration
18+
19+
1. Sign in to the Azure portal.
20+
21+
1. Search for **Maintenance Configurations**.
22+
23+
![Screenshot showing how to open Maintenance Configurations](media/virtual-machines-maintenance-control-portal/maintenance-configurations-search.png)
24+
25+
1. Click **Add**.
26+
27+
![Screenshot showing how to add a maintenance configuration](media/virtual-machines-maintenance-control-portal/maintenance-configurations-add.png)
28+
29+
1. Choose a subscription and resource group, provide a name for the configuration, and choose a region. Click **Next**.
30+
31+
![Screenshot showing Maintenance Configuration basics](media/virtual-machines-maintenance-control-portal/maintenance-configurations-basics.png)
32+
33+
1. Add tags and values. Click **Next**.
34+
35+
![Screenshot showing how to add tags to a maintenance configuration](media/virtual-machines-maintenance-control-portal/maintenance-configurations-tags.png)
36+
37+
1. Review the summary. Click **Create**.
38+
39+
![Screenshot showing how to create a maintenance configuration](media/virtual-machines-maintenance-control-portal/maintenance-configurations-create.png)
40+
41+
1. After the deployment is complete, click **Go to resource**.
42+
43+
![Screenshot showing Maintenance Configuration deployment complete](media/virtual-machines-maintenance-control-portal/maintenance-configurations-deployment-complete.png)
44+
45+
## Assign the configuration
46+
47+
On the details page of the maintenance configuration, click Assignments and then click **Assign resource**.
48+
49+
![Screenshot showing how to assign a resource](media/virtual-machines-maintenance-control-portal/maintenance-configurations-add-assignment.png)
50+
51+
Select the resources that you want the maintenance configuration assigned to and click **Ok**. The **Type** column shows whether the resource is an isolated VM or Azure dedicated host. The VM needs to be running to assign the configuration. An error occurs if you try to assign a configuration to a VM that is stopped.
52+
53+
<!---Shantanu to add details about the error case--->
54+
55+
![Screenshot showing how to select a resource](media/virtual-machines-maintenance-control-portal/maintenance-configurations-select-resource.png)
56+
57+
## Check configuration
58+
59+
You can verify that the configuration was applied correctly or check to see any maintenance configuration that is currently assigned using **Maintenance Configurations**. The **Type** column shows whether the configuration is assigned to an isolated VM or Azure dedicated host.
60+
61+
![Screenshot showing how to check a maintenance configuration](media/virtual-machines-maintenance-control-portal/maintenance-configurations-host-type.png)
62+
63+
You can also check the configuration for a specific virtual machine on its properties page. Click **Maintenance** to see the configuration assigned to that virtual machine.
64+
65+
![Screenshot showing how to check Maintenance for a host](media/virtual-machines-maintenance-control-portal/maintenance-configurations-check-config.png)
66+
67+
## Check for pending updates
68+
69+
There are also two ways to check if updates are pending for a maintenance configuration. In **Maintenance Configurations**, on the details for the configuration, click **Assignments** and check **Maintenance status**.
70+
71+
![Screenshot showing how to check pending updates](media/virtual-machines-maintenance-control-portal/maintenance-configurations-pending.png)
72+
73+
You can also check a specific host using **Virtual Machines** or properties of the dedicated host.
74+
75+
![Screenshot showing how to check Maintenance for a host](media/virtual-machines-maintenance-control-portal/maintenance-configurations-pending-vm.png)
76+
77+
## Apply updates
78+
79+
You can apply pending updates on demand using **Virtual Machines**. On the VM details, click **Maintenance** and click **Apply maintenance now**.
80+
81+
![Screenshot showing how to apply pending updates](media/virtual-machines-maintenance-control-portal/maintenance-configurations-apply-updates-now.png)
82+
83+
## Check the status of applying updates
84+
85+
You can check on the progress of the updates for a configuration in **Maintenance Configurations** or using **Virtual Machines**. On the VM details, click **Maintenance**. In the following example, the **Maintenance state** shows an update is **Pending**.
86+
87+
![Screenshot showing how to check status of pending updates](media/virtual-machines-maintenance-control-portal/maintenance-configurations-status.png)
88+
89+
## Delete a maintenance configuration
90+
91+
To delete a configuration, open the configuration details and click **Delete**.
92+
93+
![Screenshot showing how to check Maintenance for a host](media/virtual-machines-maintenance-control-portal/maintenance-configurations-delete.png)
94+
95+
96+
## Next steps
97+
98+
To learn more, see [Maintenance and updates](maintenance-and-updates.md).

articles/virtual-machines/maintenance-control-powershell.md

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Maintenance control for Azure virtual machines using PowerShell
3-
description: Learn how to control when maintenance is applied to your Azure VMs using Maintenance Control and PowerShell.
3+
description: Learn how to control when maintenance is applied to your Azure VMs using Maintenance control and PowerShell.
44
author: cynthn
55
ms.service: virtual-machines
66
ms.topic: article
@@ -10,31 +10,10 @@ ms.author: cynthn
1010
#pmcontact: shants
1111
---
1212

13-
# Preview: Control updates with Maintenance Control and Azure PowerShell
14-
15-
Manage platform updates, that don't require a reboot, using maintenance control. Azure frequently updates its infrastructure to improve reliability, performance, security or launch new features. Most updates are transparent to users. Some sensitive workloads, like gaming, media streaming, and financial transactions, can’t tolerate even few seconds of a VM freezing or disconnecting for maintenance. Maintenance control gives you the option to wait on platform updates and apply them within a 35-day rolling window.
16-
17-
Maintenance control lets you decide when to apply updates to your isolated VMs.
18-
19-
With maintenance control, you can:
20-
- Batch updates into one update package.
21-
- Wait up to 35 days to apply updates.
22-
- Automate platform updates for your maintenance window using Azure Functions.
23-
- Maintenance configurations work across subscriptions and resource groups.
24-
25-
> [!IMPORTANT]
26-
> Maintenance Control is currently in public preview.
27-
> This preview version is provided without a service level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
28-
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
29-
>
30-
31-
## Limitations
32-
33-
- VMs must be on a [dedicated host](./linux/dedicated-hosts.md), or be created using an [isolated VM size](./linux/isolation.md).
34-
- After 35 days, an update will automatically be applied.
35-
- User must have **Resource Contributor** access.
36-
13+
# Control updates with Maintenance Control and Azure PowerShell
3714

15+
Maintenance control lets you decide when to apply updates to your isolated VMs and Azure dedicated hosts. This topic covers the Azure PowerShell options for Maintenance control. For more about benefits of using Maintenance control, its limitations, and other management options, see [Managing platform updates with Maintenance Control](maintenance-control.md).
16+
3817
## Enable the PowerShell module
3918

4019
Make sure `PowerShellGet` is up to date.
@@ -43,18 +22,11 @@ Make sure `PowerShellGet` is up to date.
4322
Install-Module -Name PowerShellGet -Repository PSGallery -Force
4423
```
4524

46-
The Az.Maintenance PowerShell cmdlets are in preview, so you need to install the module with the `AllowPrerelease` parameter in Cloud Shell or your local PowerShell installation.
47-
48-
```azurepowershell-interactive
49-
Install-Module -Name Az.Maintenance -AllowPrerelease
50-
```
51-
5225
If you are installing locally, make sure you open your PowerShell prompt as an administrator.
5326

5427
You may also be asked to confirm that you want to install from an *untrusted repository*. Type `Y` or select **Yes to All** to install the module.
5528

5629

57-
5830
## Create a maintenance configuration
5931

6032
Create a resource group as a container for your configuration. In this example, a resource group named *myMaintenanceRG* is created in *eastus*. If you already have a resource group that you want to use, you can skip this part and replace the resource group name with you own in the rest of the examples.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Overview of Maintenance control for Azure virtual machines using the Azure portal
3+
description: Learn how to control when maintenance is applied to your Azure VMs using Maintenance Control.
4+
author: cynthn
5+
ms.service: virtual-machines
6+
ms.topic: article
7+
ms.workload: infrastructure-services
8+
ms.date: 04/22/2020
9+
ms.author: cynthn
10+
#pmcontact: shants
11+
---
12+
13+
# Managing platform updates with Maintenance Control
14+
15+
Manage platform updates, that don't require a reboot, using maintenance control. Azure frequently updates its infrastructure to improve reliability, performance, security or launch new features. Most updates are transparent to users. Some sensitive workloads, like gaming, media streaming, and financial transactions, can't tolerate even few seconds of a VM freezing or disconnecting for maintenance. Maintenance control gives you the option to wait on platform updates and apply them within a 35-day rolling window.
16+
17+
Maintenance control lets you decide when to apply updates to your isolated VMs and Azure dedicated hosts.
18+
19+
With maintenance control, you can:
20+
- Batch updates into one update package.
21+
- Wait up to 35 days to apply updates.
22+
- Automate platform updates for your maintenance window using Azure Functions.
23+
- Maintenance configurations work across subscriptions and resource groups.
24+
25+
## Limitations
26+
27+
- VMs must be on a [dedicated host](./linux/dedicated-hosts.md), or be created using an [isolated VM size](./linux/isolation.md).
28+
- After 35 days, an update will automatically be applied.
29+
- User must have **Resource Contributor** access.
30+
31+
## Management options
32+
33+
You can create and manage maintenance configurations using any of the following options:
34+
35+
- [Azure CLI](maintenance-control-cli.md)
36+
- [Azure PowerShell](maintenance-control-powershell.md)
37+
- [Azure portal](maintenance-control-portal.md)
38+
39+
## Next steps
40+
41+
To learn more, see [Maintenance and updates](maintenance-and-updates.md).
Loading
10.3 KB
Loading
Loading
60.9 KB
Loading
Loading

0 commit comments

Comments
 (0)