Skip to content

Commit 3ca7118

Browse files
authored
Merge pull request #202897 from batamig/remote-config
Remote config
2 parents b8a87b9 + e58f994 commit 3ca7118

File tree

13 files changed

+172
-3
lines changed

13 files changed

+172
-3
lines changed

articles/defender-for-iot/organizations/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,8 @@
237237
displayName: Enterprise IoT sensor
238238
- name: Manage sensors from the Azure portal
239239
href: how-to-manage-sensors-on-the-cloud.md
240+
- name: Configure OT sensor settings from the Azure portal
241+
href: configure-sensor-settings-portal.md
240242
- name: Create and manage users
241243
items:
242244
- name: Azure portal
Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
title: Configure OT sensor settings from the Azure portal - Microsoft Defender for IoT
3+
description: Learn how to configure settings for OT network sensors from Microsoft Defender for IoT on the Azure portal.
4+
ms.date: 12/27/2022
5+
ms.topic: how-to
6+
---
7+
8+
# Configure OT sensor settings from the Azure portal (Public preview)
9+
10+
After [onboarding](onboard-sensors.md) a new OT network sensor to Microsoft Defender for IoT, you may want to define several settings directly on the OT sensor console, such as [adding local users](manage-users-sensor.md) or [connecting to an on-premises management console](how-to-manage-individual-sensors.md#connect-a-sensor-to-the-management-console).
11+
12+
Selected OT sensor settings, listed below, are also available directly from the Azure portal, and can be applied in bulk across multiple cloud-connected OT sensors at a time, or across all OT sensors in a specific site or zone. This article describes how to view and configure view OT network sensor settings from the Azure portal.
13+
14+
> [!NOTE]
15+
> The **Sensor settings** page in Defender for IoT is in PREVIEW. The [Azure Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) include other legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
16+
>
17+
18+
## Prerequisites
19+
20+
To define OT sensor settings, make sure that you have the following:
21+
22+
- **An Azure subscription onboarded to Defender for IoT**. If you need to, [sign up for a free account](https://azure.microsoft.com/free/) and then use the [Quickstart: Get started with Defender for IoT](getting-started.md) to onboard.
23+
24+
- **Permissions**:
25+
26+
- To view settings that others have defined, sign in with a [Security Reader](../../role-based-access-control/built-in-roles.md#security-reader), [Security admin](/azure/role-based-access-control/built-in-roles#security-admin), [Contributor](/azure/role-based-access-control/built-in-roles#contributor), or [Owner](/azure/role-based-access-control/built-in-roles#owner) role for the subscription.
27+
28+
- To define or update settings, sign in with [Security admin](/azure/role-based-access-control/built-in-roles#security-admin), [Contributor](/azure/role-based-access-control/built-in-roles#contributor), or [Owner](/azure/role-based-access-control/built-in-roles#owner) role.
29+
30+
For more information, see [Azure user roles and permissions for Defender for IoT](roles-azure.md).
31+
32+
- **One or more cloud-connected OT network sensors**. For more information, see [Onboard OT sensors to Defender for IoT](onboard-sensors.md).
33+
34+
## Define a new sensor setting
35+
36+
Define a new setting whenever you want to define a specific configuration for one or more OT network sensors. For example, you might want to define bandwidth caps for all OT sensors in a specific site or zone, or for a single OT sensor at a specific location in your network.
37+
38+
**To define a new setting**:
39+
40+
1. In Defender for IoT on the Azure portal, select **Sites and sensors** > **Sensor settings (Preview)**.
41+
42+
1. On the **Sensor settings (Preview)** page, select **+ Add**, and then use the wizard to define the following values for your setting. Select **Next** when you're done with each tab in the wizard to move to the next step.
43+
44+
|Tab name |Description |
45+
|---------|---------|
46+
|**Basics** | Select the subscription where you want to apply your setting, and your [setting type](#sensor-setting-reference). <br><br>Enter a meaningful name and an optional description for your setting. |
47+
|**Setting** | Define the values for your selected setting type.<br>For details about the options available for each setting type, find your selected setting type in the [Sensor setting reference](#sensor-setting-reference) below. |
48+
|**Apply** | Use the **Select sites**, **Select zones**, and **Select sensors** dropdown menus to define where you want to apply your setting. <br><br>**Important**: Selecting a site or zone applies the setting to all connected OT sensors, including any OT sensors added to the site or zone later on. <br>If you select to apply your settings to an entire site, you don't also need to select its zones or sensors. |
49+
|**Review and create** | Check the selections you've made for your setting. <br><br>If your new setting replaces an existing setting, a :::image type="icon" source="media/how-to-manage-individual-sensors/warning-icon.png" border="false"::: warning is shown to indicate the existing setting.<br><br>When you're satisfied with the setting's configuration, select **Create**. |
50+
51+
Your new setting is now listed on the **Sensor settings (Preview)** page under its setting type, and on the sensor details page for any related OT sensor. Sensor settings are shown as read-only on the sensor details page. For example:
52+
53+
:::image type="content" source="media/configure-sensor-settings-portal/sensor-details-setting.png" alt-text="Screenshot of a sensor details page showing a setting applied.":::
54+
55+
> [!TIP]
56+
> You may want to configure exceptions to your settings for a specific OT sensor or zone. In such cases, create an extra setting for the exception.
57+
>
58+
> Settings override eachother in a hierarchical manner, so that if your setting is applied to a specific OT sensor, it overrides any related settings that are applied to the entire zone or site. To create an exception for an entire zone, add a setting for that zone to override any related settings applied to the entire site.
59+
>
60+
61+
## View and edit current OT sensor settings
62+
63+
**To view the current settings already defined for your subscription**:
64+
65+
1. In Defender for IoT on the Azure portal, select **Sites and sensors** > **Sensor settings (Preview)**
66+
67+
The **Sensor settings (Preview)** page shows any settings already defined for your subscriptions, listed by setting type. Expand or collapse each type to view detailed configurations. For example:
68+
69+
:::image type="content" source="media/configure-sensor-settings-portal/view-settings.png" alt-text="Screenshot of OT sensor settings on the Azure portal.":::
70+
71+
1. Select a specific setting to view its exact configuration and the site, zones, or individual sensors where the setting is applied.
72+
73+
1. To edit the setting's configuration, select **Edit** and then use the same wizard you used to create the setting to make the updates you need. When you're done, select **Apply** to save your changes.
74+
75+
### Delete an existing OT sensor setting
76+
77+
To delete an OT sensor setting altogether:
78+
79+
1. On the **Sensor settings (Preview)** page, locate the setting you want to delete.
80+
1. Select the **...** options menu at the top-right corner of the setting's card and then select **Delete**.
81+
82+
For example:
83+
84+
:::image type="content" source="media/configure-sensor-settings-portal/delete-setting.png" alt-text="Screenshot of the Delete setting option.":::
85+
86+
## Edit settings for disconnected OT sensors
87+
88+
This procedure describes how to edit OT sensor settings if your OT sensor is currently disconnected from Azure, such as during an ongoing security incident.
89+
90+
By default, if you've configured any settings from the Azure portal, all settings that are configurable from both the Azure portal and the OT sensor are set to read-only on the OT sensor itself. For example, if you've configured a VLAN from the Azure portal, then bandwidth cap, subnet, and VLAN settings are *all* set to read-only, and blocked from modifications on the OT sensor.
91+
92+
If you're in a situation where the OT sensor is disconnected from Azure, and you need to modify one of these settings, you'll first need to gain write access to those settings.
93+
94+
**To gain write access to blocked OT sensor settings**:
95+
96+
1. On the Azure portal, in the **Sensor settings (Preview)** page, locate the setting you want to edit and open it for editing. For more information, see [View and edit current OT sensor settings](#view-and-edit-current-ot-sensor-settings) above.
97+
98+
Edit the scope of the setting so that it no longer includes the OT sensor, and any changes you make while the OT sensor is disconnected aren't overwritten when you connect it back to Azure.
99+
100+
> [!IMPORTANT]
101+
> Settings defined on the Azure portal always override settings defined on the OT sensor.
102+
103+
1. Sign into the affected OT sensor console, and select **Settings > Advanced configurations** > **Azure Remote Config**.
104+
105+
1. In the code box, modify the `block_local_config` value from `1` to `0`, and select **Close**. For example:
106+
107+
:::image type="content" source="media/how-to-manage-individual-sensors/remote-config-sensor.png" alt-text="Screenshot of the Azure Remote Config option." lightbox="media/how-to-manage-individual-sensors/remote-config-sensor.png":::
108+
109+
Continue by updating the relevant setting directly on the OT network sensor. For more information, see [Manage individual sensors](how-to-manage-individual-sensors.md).
110+
111+
## Sensor setting reference
112+
113+
Use the following sections to learn more about the individual OT sensor settings available from the Azure portal:
114+
115+
### Bandwidth cap
116+
117+
For a bandwidth cap, define the maximum bandwidth you want the sensor to use for outgoing communication from the sensor to the cloud, either in Kbps or Mbps.
118+
119+
**Default**: 1500 Kbps
120+
121+
**Minimum required for a stable connection to Azure** 350 Kbps. At this minimum setting, connections to the sensor console may be slower than usual.
122+
123+
### Subnet
124+
125+
To define your sensor's subnets do any of the following:
126+
127+
- Select **Import subnets** to import a comma-separated list of subnet IP addresses and masks. Select **Export subnets** to export a list of currently configured data, or **Clear all** to start from scratch.
128+
129+
- Enter values in the **IP Address**, **Mask**,l and **Name** fields to add subnet details manually. Select **Add subnet** to add additional subnets as needed.
130+
131+
### VLAN naming
132+
133+
To define a VLAN for your OT sensor, enter the VLAN ID and a meaningful name.
134+
135+
Select **Add VLAN** to add more VLANs as needed.
136+
137+
## Next steps
138+
139+
> [!div class="nextstepaction"]
140+
> [Manage sensors from the Azure portal](how-to-manage-sensors-on-the-cloud.md)
141+
142+
> [!div class="nextstepaction"]
143+
> [Manage OT sensors from the sensor console](how-to-manage-individual-sensors.md)

articles/defender-for-iot/organizations/how-to-manage-sensors-on-the-cloud.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,10 @@ Use the options on the **Sites and sensor** page and a sensor details page to do
7575
| :::image type="icon" source="media/how-to-manage-sensors-on-the-cloud/icon-diagnostics.png" border="false"::: **Send diagnostic files to support** | Individual, locally managed OT sensors only. <br><br>Available from the **...** options menu. <br><br>For more information, see [Upload a diagnostics log for support](#upload-a-diagnostics-log-for-support).|
7676
| **Download SNMP MIB file** | Available from the **Sites and sensors** toolbar **More actions** menu. <br><br>For more information, see [Set up SNMP MIB monitoring](how-to-set-up-snmp-mib-monitoring.md).|
7777
| **Recover an on-premises management console password** | Available from the **Sites and sensors** toolbar **More actions** menu. <br><br>For more information, see [Manage the on-premises management console](how-to-manage-the-on-premises-management-console.md). |
78+
| **Define OT network sensor settings** (Preview) | Define selected sensor settings for one or more cloud-connected OT network sensors. For more information, see [Define and view OT sensor settings from the Azure portal (Public preview)](configure-sensor-settings-portal.md). <br><br>Other settings are also available directly from the [OT sensor console](how-to-manage-individual-sensors.md), or the [on-premises management console](how-to-manage-sensors-from-the-on-premises-management-console.md).|
7879
|<a name="endpoint"></a> **Download endpoint details** (Public preview) | Available from the **Sites and sensors** toolbar **More actions** menu, for OT sensor versions 22.x only. <br><br>Download the list of endpoints that must be enabled as secure endpoints from OT network sensors. Make sure that HTTPS traffic is enabled over port 443 to the listed endpoints for your sensor to connect to Azure. Outbound allow rules are defined once for all OT sensors onboarded to the same subscription.<br><br>To enable this option, select a sensor with a supported software version, or a site with one or more sensors with supported versions. |
7980

81+
8082
## Retrieve forensics data stored on the sensor
8183

8284
Use Azure Monitor workbooks on an OT network sensor to retrieve forensic data from that sensor’s storage. The following types of forensic data is stored locally on OT sensors, for devices detected by that sensor:
@@ -176,4 +178,11 @@ If you need to open a support ticket for a locally managed sensor, upload a diag
176178

177179
## Next steps
178180

179-
[View and manage alerts on the Defender for IoT portal (Preview)](how-to-manage-cloud-alerts.md)
181+
> [!div class="nextstepaction"]
182+
> [Manage OT sensors from the sensor console](how-to-manage-individual-sensors.md)
183+
184+
> [!div class="nextstepaction"]
185+
> [Define and view OT sensor settings from the Azure portal (Public preview)](configure-sensor-settings-portal.md)
186+
187+
> [!div class="nextstepaction"]
188+
> [View and manage alerts on the Defender for IoT portal (Preview)](how-to-manage-cloud-alerts.md)
253 KB
Loading
106 KB
Loading
246 KB
Loading
302 KB
Loading
822 Bytes
Loading
868 Bytes
Loading
398 KB
Loading

0 commit comments

Comments
 (0)