Skip to content

Commit 520db87

Browse files
committed
Merge branch 'virtual-machines-extensions' of https://github.com/ShawnJackson/azure-docs-pr into virtual-machines-extensions
2 parents eccfd7f + d5c19ae commit 520db87

File tree

2 files changed

+39
-39
lines changed

2 files changed

+39
-39
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Azure Linux Agent overview
3-
description: Learn how to install and configure the Azure Linux Agent (waagent) to manage your virtual machine's interaction with the Azure fabric controller.
2+
title: Azure Linux VM Agent overview
3+
description: Learn how to install and configure the Azure Linux VM Agent (waagent) to manage your virtual machine's interaction with the Azure fabric controller.
44
ms.topic: article
55
ms.service: virtual-machines
66
ms.subservice: extensions
@@ -11,11 +11,11 @@ ms.collection: linux
1111
ms.date: 03/28/2023
1212

1313
---
14-
# Azure Linux Agent overview
14+
# Azure Linux VM Agent overview
1515

16-
The Microsoft Azure Linux Agent (waagent) manages Linux and FreeBSD provisioning, along with virtual machine (VM) interaction with the Azure fabric controller. In addition to the Linux agent providing provisioning functionality, Azure provides the option of using cloud-init for some Linux operating systems.
16+
The Microsoft Azure Linux VM Agent (waagent) manages Linux and FreeBSD provisioning, along with virtual machine (VM) interaction with the Azure fabric controller. In addition to the Linux agent providing provisioning functionality, Azure provides the option of using cloud-init for some Linux operating systems.
1717

18-
The Linux agent provides the following functionality for Linux and FreeBSD Azure Virtual Machines deployments. For more information, see [Microsoft Azure Linux Agent](https://github.com/Azure/WALinuxAgent/blob/master/README.md).
18+
The Linux agent provides the following functionality for Linux and FreeBSD Azure Virtual Machines deployments. For more information, see the [Azure Linux VM Agent readme on GitHub](https://github.com/Azure/WALinuxAgent/blob/master/README.md).
1919

2020
### Image provisioning
2121

@@ -24,7 +24,7 @@ The Linux agent provides the following functionality for Linux and FreeBSD Azure
2424
- Deploys SSH public keys and key pairs
2525
- Sets the host name
2626
- Publishes the host name to the platform DNS
27-
- Reports SSH host key fingerprints to the platform
27+
- Reports the SSH host key fingerprint to the platform
2828
- Manages the resource disk
2929
- Formats and mounts the resource disk
3030
- Configures swap space
@@ -63,7 +63,7 @@ Information flow from the platform to the agent occurs through two channels:
6363

6464
## Requirements
6565

66-
Testing has confirmed that the following systems work with the Azure Linux Agent.
66+
Testing has confirmed that the following systems work with the Azure Linux VM Agent.
6767

6868
> [!NOTE]
6969
> This list might differ from the [endorsed Linux distributions on Azure](../linux/endorsed-distros.md).
@@ -86,7 +86,7 @@ Testing has confirmed that the following systems work with the Azure Linux Agent
8686
8787
Other supported systems:
8888

89-
- FreeBSD 10+ (Azure Linux Agent v2.0.10+)
89+
- FreeBSD 10+ (Azure Linux VM Agent v2.0.10+)
9090

9191
The Linux agent depends on these system packages to function properly:
9292

@@ -103,9 +103,9 @@ Ensure that your VM has access to IP address 168.63.129.16. For more information
103103

104104
## Installation
105105

106-
The preferred method of installing and upgrading the Azure Linux Agent uses an RPM or a DEB package from your distribution's package repository. All the [endorsed distribution providers](../linux/endorsed-distros.md) integrate the Azure Linux Agent package into their images and repositories.
106+
The preferred method of installing and upgrading the Azure Linux VM Agent uses an RPM or a DEB package from your distribution's package repository. All the [endorsed distribution providers](../linux/endorsed-distros.md) integrate the Azure Linux VM Agent package into their images and repositories.
107107

108-
For advanced installation options, such as installing from a source or to custom locations or prefixes, see [Microsoft Azure Linux Agent](https://github.com/Azure/WALinuxAgent).
108+
For advanced installation options, such as installing from a source or to custom locations or prefixes, see [Microsoft Azure Linux VM Agent](https://github.com/Azure/WALinuxAgent).
109109

110110
## Command-line options
111111

@@ -384,7 +384,7 @@ You can disable this option by editing */etc/waagent.conf*. Update `Logs.Collect
384384

385385
## Ubuntu Cloud Images
386386

387-
Ubuntu Cloud Images use [cloud-init](https://launchpad.net/ubuntu/+source/cloud-init) to do many configuration tasks that the Azure Linux Agent would otherwise manage. The following differences apply:
387+
Ubuntu Cloud Images use [cloud-init](https://launchpad.net/ubuntu/+source/cloud-init) to do many configuration tasks that the Azure Linux VM Agent would otherwise manage. The following differences apply:
388388

389389
- `Provisioning.Enabled` defaults to `n` on Ubuntu Cloud Images that use cloud-init to perform provisioning tasks.
390390
- The following configuration parameters have no effect on Ubuntu Cloud Images that use cloud-init to manage the resource disk and swap space:

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

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
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.
44
ms.topic: article
55
ms.service: virtual-machines
66
ms.subservice: extensions
@@ -10,15 +10,15 @@ ms.collection: windows
1010
ms.date: 02/27/2023
1111
---
1212

13-
# Azure Virtual Machine Agent overview
13+
# Azure Azure Windows VM Agent overview
1414

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.
1616

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.
1818

1919
## Prerequisites
2020

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:
2222

2323
- Windows 10
2424
- Windows 11
@@ -34,24 +34,24 @@ The VM Agent supports the x64 architecture for these Windows operating systems:
3434
- Windows Server 2022 Core
3535

3636
> [!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).
3838
>
3939
> - 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).
4040
>
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.
4242
>
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.
4444
45-
## Install the VM Agent
45+
## Install the Azure Windows VM Agent
4646

4747
### Azure Marketplace image
4848

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.
5050

51-
The Windows Guest Agent Package has two parts:
51+
The Azure Windows VM Agent package has two parts:
5252

53-
- Provisioning Agent (PA)
54-
- Windows Guest Agent (WinGA)
53+
- Azure Windows Provisioning Agent (PA)
54+
- Azure Windows Guest Agent (WinGA)
5555

5656
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:
5757

@@ -81,23 +81,23 @@ If you don't have the agents installed, you can't use some Azure services, such
8181

8282
### Manual installation
8383

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.
8585

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.
8787

8888
> [!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.
9090
9191
```powershell
9292
$vm.OSProfile.AllowExtensionOperations = $true
9393
$vm | Update-AzVM
9494
```
9595

96-
## Detect the VM Agent
96+
## Detect the Azure Windows VM Agent
9797

9898
### PowerShell
9999

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):
101101

102102
```powershell
103103
Get-AzVM
@@ -114,7 +114,7 @@ OSProfile :
114114
EnableAutomaticUpdates : True
115115
```
116116

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:
118118

119119
```powershell
120120
$vms = Get-AzVM
@@ -125,7 +125,7 @@ foreach ($vm in $vms) {
125125
}
126126
```
127127

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:
129129

130130
```powershell
131131
$vms = Get-AzVM
@@ -138,21 +138,21 @@ foreach ($vm in $vms) {
138138

139139
### Manual detection
140140

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.
142142

143-
## Upgrade the VM Agent
143+
## Upgrade the Azure Windows VM Agent
144144

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.
146146

147-
## Windows Guest Agent automatic log collection
147+
## Azure Windows Guest Agent automatic log collection
148148

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.
150150

151151
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.
152152

153-
## Guest Agent and OSProfile certificates
153+
## Azure Windows Guest Agent and OSProfile certificates
154154

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.
156156

157157
For a virtual machine, use [Remove-AzVMSecret](/powershell/module/az.compute/remove-azvmsecret) to remove certificates from `OSProfile`.
158158

0 commit comments

Comments
 (0)