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/azure-monitor/agents/azure-monitor-agent-manage.md
+27-27Lines changed: 27 additions & 27 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: 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.
4
4
ms.topic: conceptual
5
5
author: bwren
6
6
ms.author: bwren
@@ -10,13 +10,13 @@ ms.reviewer: shseth
10
10
11
11
---
12
12
13
-
# Manage the Azure Monitor agent
13
+
# Manage Azure Monitor Agent
14
14
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.
16
16
17
17
## Virtual machine extension details
18
18
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.
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.
34
34
35
35
-**Permissions**: For methods other than using the Azure portal, you must have the following role assignments to install the agent:
36
36
@@ -40,7 +40,7 @@ The following prerequisites must be met prior to installing the Azure Monitor ag
40
40
| 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 |
41
41
-**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.
42
42
-**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:
44
44
45
45
```json
46
46
{
@@ -63,21 +63,21 @@ The following prerequisites must be met prior to installing the Azure Monitor ag
63
63
(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)).
64
64
65
65
> [!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.*
67
67
68
68
## Install
69
69
70
70
#### [Portal](#tab/azure-portal)
71
71
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.
73
73
74
74
#### [PowerShell](#tab/azure-powershell)
75
75
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.
77
77
78
78
### Install on Azure virtual machines
79
79
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.
81
81
82
82
#### User-assigned managed identity
83
83
@@ -105,7 +105,7 @@ Use the following PowerShell commands to install the Azure Monitor agent on Azur
105
105
106
106
### Install on Azure Arc-enabled servers
107
107
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.
109
109
110
110
- Windows
111
111
```powershell
@@ -119,11 +119,11 @@ Use the following PowerShell commands to install the Azure Monitor agent on Azur
119
119
120
120
#### [Azure CLI](#tab/azure-cli)
121
121
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.
123
123
124
124
### Install on Azure virtual machines
125
125
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.
127
127
128
128
#### User-assigned managed identity
129
129
@@ -151,7 +151,7 @@ Use the following CLI commands to install the Azure Monitor agent on Azure virtu
151
151
152
152
### Install on Azure Arc-enabled servers
153
153
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.
155
155
156
156
- Windows
157
157
```azurecli
@@ -165,7 +165,7 @@ Use the following CLI commands to install the Azure Monitor agent on Azure Arc-e
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.
169
169
170
170
Get sample templates for installing the agent and creating the association from the following resources:
171
171
@@ -190,13 +190,13 @@ Install the templates by using [any deployment method for Resource Manager templ
190
190
191
191
#### [Portal](#tab/azure-portal)
192
192
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**.
194
194
195
195
#### [PowerShell](#tab/azure-powershell)
196
196
197
197
### Uninstall on Azure virtual machines
198
198
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.
200
200
201
201
- Windows
202
202
```powershell
@@ -210,7 +210,7 @@ Use the following PowerShell commands to uninstall the Azure Monitor agent on Az
210
210
211
211
### Uninstall on Azure Arc-enabled servers
212
212
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.
214
214
215
215
- Windows
216
216
```powershell
@@ -226,7 +226,7 @@ Use the following PowerShell commands to uninstall the Azure Monitor agent on Az
226
226
227
227
### Uninstall on Azure virtual machines
228
228
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.
230
230
231
231
- Windows
232
232
```azurecli
@@ -240,7 +240,7 @@ Use the following CLI commands to uninstall the Azure Monitor agent on Azure vir
240
240
241
241
### Uninstall on Azure Arc-enabled servers
242
242
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.
244
244
245
245
- Windows
246
246
```azurecli
@@ -367,7 +367,7 @@ N/A
367
367
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.
368
368
369
369
> [!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.
371
371
> For Azure Arc-enabled servers, policies rely on system-assigned managed identity as the only supported option today.
372
372
373
373
### Built-in policy initiatives
@@ -378,15 +378,15 @@ Policy initiatives for Windows and Linux virtual machines, scale sets consist of
378
378
379
379
- (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).
380
380
-`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.
382
382
-`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.
383
383
-`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.
384
384
-`User-Assigned Managed Identity Resource Group`: If you use your own identity (selected `true`), specify the resource group where the identity exists.
385
385
-`Additional Virtual Machine Images`: Pass additional VM image names that you want to apply the policy to, if not already included.
386
386
- Create and deploy the association to link the machine to specified data collection rule.
387
387
-`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.
388
388
389
-

389
+

390
390
391
391
#### Known issues
392
392
@@ -399,15 +399,15 @@ Policy initiatives for Windows and Linux virtual machines, scale sets consist of
399
399
400
400
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.
401
401
402
-

402
+

403
403
404
404
### Remediation
405
405
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.
407
407
408
408
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).
409
409
410
-

410
+

0 commit comments