Skip to content

Commit d56a3c3

Browse files
authored
Merge pull request #81737 from Tbohunek/extensionupdates
Clarify VM Extensions automatic updates
2 parents b072256 + c9a36c9 commit d56a3c3

File tree

3 files changed

+30
-9
lines changed

3 files changed

+30
-9
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The Log Analytics agent for Windows and Linux can be upgraded to the latest rele
1818

1919
| Environment | Installation Method | Upgrade method |
2020
|--------|----------|-------------|
21-
| Azure VM | Log Analytics agent VM extension for Windows/Linux | Agent is automatically upgraded by default unless you configured your Azure Resource Manager template to opt out by setting the property *autoUpgradeMinorVersion* to **false**. |
21+
| Azure VM | Log Analytics agent VM extension for Windows/Linux | Agent is automatically upgraded by default [after the VM model changes](../../virtual-machines/extensions/features-linux.md#how-do-agents-and-extensions-get-updated), unless you configured your Azure Resource Manager template to opt out by setting the property *autoUpgradeMinorVersion* to **false**. |
2222
| Custom Azure VM images | Manual install of Log Analytics agent for Windows/Linux | Updating VMs to the newest version of the agent needs to be performed from the command line running the Windows installer package or Linux self-extracting and installable shell script bundle.|
2323
| Non-Azure VMs | Manual install of Log Analytics agent for Windows/Linux | Updating VMs to the newest version of the agent needs to be performed from the command line running the Windows installer package or Linux self-extracting and installable shell script bundle. |
2424

@@ -290,4 +290,4 @@ Perform the following steps to configure the Log Analytics agent for Linux to re
290290
291291
- Review [Troubleshooting the Linux agent](agent-linux-troubleshoot.md) if you encounter issues while installing or managing the Linux agent.
292292
293-
- Review [Troubleshooting the Windows agent](agent-windows-troubleshoot.md) if you encounter issues while installing or managing the Windows agent.
293+
- Review [Troubleshooting the Windows agent](agent-windows-troubleshoot.md) if you encounter issues while installing or managing the Windows agent.

articles/virtual-machines/extensions/features-linux.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,9 +206,9 @@ Moving the **command to execute** property to the **protected** configuration se
206206

207207
### How do agents and extensions get updated?
208208

209-
The Agents and Extensions share the same update mechanism. Some updates do not require additional firewall rules.
209+
Agents and extensions share the same automatic update mechanism.
210210

211-
When an update is available, it is only installed on the VM when there is a change to extensions, and other VM Model changes such as:
211+
When an update is available and automatic updates are enabled, the update is installed on the VM only after there is a change to an extension or after other VM model changes, such as:
212212

213213
- Data disks
214214
- Extensions
@@ -217,8 +217,14 @@ When an update is available, it is only installed on the VM when there is a chan
217217
- VM size
218218
- Network profile
219219

220+
> [!IMPORTANT]
221+
> The update is installed only after there is a change to the VM model.
222+
220223
Publishers make updates available to regions at different times, so it is possible you can have VMs in different regions on different versions.
221224

225+
> [!NOTE]
226+
> Some updates might require additional firewall rules. See [Network access](#network-access).
227+
222228
#### Agent updates
223229

224230
The Linux VM Agent contains *Provisioning Agent Code* and *Extension Handling code* in one package, which cannot be separated. You can disable the *Provisioning Agent* when you want to provision on Azure using cloud-init. To do this, see [using cloud-init](../linux/using-cloud-init.md).
@@ -253,7 +259,9 @@ It is highly recommended that you always have auto update for the agent, [AutoUp
253259

254260
#### Extension updates
255261

256-
When an extension update is available, the Linux Agent downloads and upgrades the extension. Automatic extension updates are either *Minor* or *Hotfix*. You can opt in or opt out of extensions *Minor* updates when you provision the extension. The following example shows how to automatically upgrade minor versions in a Resource Manager template with *autoUpgradeMinorVersion": true,'*:
262+
When an extension update is available and automatic updates are enabled, after a [change to the VM model](#how-do-agents-and-extensions-get-updated) occurs, the Linux Agent downloads and upgrades the extension.
263+
264+
Automatic extension updates are either *Minor* or *Hotfix*. You can opt in or opt out of extension *Minor* updates when you provision the extension. The following example shows how to automatically upgrade minor versions in a Resource Manager template with *"autoUpgradeMinorVersion": true,*:
257265

258266
```json
259267
"publisher": "Microsoft.Azure.Extensions",
@@ -269,6 +277,8 @@ When an extension update is available, the Linux Agent downloads and upgrades th
269277

270278
To get the latest minor release bug fixes, it is highly recommended that you always select auto update in your extension deployments. Hotfix updates that carry security or key bug fixes cannot be opted out.
271279

280+
If you disable extension automatic updates or you need to upgrade a major version, use [az vm extension set](/cli/azure/vm/extension#az_vm_extension_set) and specify the target version.
281+
272282
### How to identify extension updates
273283

274284
#### Identifying if the extension is set with autoUpgradeMinorVersion on a VM

articles/virtual-machines/extensions/features-windows.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Set-AzVMCustomScriptExtension -ResourceGroupName "myResourceGroup" `
116116
-Run "Create-File.ps1" -Location "West US"
117117
```
118118

119-
In the following example, the VM Access extension is used to reset the administrative password of a Windows VM to a temporary password. For more information on the VM Access extension, see [Reset Remote Desktop service in a Windows VM](/troubleshoot/azure/virtual-machines/reset-rdp). Once you have run this, you should reset the password at first login:
119+
In the following example, the VM Access extension is used to reset the administrative password of a Windows VM to a temporary password. For more information on the VM Access extension, see [Reset Remote Desktop service in a Windows VM](/troubleshoot/azure/virtual-machines/reset-rdp). After you have run this, you should reset the password at first login:
120120

121121
```powershell
122122
$cred=Get-Credential
@@ -247,9 +247,9 @@ These certificates secure the communication between the VM and its host during t
247247

248248
### How do agents and extensions get updated?
249249

250-
The Agents and Extensions share the same update mechanism. Some updates do not require additional firewall rules.
250+
Agents and extensions share the same automatic update mechanism.
251251

252-
When an update is available, it is only installed on the VM when there is a change to extensions, and other VM Model changes such as:
252+
When an update is available and automatic updates are enabled, the update is installed on the VM only after there is a change to an extension or other VM model changes, such as:
253253

254254
- Data disks
255255
- Extensions
@@ -258,8 +258,14 @@ When an update is available, it is only installed on the VM when there is a chan
258258
- VM size
259259
- Network profile
260260

261+
> [!IMPORTANT]
262+
> The update is installed only after there is a change to the VM model.
263+
261264
Publishers make updates available to regions at different times, so it is possible you can have VMs in different regions on different versions.
262265

266+
> [!NOTE]
267+
> Some updates might require additional firewall rules. See [Network access](#network-access).
268+
263269
#### Listing Extensions Deployed to a VM
264270

265271
```powershell
@@ -283,7 +289,10 @@ To check what version you are running, see [Detecting installed Windows Guest Ag
283289

284290
#### Extension updates
285291

286-
When an extension update is available, the Windows Guest Agent downloads and upgrades the extension. Automatic extension updates are either *Minor* or *Hotfix*. You can opt in or opt out of extensions *Minor* updates when you provision the extension. The following example shows how to automatically upgrade minor versions in a Resource Manager template with *autoUpgradeMinorVersion": true,'*:
292+
293+
When an extension update is available and automatic updates are enabled, after a [change to the VM model](#how-do-agents-and-extensions-get-updated) occurs, the Windows Guest Agent downloads and upgrades the extension.
294+
295+
Automatic extension updates are either *Minor* or *Hotfix*. You can opt in or opt out of extension *Minor* updates when you provision the extension. The following example shows how to automatically upgrade minor versions in a Resource Manager template with *"autoUpgradeMinorVersion": true,*:
287296

288297
```json
289298
"properties": {
@@ -300,6 +309,8 @@ When an extension update is available, the Windows Guest Agent downloads and upg
300309

301310
To get the latest minor release bug fixes, it is highly recommended that you always select auto update in your extension deployments. Hotfix updates that carry security or key bug fixes cannot be opted out.
302311

312+
If you disable extension automatic updates or you need to upgrade a major version, use [Set-AzVMExtension](/powershell/module/az.compute/set-azvmextension) and specify the target version.
313+
303314
### How to identify extension updates
304315

305316
#### Identifying if the extension is set with autoUpgradeMinorVersion on a VM

0 commit comments

Comments
 (0)