Merge pull request #282738 from tarTech23/agent

v-dirichards · web-flow · commit b29f1b99c78c · 2024-08-01T10:14:23.000-05:00
Add micro agent note
diff --git a/articles/defender-for-iot/device-builders/concept-agent-based-security-alerts.md b/articles/defender-for-iot/device-builders/concept-agent-based-security-alerts.md
@@ -11,6 +11,8 @@ Defender for IoT continuously analyzes your IoT solution using advanced analytic
 In addition, you can create custom alerts based on your knowledge of expected device behavior.
 An alert acts as an indicator of potential compromise, and should be investigated and remediated.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 In this article, you'll find a list of built-in alerts, which can be triggered on your IoT devices.
 
 ## Security alerts
diff --git a/articles/defender-for-iot/device-builders/concept-agent-portfolio-overview-os-support.md b/articles/defender-for-iot/device-builders/concept-agent-portfolio-overview-os-support.md
@@ -9,6 +9,8 @@ ms.topic: conceptual
 
 Microsoft Defender for IoT provides a large portfolio of agents based on the device type.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Standalone and Edge agent
 
 Most of the Linux Operating Systems (OS) are covered by both agents. The agents can be deployed as a binary package, or as a source code that can be incorporated as part of the firmware. The customer can modify, and customize the agents as needed.  The following are some examples of supported OS:
diff --git a/articles/defender-for-iot/device-builders/concept-event-aggregation.md b/articles/defender-for-iot/device-builders/concept-event-aggregation.md
@@ -9,6 +9,8 @@ ms.topic: conceptual
 
 Defender for IoT security agents collect data and system events from your local device, and send the data to the Azure cloud for processing.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 If you've configured and connected a Log Analytics workspace, you'll see these events in Log Analytics. For more information, see [Tutorial: Investigate security alerts](tutorial-investigate-security-alerts.md).
 
 The Defender for IoT micro agent collects many types of device events including new processes, and all new connection events. Both the new process and new connection events may occur frequently on a device. This capability is important for comprehensive security, however, the number of messages the security agents send may quickly meet, or exceed your IoT Hub quota, and cost limits. These messages and events contain highly valuable security information that is crucial to protecting your device.
diff --git a/articles/defender-for-iot/device-builders/concept-micro-agent-configuration.md b/articles/defender-for-iot/device-builders/concept-micro-agent-configuration.md
@@ -9,6 +9,8 @@ ms.topic: conceptual
 
 This article describes the different types of configurations that the micro agent supports. Customers can configure the micro agent to fit the needs of their devices, and network environments.  
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 The micro agent's behavior is configured by a set of module twin properties. You can configure the micro agent to best suit your needs. For example, you can turn off certain events to minimize power consumption, and reduce other resource usage.
 
 After any change in configuration, the collector will immediately send all unsent event data. After the data is sent, the changes will be applied, and collectors will be restarted as needed.
diff --git a/articles/defender-for-iot/device-builders/concept-micro-agent-linux-dependencies.md b/articles/defender-for-iot/device-builders/concept-micro-agent-linux-dependencies.md
@@ -10,6 +10,8 @@ ms.date: 01/01/2023
 
 This article describes the different Linux OS dependencies for the Defender for IoT micro agent.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Linux dependencies
 
 The table below shows the Linux dependencies for each component.
diff --git a/articles/defender-for-iot/device-builders/concept-standalone-micro-agent-overview.md b/articles/defender-for-iot/device-builders/concept-standalone-micro-agent-overview.md
@@ -9,6 +9,8 @@ ms.topic: conceptual
 
 Security is a near-universal concern for IoT implementers. IoT devices have unique needs for endpoint monitoring, security posture management, and threat detection – all with highly specific performance requirements.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 The Microsoft Defender for IoT security agent allows you to build security directly into your new IoT devices and Azure IoT projects. The micro agent has flexible deployment options, including the ability to deploy as a binary package or modify source code, and it's available for standard IoT operating systems like Linux and Eclipse ThreadX.
 
 The Microsoft Defender for IoT micro agent provides endpoint visibility into security posture management, threat detection, and integration into Microsoft's other security tools for unified security management.
diff --git a/articles/defender-for-iot/device-builders/concept-threadx-security-alerts-recommendations.md b/articles/defender-for-iot/device-builders/concept-threadx-security-alerts-recommendations.md
@@ -15,6 +15,8 @@ In this article, you find a list of built-in alerts and recommendations that are
 
 For more information on how alert customization works in the Defender for IoT service, see [customizable alerts](concept-customizable-security-alerts.md). The specific alerts and recommendations available for customization when using the Defender-IoT-micro-agent for Eclipse ThreadX are detailed in the following tables. 
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Defender-IoT-micro-agent for Eclipse ThreadX supported security alerts
 
 ### Device-related security alerts
diff --git a/articles/defender-for-iot/device-builders/concept-threadx-security-module.md b/articles/defender-for-iot/device-builders/concept-threadx-security-module.md
@@ -9,6 +9,8 @@ ms.date: 04/17/2024
 
 Use this article to get a better understanding of the Defender-IoT-micro-agent for Eclipse ThreadX, including features and benefits as well as links to relevant configuration and reference resources. 
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Eclipse ThreadX IoT Defender-IoT-micro-agent
 
 Defender-IoT-micro-agent for Eclipse ThreadX provides a comprehensive security solution for Eclipse ThreadX devices as part of the NetX Duo offering. Within the NetX Duo offering, Eclipse ThreadX ships with the Azure IoT Defender-IoT-micro-agent built-in, and provides coverage for common threats on your real-time operating system devices once activated.
diff --git a/articles/defender-for-iot/device-builders/configure-pam-to-audit-sign-in-events.md b/articles/defender-for-iot/device-builders/configure-pam-to-audit-sign-in-events.md
@@ -13,6 +13,8 @@ PAM configurations may vary between devices and Linux distributions.
 
 For more information, see [Login collector (event-based collector)](concept-event-aggregation.md#login-collector-event-based-collector).
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Prerequisites
 
 Before you get started, make sure that you have a Defender for IoT Micro Agent.
diff --git a/articles/defender-for-iot/device-builders/edge-security-module-deprecation.md b/articles/defender-for-iot/device-builders/edge-security-module-deprecation.md
@@ -15,6 +15,8 @@ The Defender-IoT-micro-agent has been replaced by our newer micro-agent experien
 
 For more information, see [Tutorial: Create a DefenderIotMicroAgent module twin (Preview)](tutorial-create-micro-agent-module-twin.md) and [Tutorial: Install the Defender for IoT micro agent (Preview)](tutorial-standalone-agent-binary-installation.md).
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ### Timeline
 
 Microsoft Defender for IoT will continue to support the legacy Microsoft Defender for IoT experience under IoT hub until March 31, 2023.
diff --git a/articles/defender-for-iot/device-builders/how-to-configure-dmi-decoder.md b/articles/defender-for-iot/device-builders/how-to-configure-dmi-decoder.md
@@ -9,6 +9,8 @@ ms.topic: how-to
 
 This article explains how to configure the DMI decoder, and alternative configurations for devices that do not support it.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Overview
 
 The Microsoft Defender for IoT **Device inventory** provides an overview of all IoT devices in your environment. The device inventory table can be customized to your preferences by adding or removing information fields, and filtering the fields.
diff --git a/articles/defender-for-iot/device-builders/how-to-configure-micro-agent-twin.md b/articles/defender-for-iot/device-builders/how-to-configure-micro-agent-twin.md
@@ -9,6 +9,8 @@ ms.date: 01/16/2022
 
 Learn how to configure a micro agent twin.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Prerequisites
 
 - An Azure account. If you do not already have an Azure account, you can [create your Azure free account today](https://azure.microsoft.com/free/).
diff --git a/articles/defender-for-iot/device-builders/how-to-install-micro-agent-for-edge.md b/articles/defender-for-iot/device-builders/how-to-install-micro-agent-for-edge.md
@@ -1,6 +1,6 @@
 ---
-title: Install Defender for IoT micro agent for Edge
-description: Learn how to install, and authenticate the Defender Micro agent for Edge.
+title: Install Defender for IoT micro agent for Microsoft Edge
+description: Learn how to install, and authenticate the Defender Micro agent for Microsoft Edge.
 ms.date: 02/08/2022
 ms.topic: how-to
 ---
@@ -9,11 +9,13 @@ ms.topic: how-to
 
 This article explains how to install, and authenticate the Defender micro agent for Edge.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Prerequisites 
 
 1. Navigate to your IoT Hub or, [create a new IoT hub](../../iot-hub/iot-hub-create-through-portal.md#create-an-iot-hub).
 
-1. [Register an Iot Edge device in IoT Hub](../../iot-edge/how-to-register-device.md) and [retrieve connection strings](../../iot-edge/how-to-register-device.md#view-registered-devices-and-retrieve-connection-strings).
+1. [Register an IoT Edge device in IoT Hub](../../iot-edge/how-to-register-device.md) and [retrieve connection strings](../../iot-edge/how-to-register-device.md#view-registered-devices-and-retrieve-connection-strings).
     
 1. Add the appropriate Microsoft package repository. 
 
@@ -71,15 +73,15 @@ This article explains how to install, and authenticate the Defender micro agent
     
         :::image type="content" source="media/quickstart-standalone-agent-binary-installation/active-running.png" alt-text="Check to make sure your service is stable and active.":::
  
-1. Test the system end-to-end by creating a trigger file on the device. The trigger file will cause a baseline scan in the agent, that will detect the file as a baseline violation. 
+1. Test the system end-to-end by creating a trigger file on the device. The trigger file causes a baseline scan in the agent that detects the file as a baseline violation. 
     
     Create a file on the file system with the following command:
     
     ```bash
     sudo touch /tmp/DefenderForIoTOSBaselineTrigger.txt 
     ```
 
-    A baseline validation failure recommendation will occur in the hub, with a `CceId` of `CIS-debian-9-DEFENDER_FOR_IOT_TEST_CHECKS-0.0`: 
+    A baseline validation failure recommendation occurs in the hub, with a `CceId` of `CIS-debian-9-DEFENDER_FOR_IOT_TEST_CHECKS-0.0`: 
     
     :::image type="content" source="media/quickstart-standalone-agent-binary-installation/validation-failure.png" alt-text="The baseline validation failure recommendation that occurs in the hub." lightbox="media/quickstart-standalone-agent-binary-installation/validation-failure-expanded.png":::
 
diff --git a/articles/defender-for-iot/device-builders/how-to-manage-device-inventory-on-the-cloud.md b/articles/defender-for-iot/device-builders/how-to-manage-device-inventory-on-the-cloud.md
@@ -21,6 +21,8 @@ Some of the benefits of the device inventory include:
 
 - Export the entire device inventory to a CSV file for your reports.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Device inventory overview
 
 The Device inventory gives you an overview of all devices within your environment. Here you can see the individual details of each device and filter, and order your search by various options.
diff --git a/articles/defender-for-iot/device-builders/how-to-provision-micro-agent.md b/articles/defender-for-iot/device-builders/how-to-provision-micro-agent.md
@@ -11,6 +11,8 @@ This article explains how to provision the standalone Microsoft Defender for IoT
 
 To learn how to configure the Microsoft Defender for IoT micro agent for Edge devices see [Create and provision IoT Edge devices at scale](../../iot-edge/how-to-provision-devices-at-scale-linux-tpm.md)
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Prerequisites
 
 - An Azure account with an active subscription. For more information, see [Create an Azure account](https://azure.microsoft.com/free).
diff --git a/articles/defender-for-iot/device-builders/how-to-threadx-security-module.md b/articles/defender-for-iot/device-builders/how-to-threadx-security-module.md
@@ -9,6 +9,8 @@ ms.date: 04/17/2024
 
 This article describes how to configure the Defender-IoT-micro-agent for your Eclipse ThreadX device, to meet your network, bandwidth, and memory requirements.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Configuration steps
 
 You must select a target distribution file that has a `*.dist` extension, from the `netxduo/addons/azure_iot/azure_iot_security_module/configs` directory.  
diff --git a/articles/defender-for-iot/device-builders/overview.md b/articles/defender-for-iot/device-builders/overview.md
@@ -22,6 +22,8 @@ Microsoft Defender for IoT provides lightweight security agents so that you can
 
 ## Defender for IoT micro agent
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 The Defender for IoT micro agent provides deep security protection, and visibility into device behavior.
 
 - The micro agent collects, aggregates, and analyzes raw security events from your devices. Events can include IP connections, process creation, user logons, and other security-relevant information.
diff --git a/articles/defender-for-iot/device-builders/references-defender-for-iot-glossary.md b/articles/defender-for-iot/device-builders/references-defender-for-iot-glossary.md
@@ -31,3 +31,4 @@ This glossary provides a brief description of important terms and concepts for t
 | **Micro Agent** | Provides depth security capabilities for IoT devices including security posture and threat detection. | |
 | **Module twin** | Module twins are JSON documents that store module state information including metadata, configurations, and conditions. | [Device twins](#d) <br /> <br />[Defender-IoT-micro-agent twin](#d) |
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
diff --git a/articles/defender-for-iot/device-builders/release-notes.md b/articles/defender-for-iot/device-builders/release-notes.md
@@ -15,6 +15,10 @@ Noted features are in PREVIEW. The [Azure Preview Supplemental Terms](https://az
 
 For more information, see [Upgrade the Microsoft Defender for IoT micro agent](upgrade-micro-agent.md).
 
+## August 2024
+
+Defender for IoT plans to retire the micro agent on August 1, 2025.
+
 ## March 2024
 
 **Updates to Defender for IoT Firmware Analysis:**
diff --git a/articles/defender-for-iot/device-builders/threadx-security-module-api.md b/articles/defender-for-iot/device-builders/threadx-security-module-api.md
@@ -12,6 +12,8 @@ Defender for IoT APIs are governed by [Microsoft API License and Terms of use](/
 
 This API is intended for use with the Defender-IoT-micro-agent for Eclipse ThreadX only. For additional resources, see the [Defender-IoT-micro-agent for Eclipse ThreadX GitHub resource](https://github.com/eclipse-threadx).
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Enable Defender-IoT-micro-agent for Eclipse ThreadX
 
 **nx_azure_iot_security_module_enable**
diff --git a/articles/defender-for-iot/device-builders/troubleshoot-defender-micro-agent.md b/articles/defender-for-iot/device-builders/troubleshoot-defender-micro-agent.md
@@ -9,6 +9,8 @@ ms.topic: reference
 
 If an unexpected error occurs, you can use these troubleshooting methods in an attempt to resolve the issue. 
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Service status 
 
 To view the status of the service: 
diff --git a/articles/defender-for-iot/device-builders/tutorial-configure-agent-based-solution.md b/articles/defender-for-iot/device-builders/tutorial-configure-agent-based-solution.md
@@ -16,6 +16,8 @@ In this tutorial you'll learn how to:
 > - Create a Log Analytics workspace
 > - Enable geolocation and IP address handling
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Prerequisites
 
 - An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
diff --git a/articles/defender-for-iot/device-builders/tutorial-create-micro-agent-module-twin.md b/articles/defender-for-iot/device-builders/tutorial-create-micro-agent-module-twin.md
@@ -10,6 +10,8 @@ ms.custom: mode-other
 
 This tutorial will help you learn how to create an individual `DefenderIotMicroAgent` module twin for new devices.
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Device twins
 
 Device twins play a key role in both device management and process automation, for IoT solutions that are built in to Azure.
diff --git a/articles/defender-for-iot/device-builders/tutorial-investigate-security-alerts.md b/articles/defender-for-iot/device-builders/tutorial-investigate-security-alerts.md
@@ -16,6 +16,8 @@ In this tutorial you'll learn how to:
 > - Investigate security alert details
 > - Investigate alerts in Log Analytics workspace
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Prerequisites
 
 - An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
diff --git a/articles/defender-for-iot/device-builders/tutorial-investigate-security-recommendations.md b/articles/defender-for-iot/device-builders/tutorial-investigate-security-recommendations.md
@@ -18,6 +18,8 @@ In this tutorial you'll learn how to:
 > - Investigate security recommendation details
 > - Investigate recommendations in a Log Analytics workspace
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Prerequisites
 
 - An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
diff --git a/articles/defender-for-iot/device-builders/upgrade-micro-agent.md b/articles/defender-for-iot/device-builders/upgrade-micro-agent.md
@@ -11,6 +11,8 @@ This article describes how to upgrade a Microsoft Defender for IoT micro agent w
 
 For more information, see our [release notes for device builders](release-notes.md).
 
+[!INCLUDE [device-agents-note](../includes/device-agents-note.md)]
+
 ## Upgrade a micro agent from version 4.2.* to 4.6.2
 
 When upgrading the micro agent from version 4.2.* to 4.6.2, you would first need to remove the package and then reinstall it.
diff --git a/articles/defender-for-iot/includes/device-agents-note.md b/articles/defender-for-iot/includes/device-agents-note.md
@@ -0,0 +1,14 @@
+---
+title: include file
+description: include file
+author: limwainstein
+ms.service: defender-for-iot
+ms.topic: include
+ms.date: 07/31/2024
+ms.author: lwainstein
+ms.custom: include file
+---
+
+> [!NOTE]
+> Defender for IoT plans to retire the micro agent on August 1, 2025. 
+>
