Skip to content

Commit 46a44f7

Browse files
authored
Merge pull request #214632 from rpsqrd/auto-extension-upgrades
first draft auto extension upgrade portal content
2 parents 4ff3aee + dbd2105 commit 46a44f7

File tree

5 files changed

+59
-45
lines changed

5 files changed

+59
-45
lines changed

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

Lines changed: 55 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
---
2-
title: Automatic extension upgrade (preview) for Azure Arc-enabled servers
3-
description: Learn how to enable the automatic extension upgrades for your Azure Arc-enabled servers.
2+
title: Automatic extension upgrade for Azure Arc-enabled servers
3+
description: Learn how to enable automatic extension upgrades for your Azure Arc-enabled servers.
44
ms.topic: conceptual
5-
ms.date: 06/02/2021
5+
ms.date: 10/14/2022
66
---
77

8-
# Automatic extension upgrade (preview) for Azure Arc-enabled servers
8+
# Automatic extension upgrade for Azure Arc-enabled servers
99

10-
Automatic extension upgrade (preview) 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 is available for Azure Arc-enabled servers that have supported VM extensions installed. Automatic extension upgrades reduce the amount of operational overhead for you by scheduling the installation of new extension versions when they become available. The Azure Connected Machine agent takes care of upgrading the extension (preserving its settings along the way) and automatically rolling back to the previous version if something goes wrong during the upgrade process.
1111

12-
Automatic extension upgrade has the following features:
12+
Automatic extension upgrade has the following features:
1313

14-
- You can opt in and out of automatic upgrades at any time.
14+
- You can opt in and out of automatic upgrades at any time. By default, all extensions are opted into automatic extension upgrades.
1515
- Each supported extension is enrolled individually, and you can choose which extensions to upgrade automatically.
16-
- Supported in all public cloud regions.
17-
18-
> [!NOTE]
19-
> In this release, it is only possible to configure automatic extension upgrade with the Azure CLI and Azure PowerShell module.
16+
- Supported in all Azure Arc regions.
2017

2118
## How does automatic extension upgrade work?
2219

@@ -45,7 +42,7 @@ If an extension upgrade fails, Azure will try to repair the extension by perform
4542
1. If the rollback is successful, the extension status will show as **Succeeded** and the extension will be added to the automatic upgrade queue again. The next upgrade attempt can be as soon as the next hour and will continue until the upgrade is successful.
4643
1. If the rollback fails, the extension status will show as **Failed** and the extension will no longer function as intended. You'll need to [remove](manage-vm-extensions-cli.md#remove-extensions) and [reinstall](manage-vm-extensions-cli.md#enable-extension) the extension to restore functionality.
4744

48-
If you continue to have trouble upgrading an extension, you can [disable automatic extension upgrade](#disable-automatic-extension-upgrade) to prevent the system from trying again while you troubleshoot the issue. You can [enable automatic extension upgrade](#enable-automatic-extension-upgrade) again when you're ready.
45+
If you continue to have trouble upgrading an extension, you can [disable automatic extension upgrade](#manage-automatic-extension-upgrade) to prevent the system from trying again while you troubleshoot the issue. You can [enable automatic extension upgrade](#manage-automatic-extension-upgrade) again when you're ready.
4946

5047
## Supported extensions
5148

@@ -57,69 +54,86 @@ Automatic extension upgrade supports the following extensions (and more are adde
5754
- Key Vault Extension - Linux only
5855
- Log Analytics agent (OMS agent) - Linux only
5956

60-
## Enable automatic extension upgrade
57+
## Manage automatic extension upgrade
58+
59+
Automatic extension upgrade is enabled by default when you install extensions on Azure Arc-enabled servers. To enable automatic upgrades for an existing extension, you can use Azure CLI or Azure PowerShell to set the `enableAutomaticUpgrade` property on the extension to `true`. You'll need to repeat this process for every extension where you'd like to enable or disable automatic upgrades.
60+
61+
### [Azure portal](#tab/azure-portal)
62+
63+
Use the following steps to configure automatic extension upgrades in using the Azure portal:
64+
65+
1. Navigate to the [Azure portal](https://portal.azure.com) and type **Servers - Azure Arc** into the search bar.
66+
:::image type="content" source="media/manage-automatic-vm-extension-upgrade/portal-search-arc-server.png" alt-text="Screenshot of Azure portal showing user typing in Servers - Azure Arc." border="true":::
67+
1. Select **Servers - Azure Arc** under the Services category, then select the individual server you wish to manage.
68+
1. In the navigation pane, select the **Extensions** tab to see a list of all extensions installed on the server.
69+
:::image type="content" source="media/manage-automatic-vm-extension-upgrade/portal-navigation-extensions.png" alt-text="Screenshot of an Azure Arc-enabled server in the Azure portal showing where to navigate to extensions." border="true":::
70+
1. The **Automatic upgrade** column in the table shows whether upgrades are enabled, disabled, or not supported for each extension. Select the checkbox next to the extensions for which you want automatic upgrades enabled, then select **Enable automatic upgrade** to turn on the feature. Select **Disable automatic upgrade** to turn off the feature.
71+
:::image type="content" source="media/manage-automatic-vm-extension-upgrade/portal-enable-auto-upgrade.png" alt-text="Screenshot of Azure portal showing how to select extensions and enable automatic upgrades." border="true":::
6172

62-
Automatic extension upgrade is enabled by default when you install extensions on Azure Arc-enabled servers. To enable automatic extension upgrade for an existing extension, you can use Azure CLI or Azure PowerShell to set the `enableAutomaticUpgrade` property on the extension to `true`. You'll need to repeat this process for every extension where you'd like to enable automatic upgrades.
73+
### [Azure CLI](#tab/azure-cli)
74+
75+
To check the status of automatic extension upgrade for all extensions on an Arc-enabled server, run the following command:
76+
77+
```azurecli
78+
az connectedmachine extension list --resource-group resourceGroupName --machine-name machineName --query "[].{Name:name, AutoUpgrade:properties.enableAutoUpgrade}" --output table
79+
```
6380

64-
Use the [az connectedmachine extension update](/cli/azure/connectedmachine/extension) command to enable automatic upgrade on an extension:
81+
Use the [az connectedmachine extension update](/cli/azure/connectedmachine/extension) command to enable automatic upgrades on an extension:
6582

6683
```azurecli
6784
az connectedmachine extension update \
6885
--resource-group resourceGroupName \
6986
--machine-name machineName \
70-
--name DependencyAgentLinux \
87+
--name extensionName \
7188
--enable-auto-upgrade true
7289
```
7390

74-
To check the status of automatic extension upgrade for all extensions on an Arc-enabled server, run the following command:
91+
To disable automatic upgrades, set the `--enable-auto-upgrade` parameter to `false`, as shown below:
7592

7693
```azurecli
77-
az connectedmachine extension list --resource-group resourceGroupName --machine-name machineName --query "[].{Name:name, AutoUpgrade:properties.enableAutoUpgrade}" --output table
94+
az connectedmachine extension update \
95+
--resource-group resourceGroupName \
96+
--machine-name machineName \
97+
--name extensionName \
98+
--enable-auto-upgrade false
7899
```
79100

80-
To enable automatic extension upgrade for an extension using Azure PowerShell, use the [Update-AzConnectedMachineExtension](/powershell/module/az.connectedmachine/update-azconnectedmachineextension) cmdlet:
81-
82-
```azurepowershell
83-
Update-AzConnectedMachineExtension -ResourceGroup resourceGroupName -MachineName machineName -Name DependencyAgentLinux -EnableAutomaticUpgrade
84-
```
101+
### [Azure PowerShell](#tab/azure-powershell)
85102

86103
To check the status of automatic extension upgrade for all extensions on an Arc-enabled server, run the following command:
87104

88105
```azurepowershell
89106
Get-AzConnectedMachineExtension -ResourceGroup resourceGroupName -MachineName machineName | Format-Table Name, EnableAutomaticUpgrade
90107
```
91108

92-
## Extension upgrades with multiple extensions
109+
To enable automatic upgrades for an extension using Azure PowerShell, use the [Update-AzConnectedMachineExtension](/powershell/module/az.connectedmachine/update-azconnectedmachineextension) cmdlet:
93110

94-
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.
111+
```azurepowershell
112+
Update-AzConnectedMachineExtension -ResourceGroup resourceGroupName -MachineName machineName -Name extensionName -EnableAutomaticUpgrade
113+
```
95114

96-
If multiple extension upgrades are available for a machine, the upgrades may be batched together, but each extension upgrade is applied individually on a machine. A failure on one extension doesn't impact the other extension(s) to be upgraded. For example, if two extensions are scheduled for an upgrade, and the first extension upgrade fails, the second extension will still be upgraded.
115+
To disable automatic upgrades, set `-EnableAutomaticUpgrade:$false` as shown in the example below:
97116

98-
## Disable automatic extension upgrade
117+
```azurepowershell
118+
Update-AzConnectedMachineExtension -ResourceGroup resourceGroupName -MachineName machineName -Name extensionName -EnableAutomaticUpgrade:$false
119+
```
99120

100-
To disable automatic extension upgrade for an extension, set the `enable-auto-upgrade` property to `false`.
121+
> [!TIP]
122+
> The cmdlets above come from the [Az.ConnectedMachine](/powershell/module/az.connectedmachine) PowerShell module. You can install this PowerShell module with `Install-Module Az.ConnectedMachine` on your computer or in Azure Cloud Shell.
101123
102-
With Azure CLI, use the [az connectedmachine extension update](/cli/azure/connectedmachine/extension) command to disable automatic upgrade on an extension:
124+
---
103125

104-
```azurecli
105-
az connectedmachine extension update \
106-
--resource-group resourceGroupName \
107-
--machine-name machineName \
108-
--name DependencyAgentLinux \
109-
--enable-auto-upgrade false
110-
```
126+
## Extension upgrades with multiple extensions
111127

112-
With Azure PowerShell, use the [Update-AzConnectedMachineExtension](/powershell/module/az.connectedmachine/update-azconnectedmachineextension) cmdlet:
128+
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.
113129

114-
```azurepowershell
115-
Update-AzConnectedMachineExtension -ResourceGroup resourceGroupName -MachineName machineName -Name DependencyAgentLinux -EnableAutomaticUpgrade:$false
116-
```
130+
If multiple extension upgrades are available for a machine, the upgrades may be batched together, but each extension upgrade is applied individually on a machine. A failure on one extension doesn't impact the other extension(s) to be upgraded. For example, if two extensions are scheduled for an upgrade, and the first extension upgrade fails, the second extension will still be upgraded.
117131

118132
## Check automatic extension upgrade history
119133

120134
You can use the Azure Activity Log to identify extensions that were automatically upgraded. You can find the Activity Log tab on individual Azure Arc-enabled server resources, resource groups, and subscriptions. Extension upgrades are identified by the `Upgrade Extensions on Azure Arc machines (Microsoft.HybridCompute/machines/upgradeExtensions/action)` operation.
121135

122-
To view automatic extension upgrade history, search for the **Azure Activity Log** in the Azure Portal. Select **Add filter** and choose the Operation filter. For the filter criteria, search for "Upgrade Extensions on Azure Arc machines" and select that option. You can optionally add a second filter for **Event initiated by** and set "Azure Regional Service Manager" as the filter criteria to only see automatic upgrade attempts and exclude upgrades manually initiated by users.
136+
To view automatic extension upgrade history, search for the **Azure Activity Log** in the Azure portal. Select **Add filter** and choose the Operation filter. For the filter criteria, search for "Upgrade Extensions on Azure Arc machines" and select that option. You can optionally add a second filter for **Event initiated by** and set "Azure Regional Service Manager" as the filter criteria to only see automatic upgrade attempts and exclude upgrades manually initiated by users.
123137

124138
:::image type="content" source="media/manage-automatic-vm-extension-upgrade/azure-activity-log-extension-upgrade.png" alt-text="Azure Activity Log showing attempts to automatically upgrade extensions on Azure Arc-enabled servers." border="true":::
125139

60.6 KB
Loading
42 KB
Loading
27.7 KB
Loading

articles/azure-monitor/agents/azure-monitor-agent-manage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Remove-AzVMExtension -Name AzureMonitorLinuxAgent -ResourceGroupName <resource-g
165165

166166
### Update on Azure virtual machines
167167

168-
To perform a one-time update of the agent, you must first uninstall the existing agent version,. Then install the new version as described.
168+
To perform a one-time update of the agent, you must first uninstall the existing agent version, then install the new version as described.
169169

170170
We recommend that you enable automatic update of the agent by enabling the [Automatic Extension Upgrade](../../virtual-machines/automatic-extension-upgrade.md) feature by using the following PowerShell commands.
171171

@@ -235,7 +235,7 @@ Update-AzConnectedExtension -ResourceGroupName $env.ResourceGroupName -MachineNa
235235
```
236236
---
237237

238-
We recommend that you enable automatic update of the agent by enabling the [Automatic Extension Upgrade (preview)](../../azure-arc/servers/manage-automatic-vm-extension-upgrade.md#enable-automatic-extension-upgrade) feature by using the following PowerShell commands.
238+
We recommend that you enable automatic update of the agent by enabling the [Automatic Extension Upgrade](../../azure-arc/servers/manage-automatic-vm-extension-upgrade.md#manage-automatic-extension-upgrade) feature by using the following PowerShell commands.
239239

240240
# [Windows](#tab/PowerShellWindowsArc)
241241

@@ -308,7 +308,7 @@ az vm extension delete --resource-group <resource-group-name> --vm-name <virtual
308308

309309
### Update on Azure virtual machines
310310

311-
To perform a one-time update of the agent, you must first uninstall the existing agent version,. Then install the new version as described.
311+
To perform a one-time update of the agent, you must first uninstall the existing agent version, then install the new version as described.
312312

313313
We recommend that you enable automatic update of the agent by enabling the [Automatic Extension Upgrade](../../virtual-machines/automatic-extension-upgrade.md) feature by using the following CLI commands.
314314

@@ -374,7 +374,7 @@ az connectedmachine upgrade-extension --extension-targets "{\"Microsoft.Azure.Mo
374374
```
375375
---
376376

377-
We recommend that you enable automatic update of the agent by enabling the [Automatic Extension Upgrade (preview)](../../azure-arc/servers/manage-automatic-vm-extension-upgrade.md#enable-automatic-extension-upgrade) feature by using the following PowerShell commands.
377+
We recommend that you enable automatic update of the agent by enabling the [Automatic Extension Upgrade](../../azure-arc/servers/manage-automatic-vm-extension-upgrade.md#manage-automatic-extension-upgrade) feature by using the following PowerShell commands.
378378

379379
# [Windows](#tab/CLIWindowsArc)
380380

0 commit comments

Comments
 (0)