Skip to content

Commit bdc3b33

Browse files
authored
Merge pull request #249608 from guywi-ms/patch-67
Update agent-dependency-linux.md
2 parents 9a12bbb + 9a1ba45 commit bdc3b33

File tree

2 files changed

+74
-49
lines changed

2 files changed

+74
-49
lines changed

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

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
title: Azure Monitor Dependency virtual machine extension for Linux
33
description: Deploy the Azure Monitor Dependency agent on Linux virtual machine by using a virtual machine extension.
44
ms.topic: article
5-
ms.service: virtual-machines
6-
ms.subservice: extensions
5+
ms.service: azure-monitor
6+
ms.subservice: agents
77
ms.custom: devx-track-azurecli
8-
author: mgoedtel
9-
ms.author: magoedte
8+
author: guywi-ms
9+
ms.author: guywild
1010
ms.collection: linux
11-
ms.date: 06/01/2021
11+
ms.date: 08/29/2023
1212
---
1313
# Azure Monitor Dependency virtual machine extension for Linux
1414

15-
The Azure Monitor for VMs Map feature gets its data from the Microsoft Dependency agent. The Azure VM Dependency agent virtual machine extension for Linux is published and supported by Microsoft. The extension installs the Dependency agent on Azure virtual machines. This document details the supported platforms, configurations, and deployment options for the Azure VM Dependency agent virtual machine extension for Linux.
15+
The Azure Monitor for VMs Map feature gets its data from the Microsoft Dependency agent. The Azure VM Dependency agent virtual machine extension for Linux installs the Dependency agent on Azure virtual machines. This document details the supported platforms, configurations, and deployment options for the Azure VM Dependency agent virtual machine extension for Linux.
1616

1717
## Prerequisites
1818

@@ -28,30 +28,32 @@ The following JSON shows the schema for the Azure VM Dependency agent extension
2828
{
2929
"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
3030
"contentVersion": "1.0.0.0",
31-
"parameters": {
32-
"vmName": {
33-
"type": "string",
34-
"metadata": {
35-
"description": "The name of existing Linux Azure VM."
31+
"parameters": {
32+
"vmName": {
33+
"type": "string",
34+
"metadata": {
35+
"description": "The name of existing Linux Azure VM."
3636
}
3737
}
3838
},
3939
"variables": {
40-
"vmExtensionsApiVersion": "2017-03-30"
40+
"vmExtensionsApiVersion": "2017-03-30"
4141
},
4242
"resources": [
4343
{
4444
"type": "Microsoft.Compute/virtualMachines/extensions",
4545
"name": "[concat(parameters('vmName'),'/DAExtension')]",
4646
"apiVersion": "[variables('vmExtensionsApiVersion')]",
4747
"location": "[resourceGroup().location]",
48-
"dependsOn": [
49-
],
48+
"dependsOn": [],
5049
"properties": {
51-
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
52-
"type": "DependencyAgentLinux",
53-
"typeHandlerVersion": "9.5",
54-
"autoUpgradeMinorVersion": true
50+
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
51+
"type": "DependencyAgentLinux",
52+
"typeHandlerVersion": "9.5",
53+
"autoUpgradeMinorVersion": true,
54+
"settings": {
55+
"enableAMA": "true"
56+
}
5557
}
5658
}
5759
],
@@ -68,6 +70,10 @@ The following JSON shows the schema for the Azure VM Dependency agent extension
6870
| publisher | Microsoft.Azure.Monitoring.DependencyAgent |
6971
| type | DependencyAgentLinux |
7072
| typeHandlerVersion | 9.5 |
73+
| settings | "enableAMA": "true" |
74+
75+
> [!IMPORTANT]
76+
> Be sure to add `enableAMA` to your template if you're using Azure Monitor Agent; otherwise, Dependency agent attempts to send data to the legacy Log Analytics agent.
7177
7278
## Template deployment
7379

@@ -85,13 +91,16 @@ The following example assumes the Dependency agent extension is nested inside th
8591
"apiVersion": "[variables('apiVersion')]",
8692
"location": "[resourceGroup().location]",
8793
"dependsOn": [
88-
"[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
94+
"[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
8995
],
9096
"properties": {
91-
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
97+
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
9298
"type": "DependencyAgentLinux",
9399
"typeHandlerVersion": "9.5",
94-
"autoUpgradeMinorVersion": true
100+
"autoUpgradeMinorVersion": true,
101+
"settings": {
102+
"enableAMA": "true"
103+
}
95104
}
96105
}
97106
```
@@ -105,13 +114,16 @@ When you place the extension JSON at the root of the template, the resource name
105114
"apiVersion": "[variables('apiVersion')]",
106115
"location": "[resourceGroup().location]",
107116
"dependsOn": [
108-
"[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
117+
"[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
109118
],
110119
"properties": {
111-
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
120+
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
112121
"type": "DependencyAgentLinux",
113122
"typeHandlerVersion": "9.5",
114-
"autoUpgradeMinorVersion": true
123+
"autoUpgradeMinorVersion": true,
124+
"settings": {
125+
"enableAMA": "true"
126+
}
115127
}
116128
}
117129
```
@@ -137,7 +149,7 @@ To enable automatic extension upgrade for an extension, you must ensure the prop
137149

138150
When automatic extension upgrade is enabled on a VM or VM scale set, the extension is upgraded automatically whenever the extension publisher releases a new version for that extension. The upgrade is applied safely following availability-first principles as described [here](../automatic-extension-upgrade.md#how-does-automatic-extension-upgrade-work).
139151

140-
The `enableAutomaticUpgrade` attribute's functionality is different from that of the `autoUpgradeMinorVersion`. The `autoUpgradeMinorVersion` attributes does not automatically trigger a minor version update when the extension publisher releases a new version. The `autoUpgradeMinorVersion` attribute indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
152+
The `enableAutomaticUpgrade` attribute's functionality is different from that of the `autoUpgradeMinorVersion`. The `autoUpgradeMinorVersion` attribute doesn't automatically trigger a minor version update when the extension publisher releases a new version. The `autoUpgradeMinorVersion` attribute indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension won't upgrade minor versions unless redeployed, even with this property set to true.
141153

142154
To keep your extension version updated, we recommend using `enableAutomaticUpgrade` with your extension deployment.
143155

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

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
title: Azure Monitor Dependency virtual machine extension for Windows
33
description: Deploy the Azure Monitor Dependency agent on Windows virtual machine by using a virtual machine extension.
44
ms.topic: article
5-
ms.service: virtual-machines
6-
ms.subservice: extensions
7-
author: mgoedtel
8-
ms.author: magoedte
5+
ms.service: azure-monitor
6+
ms.subservice: agents
7+
author: guywi-ms
8+
ms.author: guywild
99
ms.reviewer: erd
1010
ms.collection: windows
11-
ms.date: 03/27/2023
11+
ms.date: 08/29/2023
1212
---
1313
# Azure Monitor Dependency virtual machine extension for Windows
1414

15-
The Azure Monitor for VMs Map feature gets its data from the Microsoft Dependency agent. The Azure VM Dependency agent virtual machine extension for Windows is published and supported by Microsoft. The extension installs the Dependency agent on Azure virtual machines. This document details the supported platforms, configurations, and deployment options for the Azure VM Dependency agent virtual machine extension for Windows.
15+
The Azure Monitor for VMs Map feature gets its data from the Microsoft Dependency agent. The Azure VM Dependency agent virtual machine extension for Windows installs the Dependency agent on Azure virtual machines. This document details the supported platforms, configurations, and deployment options for the Azure VM Dependency agent virtual machine extension for Windows.
1616

1717
## Operating system
1818

@@ -24,8 +24,8 @@ The following JSON shows the schema for the Azure VM Dependency agent extension
2424

2525
```json
2626
{
27-
"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
28-
"contentVersion": "1.0.0.0",
27+
"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
28+
"contentVersion": "1.0.0.0",
2929
"parameters": {
3030
"vmName": {
3131
"type": "string",
@@ -43,13 +43,15 @@ The following JSON shows the schema for the Azure VM Dependency agent extension
4343
"name": "[concat(parameters('vmName'),'/DAExtension')]",
4444
"apiVersion": "[variables('vmExtensionsApiVersion')]",
4545
"location": "[resourceGroup().location]",
46-
"dependsOn": [
47-
],
46+
"dependsOn": [],
4847
"properties": {
49-
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
50-
"type": "DependencyAgentWindows",
51-
"typeHandlerVersion": "9.10",
52-
"autoUpgradeMinorVersion": true
48+
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
49+
"type": "DependencyAgentWindows",
50+
"typeHandlerVersion": "9.10",
51+
"autoUpgradeMinorVersion": true,
52+
"settings": {
53+
"enableAMA": "true"
54+
}
5355
}
5456
}
5557
],
@@ -66,7 +68,12 @@ The following JSON shows the schema for the Azure VM Dependency agent extension
6668
| publisher | Microsoft.Azure.Monitoring.DependencyAgent |
6769
| type | DependencyAgentWindows |
6870
| typeHandlerVersion | 9.10 |
71+
| autoUpgradeMinorVersion | true |
72+
| settings | "enableAMA": "true" |
6973

74+
75+
> [!IMPORTANT]
76+
> Be sure to add `enableAMA` to your template if you're using Azure Monitor Agent; otherwise, Dependency agent attempts to send data to the legacy Log Analytics agent.
7077
## Template deployment
7178

7279
You can deploy the Azure VM extensions with Azure Resource Manager templates. You can use the JSON schema detailed in the previous section in an Azure Resource Manager template to run the Azure VM Dependency agent extension during an Azure Resource Manager template deployment.
@@ -86,11 +93,14 @@ The following example assumes the Dependency agent extension is nested inside th
8693
"[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
8794
],
8895
"properties": {
89-
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
90-
"type": "DependencyAgentWindows",
91-
"typeHandlerVersion": "9.10",
92-
"autoUpgradeMinorVersion": true
93-
}
96+
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
97+
"type": "DependencyAgentWindows",
98+
"typeHandlerVersion": "9.10",
99+
"autoUpgradeMinorVersion": true,
100+
"settings": {
101+
"enableAMA": "true"
102+
}
103+
}
94104
}
95105
```
96106

@@ -106,10 +116,13 @@ When you place the extension JSON at the root of the template, the resource name
106116
"[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
107117
],
108118
"properties": {
109-
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
110-
"type": "DependencyAgentWindows",
111-
"typeHandlerVersion": "9.10",
112-
"autoUpgradeMinorVersion": true
119+
"publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
120+
"type": "DependencyAgentWindows",
121+
"typeHandlerVersion": "9.10",
122+
"autoUpgradeMinorVersion": true,
123+
"settings": {
124+
"enableAMA": "true"
125+
}
113126
}
114127
}
115128
```
@@ -136,7 +149,7 @@ To enable automatic extension upgrade for an extension, you must ensure the prop
136149

137150
When automatic extension upgrade is enabled on a VM or VM scale set, the extension is upgraded automatically whenever the extension publisher releases a new version for that extension. The upgrade is applied safely following availability-first principles as described [here](../automatic-extension-upgrade.md#how-does-automatic-extension-upgrade-work).
138151

139-
The `enableAutomaticUpgrade` attribute's functionality is different from that of the `autoUpgradeMinorVersion`. The `autoUpgradeMinorVersion` attributes does not automatically trigger a minor version update when the extension publisher releases a new version. The `autoUpgradeMinorVersion` attribute indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
152+
The `enableAutomaticUpgrade` attribute's functionality is different from that of the `autoUpgradeMinorVersion`. The `autoUpgradeMinorVersion` attribute doesn't automatically trigger a minor version update when the extension publisher releases a new version. The `autoUpgradeMinorVersion` attribute indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension won't upgrade minor versions unless redeployed, even with this property set to true.
140153

141154
To keep your extension version updated, we recommend using `enableAutomaticUpgrade` with your extension deployment.
142155

0 commit comments

Comments
 (0)