You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/virtual-machines/extensions/agent-windows.md
+28-28Lines changed: 28 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
-
title: Azure Virtual Machine Agent overview
3
-
description: Learn how to install and detect the Azure Virtual Machine Agent to manage your virtual machine's interaction with the Azure fabric controller.
2
+
title: Azure Windows VM Agent overview
3
+
description: Learn how to install and detect the Azure Windows VM Agent to manage your virtual machine's interaction with the Azure fabric controller.
4
4
ms.topic: article
5
5
ms.service: virtual-machines
6
6
ms.subservice: extensions
@@ -10,15 +10,15 @@ ms.collection: windows
10
10
ms.date: 02/27/2023
11
11
---
12
12
13
-
# Azure Virtual Machine Agent overview
13
+
# Azure Azure Windows VM Agent overview
14
14
15
-
The Microsoft Azure Virtual Machine Agent (VM Agent) is a secure, lightweight process that manages virtual machine (VM) interaction with the Azure fabric controller. The VM Agent has a primary role in enabling and executing Azure virtual machine extensions. VM extensions enable post-deployment configuration of VMs, such as installing and configuring software. VM extensions also enable recovery features such as resetting the administrative password of a VM. Without the Azure VM Agent, you can't run VM extensions.
15
+
The Microsoft Azure Windows VM Agent is a secure, lightweight process that manages virtual machine (VM) interaction with the Azure fabric controller. The Azure Windows VM Agent has a primary role in enabling and executing Azure virtual machine extensions. VM extensions enable post-deployment configuration of VMs, such as installing and configuring software. VM extensions also enable recovery features such as resetting the administrative password of a VM. Without the Azure Windows VM Agent, you can't run VM extensions.
16
16
17
-
This article describes how to install and detect the VM Agent.
17
+
This article describes how to install and detect the Azure Windows VM Agent.
18
18
19
19
## Prerequisites
20
20
21
-
The VM Agent supports the x64 architecture for these Windows operating systems:
21
+
The Azure Windows VM Agent supports the x64 architecture for these Windows operating systems:
22
22
23
23
- Windows 10
24
24
- Windows 11
@@ -34,24 +34,24 @@ The VM Agent supports the x64 architecture for these Windows operating systems:
34
34
- Windows Server 2022 Core
35
35
36
36
> [!IMPORTANT]
37
-
> - The Windows VM Agent needs at least Windows Server 2008 SP2 (64-bit) to run, with the .NET Framework 4.0. See [Minimum version support for virtual machine agents in Azure](https://support.microsoft.com/help/4049215/extensions-and-virtual-machine-agent-minimum-version-support).
37
+
> - The Azure Windows VM Agent needs at least Windows Server 2008 SP2 (64-bit) to run, with the .NET Framework 4.0. See [Minimum version support for virtual machine agents in Azure](https://support.microsoft.com/help/4049215/extensions-and-virtual-machine-agent-minimum-version-support).
38
38
>
39
39
> - Ensure that your VM has access to IP address 168.63.129.16. For more information, see [What is IP address 168.63.129.16?](../../virtual-network/what-is-ip-address-168-63-129-16.md).
40
40
>
41
-
> - Ensure that DHCP is enabled inside the guest VM. This is required to get the host or fabric address from DHCP for the IaaS VM Agent and extensions to work. If you need a static private IP address, you should configure it through the Azure portal or PowerShell, and make sure the DHCP option inside the VM is enabled. [Learn more](../../virtual-network/ip-services/virtual-networks-static-private-ip-arm-ps.md) about setting up a static IP address by using PowerShell.
41
+
> - Ensure that DHCP is enabled inside the guest VM. This is required to get the host or fabric address from DHCP for the Azure Windows VM Agent and extensions to work. If you need a static private IP address, you should configure it through the Azure portal or PowerShell, and make sure the DHCP option inside the VM is enabled. [Learn more](../../virtual-network/ip-services/virtual-networks-static-private-ip-arm-ps.md) about setting up a static IP address by using PowerShell.
42
42
>
43
-
> - Running the VM Agent in a nested virtualization VM might lead to unpredictable behavior, so it's not supported in that dev/test scenario.
43
+
> - Running the Azure Windows VM Agent in a nested virtualization VM might lead to unpredictable behavior, so it's not supported in that dev/test scenario.
44
44
45
-
## Install the VM Agent
45
+
## Install the Azure Windows VM Agent
46
46
47
47
### Azure Marketplace image
48
48
49
-
The Azure VM Agent is installed by default on any Windows VM deployed from an Azure Marketplace image. When you deploy an Azure Marketplace image from the Azure portal, PowerShell, the Azure CLI, or an Azure Resource Manager template, the Azure VM Agent is also installed.
49
+
The Azure Windows VM Agent is installed by default on any Windows VM deployed from an Azure Marketplace image. When you deploy an Azure Marketplace image from the Azure portal, PowerShell, the Azure CLI, or an Azure Resource Manager template, the Azure Windows VM Agent is also installed.
50
50
51
-
The Windows Guest Agent Package has two parts:
51
+
The Azure Windows VM Agent package has two parts:
52
52
53
-
- Provisioning Agent (PA)
54
-
- Windows Guest Agent (WinGA)
53
+
-Azure Windows Provisioning Agent (PA)
54
+
-Azure Windows Guest Agent (WinGA)
55
55
56
56
To boot a VM, you must have the PA installed on the VM. However, the WinGA does not need to be installed. At VM deploy time, you can select not to install the WinGA. The following example shows how to select the `provisionVmAgent` option with an Azure Resource Manager template:
57
57
@@ -81,23 +81,23 @@ If you don't have the agents installed, you can't use some Azure services, such
81
81
82
82
### Manual installation
83
83
84
-
You can manually install the Windows VM Agent by using a Windows Installer package. Manual installation might be necessary when you create a custom VM image that's deployed to Azure.
84
+
You can manually install the Azure Windows VM Agent by using a Windows Installer package. Manual installation might be necessary when you create a custom VM image that's deployed to Azure.
85
85
86
-
To manually install the Windows VM Agent, [download the VM Agent installer](https://github.com/Azure/WindowsVMAgent) and select the latest release. You can also search a specific version in the [GitHub Windows IaaS VM Agent releases](https://github.com/Azure/WindowsVMAgent/releases). The VM Agent is supported on Windows Server 2008 (64 bit) and later.
86
+
To manually install the Azure Windows VM Agent, [download the installer](https://github.com/Azure/WindowsVMAgent) and select the latest release. You can also search for a specific version in the [GitHub page for Azure Windows VM Agent releases](https://github.com/Azure/WindowsVMAgent/releases). The Azure Windows VM Agent is supported on Windows Server 2008 (64 bit) and later.
87
87
88
88
> [!NOTE]
89
-
> It's important to update the `AllowExtensionOperations` option after you manually install the VM Agent on a VM that was deployed from image without `ProvisionVMAgent` enabled.
89
+
> It's important to update the `AllowExtensionOperations` option after you manually install the Azure Windows VM Agent on a VM that was deployed from image without `ProvisionVMAgent` enabled.
90
90
91
91
```powershell
92
92
$vm.OSProfile.AllowExtensionOperations = $true
93
93
$vm | Update-AzVM
94
94
```
95
95
96
-
## Detect the VM Agent
96
+
## Detect the Azure Windows VM Agent
97
97
98
98
### PowerShell
99
99
100
-
You can use the Azure Resource Manager PowerShell module to get information about Azure VMs. To see information about a VM, such as the provisioning state for the Azure VM Agent, use [Get-AzVM](/powershell/module/az.compute/get-azvm):
100
+
You can use the Azure Resource Manager PowerShell module to get information about Azure VMs. To see information about a VM, such as the provisioning state for the Azure Windows VM Agent, use [Get-AzVM](/powershell/module/az.compute/get-azvm):
101
101
102
102
```powershell
103
103
Get-AzVM
@@ -114,7 +114,7 @@ OSProfile :
114
114
EnableAutomaticUpdates : True
115
115
```
116
116
117
-
Use the following script to return a concise list of VM names (running Windows OS) and the state of the VM Agent:
117
+
Use the following script to return a concise list of VM names (running Windows OS) and the state of the Azure Windows VM Agent:
118
118
119
119
```powershell
120
120
$vms = Get-AzVM
@@ -125,7 +125,7 @@ foreach ($vm in $vms) {
125
125
}
126
126
```
127
127
128
-
Use the following script to return a concise list of VM names (running Linux OS) and the state of the VM Agent:
128
+
Use the following script to return a concise list of VM names (running Linux OS) and the state of the Azure Windows VM Agent:
129
129
130
130
```powershell
131
131
$vms = Get-AzVM
@@ -138,21 +138,21 @@ foreach ($vm in $vms) {
138
138
139
139
### Manual detection
140
140
141
-
When you're logged in to a Windows VM, you can use Task Manager to examine running processes. To check for the Azure VM Agent, open Task Manager, select the **Details** tab, and look for a process named *WindowsAzureGuestAgent.exe*. The presence of this process indicates that the VM agent is installed.
141
+
When you're logged in to a Windows VM, you can use Task Manager to examine running processes. To check for the Azure Windows VM Agent, open Task Manager, select the **Details** tab, and look for a process named *WindowsAzureGuestAgent.exe*. The presence of this process indicates that the VM agent is installed.
142
142
143
-
## Upgrade the VM Agent
143
+
## Upgrade the Azure Windows VM Agent
144
144
145
-
The Azure VM Agent for Windows is automatically upgraded on images deployed from Azure Marketplace. The new versions are stored in Azure Storage, so ensure that you don't have firewalls blocking access. As new VMs are deployed to Azure, they receive the latest VM agent at VM provision time. If you installed the agent manually or are deploying custom VM images, you need to manually update to include the new VM agent at image creation time.
145
+
The Azure Windows VM Agent for Windows is automatically upgraded on images deployed from Azure Marketplace. The new versions are stored in Azure Storage, so ensure that you don't have firewalls blocking access. As new VMs are deployed to Azure, they receive the latest VM agent at VM provision time. If you installed the agent manually or are deploying custom VM images, you need to manually update to include the new VM agent at image creation time.
146
146
147
-
## Windows Guest Agent automatic log collection
147
+
## Azure Windows Guest Agent automatic log collection
148
148
149
-
The Windows Guest Agent has a feature to automatically collect some logs. The *CollectGuestLogs.exe* process controls this feature. It exists for both platform as a service (PaaS) cloud services and infrastructure as a service (IaaS) VMs. Its goal is to quickly and automatically collect diagnostics logs from a VM, so they can be used for offline analysis.
149
+
The Azure Windows Guest Agent has a feature to automatically collect some logs. The *CollectGuestLogs.exe* process controls this feature. It exists for both platform as a service (PaaS) cloud services and infrastructure as a service (IaaS) VMs. Its goal is to quickly and automatically collect diagnostics logs from a VM, so they can be used for offline analysis.
150
150
151
151
The collected logs are event logs, OS logs, Azure logs, and some registry keys. The agent produces a ZIP file that's transferred to the VM's host. Engineering teams and support professionals can then use this ZIP file to investigate issues on the request of the customer who owns the VM.
152
152
153
-
## Guest Agent and OSProfile certificates
153
+
## Azure Windows Guest Agent and OSProfile certificates
154
154
155
-
The Azure VM Agent installs the certificates referenced in the `OSProfile` value of a VM or a virtual machine scale set. If you manually remove these certificates from the Microsoft Management Console (MMC) Certificates snap-in inside the guest VM, the guest agent will add them back. To permanently remove a certificate, you have to remove it from `OSProfile`, and then remove it from within the guest operating system.
155
+
The Azure Windows VM Agent installs the certificates referenced in the `OSProfile` value of a VM or a virtual machine scale set. If you manually remove these certificates from the Microsoft Management Console (MMC) Certificates snap-in inside the guest VM, the Azure Windows Guest Agent will add them back. To permanently remove a certificate, you have to remove it from `OSProfile`, and then remove it from within the guest operating system.
156
156
157
157
For a virtual machine, use [Remove-AzVMSecret](/powershell/module/az.compute/remove-azvmsecret) to remove certificates from `OSProfile`.
0 commit comments