Skip to content

Commit 555ee72

Browse files
MGoedtelMGoedtel
committed
updated per PM feedback
1 parent 4f3e2ac commit 555ee72

File tree

1 file changed

+27
-94
lines changed

1 file changed

+27
-94
lines changed

‎articles/azure-arc/servers/manage-automatic-vm-extension-upgrade.md

Lines changed: 27 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
---
2-
title: Automatic Extension Upgrade for Azure Arc-enabled servers
3-
description: Learn how to enable the Automatic Extension Upgrade for your Azure Arc-enabled servers.
2+
title: Automatic Extension Upgrade (preview) for Azure Arc-enabled servers
3+
description: Learn how to enable the Automatic Extension Upgrade (preview) for your Azure Arc-enabled servers.
44
ms.topic: conceptual
5-
ms.date: 08/10/2021
5+
ms.date: 11/04/2021
66
---
77

8-
# Automatic Extension Upgrade for Azure Arc-enabled servers
8+
# Automatic Extension Upgrade (preview) for Azure Arc-enabled servers
99

10-
Automatic Extension Upgrade is available for Azure Arc-enabled servers that have supported VM extensions installed. When Automatic Extension Upgrade is enabled on a machine, the extension is upgraded automatically whenever the extension publisher releases a new version for that extension.
10+
Automatic Extension Upgrade (preview) is available for Azure Arc-enabled servers that have supported VM extensions installed. When Automatic Extension Upgrade (preview) is enabled on a machine, the extension is upgraded automatically whenever the extension publisher releases a new version for that extension.
1111

1212
Automatic Extension Upgrade has the following features:
1313

1414
- You can opt in and out of automatic upgrades at any time.
1515
- Each supported extension is enrolled individually, and you can choose which extensions to upgrade automatically.
1616
- Supported in all public cloud regions.
1717

18+
> [!NOTE]
19+
> In this release, only the Azure CLI is supported to configure Automatic Extension Upgrade.
20+
1821
## How does Automatic Extension Upgrade work?
1922

2023
The extension upgrade process replaces the existing Azure VM extension version supported by Azure Arc-enabled servers with a new version of the same extension when published by the extension publisher. The health of the machine is monitored after the new extension is installed. If the machine is not in a healthy state within 5 minutes of the upgrade completion, the extension version is rolled back to the previous version.
@@ -27,68 +30,36 @@ How does the upgrade process work for an Arc-enabled server?
2730

2831
## Supported extensions
2932

30-
Automatic Extension Upgrade supports the following extensions (and more are added periodically):
31-
32-
- Dependency Agent – [Linux](../../virtual-machines/extensions/agent-dependency-linux.md) and [Windows](../../virtual-machines/extensions/agent-dependency-windows.md)
33-
- [Guest Configuration Extension](../../virtual-machines/extensions/guest-configuration.md) – Linux and Windows
34-
- Key Vault – [Linux](../../virtual-machines/extensions/key-vault-linux.md) and [Windows](../../virtual-machines/extensions/key-vault-windows.md)
35-
36-
## Enabling Automatic Extension Upgrade
37-
38-
To enable Automatic Extension Upgrade for an extension, you must ensure the property `enableAutomaticUpgrade` is set to `true` and added to every extension definition individually.
39-
40-
### Using the REST API
41-
42-
To enable automatic extension upgrade for an extension (in this example the Dependency Agent extension), run the following command:
43-
44-
```rest
45-
PUT on `/subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.HybridCompute/machines/<machineName>/extensions/<extensionName>?api-version=2019-12-01`
46-
```
47-
48-
```json
49-
{    
50-
    "name": "extensionName",
51-
    "type": "Microsoft.Compute/HybridMachines/extensions",
52-
    "location": "<location>",
53-
    "properties": {
54-
     "autoUpgradeMinorVersion": true,
55-
     "enableAutomaticUpgrade": true, 
56-
     "publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
57-
     "type": "DependencyAgentWindows",
58-
     "typeHandlerVersion": "9.5"
59-
     }
60-
}
61-
```
33+
Automatic Extension Upgrade (preview) supports the following extensions (and more are added periodically):
6234

63-
### Using Azure PowerShell
35+
- Dependency agent – Linux and Windows
36+
- Azure Monitor Agent - Linux and Windows
37+
- Azure Security agent - Linux and Windows
38+
- Key Vault Extension - Linux only
39+
- Log Analytics agent - Linux only
6440

65-
Use the [Set-AzConnectedMachineExtension](/powershell/module/az.connectedmachine/new-azconnectedmachineextension) cmdlet with the `-MachineName`, `-ExtensionName`, `-Publisher`, `-ExtensionType`, `-EnableAutomaticUpgrade`, and `ResourceGroupName` parameters.
41+
## Enabling Automatic Extension Upgrade (preview)
6642

67-
```azurepowershell
68-
Set-AzConnectedMachineExtension -ExtensionName "Microsoft.Azure.Monitoring.DependencyAgent" `
69-
-ResourceGroupName "myResourceGroup" `
70-
-MachineName "machineName" `
71-
-Publisher "Microsoft.Azure.Monitoring.DependencyAgent" `
72-
-ExtensionType "DependencyAgentWindows" `
73-
-TypeHandlerVersion 9.5 `
74-
-Location WestUS `
75-
-EnableAutomaticUpgrade $true
76-
```
77-
78-
### Using the Azure CLI
43+
To enable Automatic Extension Upgrade (preview) for an extension, you must ensure the property `enable-auto-upgrade` is set to `true` and added to every extension definition individually.
7944

8045
Use the [az connectedmachine extension ](/cli/azure/connectedmachine/extension) cmdlet with the `--extension-name`, `--machine-name`, `-publisher`, `--enable-auto-upgrade`, and `--resource-group` parameters.
8146

8247
```azurecli
8348
az connectedmachine extension set \
84-
--resource-group myResourceGroup \
85-
--machine-name myVM \
49+
--resource-group resourceGroupName \
50+
--machine-name machineName \
8651
--extension-name DependencyAgentLinux \
8752
--publisher Microsoft.Azure.Monitoring.DependencyAgent \
8853
--version 9.5 \
8954
--enable-auto-upgrade true
9055
```
9156

57+
To verify Automatic Extension Upgrade (preview) is available, run the following command:
58+
59+
```azurecli
60+
az connectedmachine extension list --resource-group resourceGroupName --machine-name machineName --query "[].{Name:name, AutoUpgrade:properties.enableAutoUpgrade}" --output table
61+
```
62+
9263
## Extension upgrades with multiple extensions
9364

9465
A machine managed by Arc-enabled servers can have multiple extensions with automatic extension upgrade enabled. The same machine can also have other extensions without automatic extension upgrade enabled.
@@ -97,54 +68,16 @@ If multiple extension upgrades are available for a machine, the upgrades may be
9768

9869
## Disable Automatic Extension Upgrade
9970

100-
To disable Automatic Extension Upgrade for an extension, you must ensure the property `enableAutomaticUpgrade` is set to `false` and added to every extension definition individually.
101-
102-
### Using the REST API
103-
104-
To disable automatic extension upgrade for an extension (in this example the Dependency Agent extension), run the following command:
105-
106-
```rest
107-
PUT on `/subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.HybridCompute/machines/<machineName>/extensions/<extensionName>?api-version=2019-12-01`
108-
```
109-
110-
```json
111-
{    
112-
    "name": "extensionName",
113-
    "type": "Microsoft.Compute/HybridMachines/extensions",
114-
    "location": "<location>",
115-
    "properties": {
116-
     "autoUpgradeMinorVersion": true,
117-
     "enableAutomaticUpgrade":false, 
118-
     "publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
119-
     "type": "DependencyAgentWindows",
120-
     "typeHandlerVersion": "9.5"
121-
     }
122-
}
123-
```
124-
125-
### Using Azure PowerShell
126-
127-
Use the [Set-AzConnectedMachineExtension](/powershell/module/az.connectedmachine/new-azconnectedmachineextension) cmdlet with the `-MachineName`, `-ExtensionName`, `-Publisher`, `-ExtensionType`, `-EnableAutomaticUpgrade`, and `ResourceGroupName` parameters.
128-
129-
```azurepowershell
130-
Set-AzConnectedMachineExtension -ExtensionName "Microsoft.Azure.Monitoring.DependencyAgent" `
131-
-ResourceGroupName "myResourceGroup" `
132-
-VMName "myVM" `
133-
-Publisher "Microsoft.Azure.Monitoring.DependencyAgent" `
134-
-ExtensionType "DependencyAgentWindows" `
135-
-TypeHandlerVersion 9.5 `
136-
-Location WestUS `
137-
-EnableAutomaticUpgrade $false
138-
```
71+
To disable Automatic Extension Upgrade (preview) for an extension, you must ensure the property `enable-auto-upgrade` is set to `false` and added to every extension definition individually.
13972

14073
### Using the Azure CLI
14174

14275
Use the [az connectedmachine extension ](/cli/azure/connectedmachine/extension) cmdlet with the `--extension-name`, `--machine-name`, `--publisher`, `--enable-auto-upgrade`, and `--resource-group` parameters.
14376

14477
```azurecli
14578
az connectedmachine extension set \
146-
--resource-group myResourceGroup \
147-
--vm-name myVM \
79+
--resource-group resourceGroupName \
80+
--machine-name machineName \
14881
--name DependencyAgentLinux \
14982
--publisher Microsoft.Azure.Monitoring.DependencyAgent \
15083
--version 9.5 \

0 commit comments

Comments
 (0)