Skip to content

Commit 8f8cab4

Browse files
committed
Changing 'the Azure Monitor agent' to 'Azure Monitor Agent' globally
1 parent 7f13a74 commit 8f8cab4

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

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

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Manage the Azure Monitor agent
3-
description: Options for managing the Azure Monitor agent on Azure virtual machines and Azure Arc-enabled servers.
2+
title: Manage Azure Monitor Agent
3+
description: Options for managing Azure Monitor Agent on Azure virtual machines and Azure Arc-enabled servers.
44
ms.topic: conceptual
55
author: bwren
66
ms.author: bwren
@@ -10,13 +10,13 @@ ms.reviewer: shseth
1010

1111
---
1212

13-
# Manage the Azure Monitor agent
13+
# Manage Azure Monitor Agent
1414

15-
This article provides the different options currently available to install, uninstall, and update the [Azure Monitor agent](azure-monitor-agent-overview.md). This agent extension can be installed on Azure virtual machines, scale sets, and Azure Arc-enabled servers. It also lists the options to create [associations with data collection rules](data-collection-rule-azure-monitor-agent.md) that define which data the agent should collect. Installing, upgrading, or uninstalling the Azure Monitor agent won't require you to restart your server.
15+
This article provides the different options currently available to install, uninstall, and update the [Azure Monitor agent](azure-monitor-agent-overview.md). This agent extension can be installed on Azure virtual machines, scale sets, and Azure Arc-enabled servers. It also lists the options to create [associations with data collection rules](data-collection-rule-azure-monitor-agent.md) that define which data the agent should collect. Installing, upgrading, or uninstalling Azure Monitor Agent won't require you to restart your server.
1616

1717
## Virtual machine extension details
1818

19-
The Azure Monitor agent is implemented as an [Azure VM extension](../../virtual-machines/extensions/overview.md) with the details in the following table. You can install it by using any of the methods to install virtual machine extensions including the methods described in this article.
19+
Azure Monitor Agent is implemented as an [Azure VM extension](../../virtual-machines/extensions/overview.md) with the details in the following table. You can install it by using any of the methods to install virtual machine extensions including the methods described in this article.
2020

2121
| Property | Windows | Linux |
2222
|:---|:---|:---|
@@ -30,7 +30,7 @@ View [Azure Monitor agent extension versions](./azure-monitor-agent-extension-ve
3030

3131
## Prerequisites
3232

33-
The following prerequisites must be met prior to installing the Azure Monitor agent.
33+
The following prerequisites must be met prior to installing Azure Monitor Agent.
3434

3535
- **Permissions**: For methods other than using the Azure portal, you must have the following role assignments to install the agent:
3636

@@ -40,7 +40,7 @@ The following prerequisites must be met prior to installing the Azure Monitor ag
4040
| Any role that includes the action *Microsoft.Resources/deployments/** | <ul><li>Subscription and/or</li><li>Resource group and/or </li></ul> | To deploy Azure Resource Manager templates |
4141
- **Non-Azure**: To install the agent on physical servers and virtual machines hosted *outside* of Azure (that is, on-premises) or in other clouds, you must [install the Azure Arc Connected Machine agent](../../azure-arc/servers/agent-overview.md) first, at no added cost.
4242
- **Authentication**: [Managed identity](../../active-directory/managed-identities-azure-resources/overview.md) must be enabled on Azure virtual machines. Both user-assigned and system-assigned managed identities are supported.
43-
- **User-assigned**: This managed identity is recommended for large-scale deployments, configurable via [built-in Azure policies](#use-azure-policy). You can create a user-assigned managed identity once and share it across multiple VMs, which means it's more scalable than a system-assigned managed identity. If you use a user-assigned managed identity, you must pass the managed identity details to the Azure Monitor agent via extension settings:
43+
- **User-assigned**: This managed identity is recommended for large-scale deployments, configurable via [built-in Azure policies](#use-azure-policy). You can create a user-assigned managed identity once and share it across multiple VMs, which means it's more scalable than a system-assigned managed identity. If you use a user-assigned managed identity, you must pass the managed identity details to Azure Monitor Agent via extension settings:
4444

4545
```json
4646
{
@@ -63,21 +63,21 @@ The following prerequisites must be met prior to installing the Azure Monitor ag
6363
(If you use private links on the agent, you must also add the [dce endpoints](../essentials/data-collection-endpoint-overview.md#components-of-a-data-collection-endpoint)).
6464

6565
> [!NOTE]
66-
> This article only pertains to agent installation or management. After you install the agent, you must review the next article to [configure data collection rules and associate them with the machines](./data-collection-rule-azure-monitor-agent.md) with agents installed. *The Azure Monitor agents can't function without being associated with data collection rules.*
66+
> This article only pertains to agent installation or management. After you install the agent, you must review the next article to [configure data collection rules and associate them with the machines](./data-collection-rule-azure-monitor-agent.md) with agents installed. *Azure Monitor Agents can't function without being associated with data collection rules.*
6767

6868
## Install
6969

7070
#### [Portal](#tab/azure-portal)
7171

72-
To install the Azure Monitor agent by using the Azure portal, follow the process to [create a data collection rule](data-collection-rule-azure-monitor-agent.md#create-data-collection-rule-and-association) in the Azure portal. This process creates the rule, associates it to the selected resources, and installs the Azure Monitor agent on them if it's not already installed.
72+
To install Azure Monitor Agent by using the Azure portal, follow the process to [create a data collection rule](data-collection-rule-azure-monitor-agent.md#create-data-collection-rule-and-association) in the Azure portal. This process creates the rule, associates it to the selected resources, and installs Azure Monitor Agent on them if it's not already installed.
7373

7474
#### [PowerShell](#tab/azure-powershell)
7575

76-
You can install the Azure Monitor agent on Azure virtual machines and on Azure Arc-enabled servers by using the PowerShell command for adding a virtual machine extension.
76+
You can install Azure Monitor Agent on Azure virtual machines and on Azure Arc-enabled servers by using the PowerShell command for adding a virtual machine extension.
7777

7878
### Install on Azure virtual machines
7979

80-
Use the following PowerShell commands to install the Azure Monitor agent on Azure virtual machines. Choose the appropriate command based on your chosen authentication method.
80+
Use the following PowerShell commands to install Azure Monitor Agent on Azure virtual machines. Choose the appropriate command based on your chosen authentication method.
8181

8282
#### User-assigned managed identity
8383

@@ -105,7 +105,7 @@ Use the following PowerShell commands to install the Azure Monitor agent on Azur
105105

106106
### Install on Azure Arc-enabled servers
107107

108-
Use the following PowerShell commands to install the Azure Monitor agent on Azure Arc-enabled servers.
108+
Use the following PowerShell commands to install Azure Monitor Agent on Azure Arc-enabled servers.
109109

110110
- Windows
111111
```powershell
@@ -119,11 +119,11 @@ Use the following PowerShell commands to install the Azure Monitor agent on Azur
119119

120120
#### [Azure CLI](#tab/azure-cli)
121121

122-
You can install the Azure Monitor agent on Azure virtual machines and on Azure Arc-enabled servers by using the Azure CLI command for adding a virtual machine extension.
122+
You can install Azure Monitor Agent on Azure virtual machines and on Azure Arc-enabled servers by using the Azure CLI command for adding a virtual machine extension.
123123

124124
### Install on Azure virtual machines
125125

126-
Use the following CLI commands to install the Azure Monitor agent on Azure virtual machines. Choose the appropriate command based on your chosen authentication method.
126+
Use the following CLI commands to install Azure Monitor Agent on Azure virtual machines. Choose the appropriate command based on your chosen authentication method.
127127

128128
#### User-assigned managed identity
129129

@@ -151,7 +151,7 @@ Use the following CLI commands to install the Azure Monitor agent on Azure virtu
151151

152152
### Install on Azure Arc-enabled servers
153153

154-
Use the following CLI commands to install the Azure Monitor agent on Azure Arc-enabled servers.
154+
Use the following CLI commands to install Azure Monitor Agent on Azure Arc-enabled servers.
155155

156156
- Windows
157157
```azurecli
@@ -165,7 +165,7 @@ Use the following CLI commands to install the Azure Monitor agent on Azure Arc-e
165165

166166
#### [Resource Manager template](#tab/azure-resource-manager)
167167

168-
You can use Resource Manager templates to install the Azure Monitor agent on Azure virtual machines and on Azure Arc-enabled servers and to create an association with data collection rules. You must create any data collection rule prior to creating the association.
168+
You can use Resource Manager templates to install Azure Monitor Agent on Azure virtual machines and on Azure Arc-enabled servers and to create an association with data collection rules. You must create any data collection rule prior to creating the association.
169169

170170
Get sample templates for installing the agent and creating the association from the following resources:
171171

@@ -190,13 +190,13 @@ Install the templates by using [any deployment method for Resource Manager templ
190190

191191
#### [Portal](#tab/azure-portal)
192192

193-
To uninstall the Azure Monitor agent by using the Azure portal, go to your virtual machine, scale set, or Azure Arc-enabled server. Select the **Extensions** tab and select **AzureMonitorWindowsAgent** or **AzureMonitorLinuxAgent**. In the dialog that opens, select **Uninstall**.
193+
To uninstall Azure Monitor Agent by using the Azure portal, go to your virtual machine, scale set, or Azure Arc-enabled server. Select the **Extensions** tab and select **AzureMonitorWindowsAgent** or **AzureMonitorLinuxAgent**. In the dialog that opens, select **Uninstall**.
194194

195195
#### [PowerShell](#tab/azure-powershell)
196196

197197
### Uninstall on Azure virtual machines
198198

199-
Use the following PowerShell commands to uninstall the Azure Monitor agent on Azure virtual machines.
199+
Use the following PowerShell commands to uninstall Azure Monitor Agent on Azure virtual machines.
200200

201201
- Windows
202202
```powershell
@@ -210,7 +210,7 @@ Use the following PowerShell commands to uninstall the Azure Monitor agent on Az
210210

211211
### Uninstall on Azure Arc-enabled servers
212212

213-
Use the following PowerShell commands to uninstall the Azure Monitor agent on Azure Arc-enabled servers.
213+
Use the following PowerShell commands to uninstall Azure Monitor Agent on Azure Arc-enabled servers.
214214

215215
- Windows
216216
```powershell
@@ -226,7 +226,7 @@ Use the following PowerShell commands to uninstall the Azure Monitor agent on Az
226226

227227
### Uninstall on Azure virtual machines
228228

229-
Use the following CLI commands to uninstall the Azure Monitor agent on Azure virtual machines.
229+
Use the following CLI commands to uninstall Azure Monitor Agent on Azure virtual machines.
230230

231231
- Windows
232232
```azurecli
@@ -240,7 +240,7 @@ Use the following CLI commands to uninstall the Azure Monitor agent on Azure vir
240240

241241
### Uninstall on Azure Arc-enabled servers
242242

243-
Use the following CLI commands to uninstall the Azure Monitor agent on Azure Arc-enabled servers.
243+
Use the following CLI commands to uninstall Azure Monitor Agent on Azure Arc-enabled servers.
244244

245245
- Windows
246246
```azurecli
@@ -367,7 +367,7 @@ N/A
367367
Use the following policies and policy initiatives to automatically install the agent and associate it with a data collection rule every time you create a virtual machine, scale set, or Azure Arc-enabled server.
368368

369369
> [!NOTE]
370-
> As per Microsoft Identity best practices, policies for installing the Azure Monitor agent on virtual machines and scale sets rely on user-assigned managed identity. This option is the more scalable and resilient managed identity for these resources.
370+
> As per Microsoft Identity best practices, policies for installing Azure Monitor Agent on virtual machines and scale sets rely on user-assigned managed identity. This option is the more scalable and resilient managed identity for these resources.
371371
> For Azure Arc-enabled servers, policies rely on system-assigned managed identity as the only supported option today.
372372
373373
### Built-in policy initiatives
@@ -378,15 +378,15 @@ Policy initiatives for Windows and Linux virtual machines, scale sets consist of
378378

379379
- (Optional) Create and assign built-in user-assigned managed identity, per subscription, per region. [Learn more](../../active-directory/managed-identities-azure-resources/how-to-assign-managed-identity-via-azure-policy.md#policy-definition-and-details).
380380
- `Bring Your Own User-Assigned Identity`: If set to `true`, it creates the built-in user-assigned managed identity in the predefined resource group and assigns it to all machines that the policy is applied to. If set to `false`, you can instead use existing user-assigned identity that *you must assign* to the machines beforehand.
381-
- Install the Azure Monitor agent extension on the machine, and configure it to use user-assigned identity as specified by the following parameters.
381+
- Install Azure Monitor Agent extension on the machine, and configure it to use user-assigned identity as specified by the following parameters.
382382
- `Bring Your Own User-Assigned Managed Identity`: If set to `false`, it configures the agent to use the built-in user-assigned managed identity created by the preceding policy. If set to `true`, it configures the agent to use an existing user-assigned identity that *you must assign* to the machines in scope beforehand.
383383
- `User-Assigned Managed Identity Name`: If you use your own identity (selected `true`), specify the name of the identity that's assigned to the machines.
384384
- `User-Assigned Managed Identity Resource Group`: If you use your own identity (selected `true`), specify the resource group where the identity exists.
385385
- `Additional Virtual Machine Images`: Pass additional VM image names that you want to apply the policy to, if not already included.
386386
- Create and deploy the association to link the machine to specified data collection rule.
387387
- `Data Collection Rule Resource Id`: The Azure Resource Manager resourceId of the rule you want to associate via this policy to all machines the policy is applied to.
388388

389-
![Partial screenshot from the Azure Policy Definitions page that shows two built-in policy initiatives for configuring the Azure Monitor agent.](media/azure-monitor-agent-install/built-in-ama-dcr-initiatives.png)
389+
![Partial screenshot from the Azure Policy Definitions page that shows two built-in policy initiatives for configuring Azure Monitor Agent.](media/azure-monitor-agent-install/built-in-ama-dcr-initiatives.png)
390390

391391
#### Known issues
392392

@@ -399,15 +399,15 @@ Policy initiatives for Windows and Linux virtual machines, scale sets consist of
399399

400400
You can choose to use the individual policies from the preceding policy initiative to perform a single action at scale. For example, if you *only* want to automatically install the agent, use the second agent installation policy from the initiative, as shown.
401401

402-
![Partial screenshot from the Azure Policy Definitions page that shows policies contained within the initiative for configuring the Azure Monitor agent.](media/azure-monitor-agent-install/built-in-ama-dcr-policy.png)
402+
![Partial screenshot from the Azure Policy Definitions page that shows policies contained within the initiative for configuring Azure Monitor Agent.](media/azure-monitor-agent-install/built-in-ama-dcr-policy.png)
403403

404404
### Remediation
405405

406-
The initiatives or policies will apply to each virtual machine as it's created. A [remediation task](../../governance/policy/how-to/remediate-resources.md) deploys the policy definitions in the initiative to existing resources, so you can configure the Azure Monitor agent for any resources that were already created.
406+
The initiatives or policies will apply to each virtual machine as it's created. A [remediation task](../../governance/policy/how-to/remediate-resources.md) deploys the policy definitions in the initiative to existing resources, so you can configure Azure Monitor Agent for any resources that were already created.
407407

408408
When you create the assignment by using the Azure portal, you have the option of creating a remediation task at the same time. For information on the remediation, see [Remediate non-compliant resources with Azure Policy](../../governance/policy/how-to/remediate-resources.md).
409409

410-
![Screenshot that shows initiative remediation for the Azure Monitor agent.](media/azure-monitor-agent-install/built-in-ama-dcr-remediation.png)
410+
![Screenshot that shows initiative remediation for Azure Monitor Agent.](media/azure-monitor-agent-install/built-in-ama-dcr-remediation.png)
411411

412412
## Next steps
413413

0 commit comments

Comments
 (0)