Skip to content

Commit c3f80b7

Browse files
committed
Pare down how-to doc
1 parent 3fb2868 commit c3f80b7

File tree

2 files changed

+62
-71
lines changed

2 files changed

+62
-71
lines changed

articles/sentinel/create-analytics-rules.md

Lines changed: 62 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -48,49 +48,37 @@ For more help building Kusto queries, see [Kusto Query Language in Microsoft Sen
4848

4949
This section describes how to create a rule using the Azure or Defender portals.
5050

51-
### Start the Analytics rule wizard
51+
### Get started creating a scheduled query rule
5252

53-
# [Azure portal](#tab/azure-portal)
54-
55-
1. From the **Configuration** section of the Microsoft Sentinel navigation menu, select **Analytics**.
53+
To get started, go to the **Analytics** page in Microsoft Sentinel to create a scheduled analytics rule.
5654

57-
1. In the action bar at the top, select **+Create** and select **Scheduled query rule**. This opens the **Analytics rule wizard**.
55+
1. For Microsoft Sentinel in the [Azure portal](https://portal.azure.com), under **Configuration**, select **Analytics**.<br>For Microsoft Sentinel in the [Defender portal](https://security.microsoft.com), select **Microsoft Sentinel** > **Configuration** > **Analytics**.
5856

59-
:::image type="content" source="media/create-analytics-rules/create-scheduled-query.png" alt-text="Screenshot of Analytics screen in Azure portal." lightbox="media/create-analytics-rules/create-scheduled-query.png":::
57+
1. Select **+Create** and select **Scheduled query rule**.
6058

61-
# [Defender portal](#tab/defender-portal)
59+
# [Azure portal](#tab/azure-portal)
6260

63-
1. From the Microsoft Defender navigation menu, expand **Microsoft Sentinel**, then **Configuration**. Select **Analytics**.
61+
:::image type="content" source="media/create-analytics-rules/create-scheduled-query.png" alt-text="Screenshot of Analytics screen in Azure portal." lightbox="media/create-analytics-rules/create-scheduled-query.png":::
6462

65-
1. In the action bar at the top of the grid, select **+Create** and select **Scheduled query rule**. This opens the **Analytics rule wizard**.
63+
# [Defender portal](#tab/defender-portal)
6664

6765
:::image type="content" source="media/create-analytics-rules/defender-create-scheduled-query.png" alt-text="Screenshot of Analytics screen in Defender portal." lightbox="media/create-analytics-rules/defender-create-scheduled-query.png":::
6866

69-
---
67+
---
7068

7169
### Name the rule and define general information
7270

73-
In the Azure portal, stages are represented visually as tabs. In the Defender portal, they're represented visually as milestones on a timeline. See the screenshots below for examples.
74-
75-
1. Provide a unique **Name** and a **Description**.
76-
77-
1. Set the alert **Severity** as appropriate, matching the impact the activity triggering the rule might have on the target environment, should the rule be a true positive.
71+
In the Azure portal, stages are represented visually as tabs. In the Defender portal, they're represented visually as milestones on a timeline.
7872

79-
| Severity | Description |
80-
| --- | --- |
81-
| **Informational** | No impact on your system, but the information might be indicative of future steps planned by a threat actor. |
82-
| **Low** | The immediate impact would be minimal. A threat actor would likely need to conduct multiple steps before achieving an impact on an environment. |
83-
| **Medium** | The threat actor could have some impact on the environment with this activity, but it would be limited in scope or require additional activity. |
84-
| **High** | The activity identified provides the threat actor with wide ranging access to conduct actions on the environment or is triggered by impact on the environment. |
73+
1. Enter the following information for your rule.
8574

86-
1. Choose from among the **MITRE ATT&CK** tactics and techniques those threat activities which apply to your rule.
87-
88-
For more information on maximizing your coverage of the MITRE ATT&CK threat landscape, see [Understand security coverage by the MITRE ATT&CK® framework](mitre-coverage.md)
89-
90-
1. Leave the **Status** set to **Enabled** if you want it to run immediately after you finish creating it. If you don’t, select **Disabled**, and the rule will be added to your **Active rules** tab and you can enable it from there when you need it.
91-
92-
> [!NOTE]
93-
> There's another way, currently in preview, to create a rule without it running immediately. You can schedule the rule to first run at a specific date and time. See [Schedule and scope the query](#schedule-and-scope-the-query) below.
75+
| Field | Description |
76+
| ----- | ----------- |
77+
| **Name** | A unique name for your rule. |
78+
| **Description** | A free-text description for your rule. |
79+
| **Severity** | Match the impact the activity triggering the rule might have on the target environment, should the rule be a true positive.<br><br>**Informational**: No impact on your system, but the information might be indicative of future steps planned by a threat actor.<br>**Low**: The immediate impact would be minimal. A threat actor would likely need to conduct multiple steps before achieving an impact on an environment.<br>**Medium**: The threat actor could have some impact on the environment with this activity, but it would be limited in scope or require additional activity.<br> **High**: The activity identified provides the threat actor with wide ranging access to conduct actions on the environment or is triggered by impact on the environment. |
80+
| **MITRE ATT&CK** | Choose those threat activities which apply to your rule. Select from among the **MITRE ATT&CK** tactics and techniques presented in the drop-down list. You can make multiple selections.<br><br>For more information on maximizing your coverage of the MITRE ATT&CK threat landscape, see [Understand security coverage by the MITRE ATT&CK® framework](mitre-coverage.md). |
81+
| **Status** | If you want the rule to run immediately after you finish creating it, leave the status set to **Enabled**. Otherwise, select **Disabled**, and enable it later from your **Active rules** tab when you need it. Or enable the rule without it running immediately by scheduling the rule's first run at a specific date and time. See [Schedule and scope the query](#schedule-and-scope-the-query).
9482

9583
1. Select **Next: Set rule logic**.
9684

@@ -106,54 +94,37 @@ In the Azure portal, stages are represented visually as tabs. In the Defender po
10694

10795
### Define the rule logic
10896

109-
1. **Enter a query for your rule.**
110-
111-
Paste the query you designed, built, and tested into the **Rule query** window. Every change you make in this window is instantly validated, so if there are any mistakes, you’ll see an indication right below the window.
112-
113-
1. **Map entities.**
114-
115-
Define up to 10 entity types recognized by Microsoft Sentinel onto fields in your query results. This mapping integrates the identified entities into the [*Entities* field in your alert schema](security-alert-schema.md).
116-
117-
For complete instructions on mapping entities, see [Map data fields to entities in Microsoft Sentinel](map-data-fields-to-entities.md).
118-
119-
1. **Surface custom details in your alerts.**
120-
121-
Define any fields in your query results you wish to be surfaced in your alerts as custom details. These fields appear in any incidents that result as well.
97+
The next step is to set the rule logic which includes adding the Kusto query that you created.
12298

123-
For complete instructions on surfacing custom details, see [Surface custom event details in alerts in Microsoft Sentinel](surface-custom-details-in-alerts.md).
99+
1. **Enter the rule query and alert enhancement configuration.**
124100

125-
1. **Customize alert details.**
101+
| Setting | Description |
102+
| ----- | ----------- |
103+
| **Rule query** | Paste the query you designed, built, and tested into the **Rule query** window. Every change you make in this window is instantly validated, so if there are any mistakes, you’ll see an indication right below the window. |
104+
| **Map entities** | Expand **Entity mapping** and define up to 10 entity types recognized by Microsoft Sentinel onto fields in your query results. This mapping integrates the identified entities into the [*Entities* field in your alert schema](security-alert-schema.md).<br><br>For complete instructions on mapping entities, see [Map data fields to entities in Microsoft Sentinel](map-data-fields-to-entities.md). |
105+
| **Surface custom details in your alerts** | Expand **Custom details** and define any fields in your query results you wish to be surfaced in your alerts as custom details. These fields appear in any incidents that result as well.<br><br> For complete instructions on surfacing custom details, see [Surface custom event details in alerts in Microsoft Sentinel](surface-custom-details-in-alerts.md). |
106+
| **Customize alert details** | Expand **Alert details** and customize otherwise-standard alert properties according to the content of various fields in each individual alert. For example, customize the alert name or description to include a username or IP address featured in the alert.<br><br>For complete instructions on customizing alert details, see [Customize alert details in Microsoft Sentinel](customize-alert-details.md). |
107+
|
126108

127-
Customize otherwise-standard alert properties according to the content of various fields in each individual alert. For example, customize the alert name or description to include a username or IP address featured in the alert.
109+
1. <a name="schedule-and-scope-the-query"></a>**Schedule and scope the query.** Set the following parameters in the **Query scheduling** section:
128110

129-
For complete instructions on customizing alert details, see [Customize alert details in Microsoft Sentinel](customize-alert-details.md).
111+
| Setting | Description / Options |
112+
| ------- | --------------------- |
113+
| **Run&nbsp;query&nbsp;every** | Controls the **query interval**: how often the query is run.<br>Allowed range: **5 minutes** to **14 days**. |
114+
| **Lookup data from the last** | Determines the **lookback period**: the time period covered by the query.<br>Allowed range: **5 minutes** to **14 days**.<br>Must be longer than or equal to the query interval. |
115+
| **Start running** | **Automatically**: The rule will run for the first time immediately upon being created, and after that at the query interval.<br>**At specific time** (Preview): Set a date and time for the rule to first run, after which it will run at the query interval.<br>Allowed range: **10 minutes** to **30 days** after the rule creation (or enablement) time. |
130116

131117

132-
1. <a name="schedule-and-scope-the-query"></a>**Schedule and scope the query.**
133-
1. Set the following parameters in the **Query scheduling** section:
134-
135-
| Setting | Behavior |
136-
| --- | --- |
137-
| **Run query every** | Controls the **query interval**: how often the query is run. |
138-
| **Lookup data from the last** | Determines the **lookback period**: the time period covered by the query. |
139-
140-
- The allowed range for both of these parameters is from **5 minutes** to **14 days**.
141-
142-
- The query interval must be shorter than or equal to the lookback period.
143-
144-
1. Set **Start running**:
145-
146-
| Setting | Behavior |
147-
| --- | --- |
148-
| **Automatically** | The rule will run for the first time immediately upon being created, and after that at the interval set in the **Run query every** setting. |
149-
| **At specific time** (Preview) | Set a date and time for the rule to first run, after which it will run at the interval set in the **Run query every** setting. |
118+
1. <a name="alert-threshold"></a>**Set the threshold for creating alerts.**
150119

151-
- The **start running** time must be between 10 minutes and 30 days after the rule creation (or enablement) time.
120+
Use the **Alert threshold** section to define the sensitivity level of the rule. For example, set a minimum threshold of 100:
152121

153-
1. <a name="alert-threshold"></a>**Set the threshold for creating alerts.**
122+
| Setting | Description |
123+
| ------- | ----------- |
124+
| **Generate alert when number of query results** | Is greater than |
125+
| Number of events | `100` |
154126

155-
Use the **Alert threshold** section to define the sensitivity level of the rule.
156-
- To set a minimum threshold, set **Generate alert when number of query results** to **Is greater than**, and enter the minimum number of events that need to be found over the time period of the query for the rule to generate an alert. If you don’t want to set a threshold, enter `0` in the number field.
127+
If you don’t want to set a threshold, enter `0` in the number field.
157128

158129
1. **Set event grouping settings.**
159130

@@ -174,6 +145,20 @@ In the Azure portal, stages are represented visually as tabs. In the Defender po
174145

175146
1. Select **Next: Incident settings**.
176147

148+
# [Azure portal](#tab/azure-portal)
149+
150+
:::image type="content" source="media/create-analytics-rules/set-rule-logic-1.png" alt-text="Screenshot of first half of set rule logic tab in the analytics rule wizard in the Azure portal.":::
151+
152+
:::image type="content" source="media/create-analytics-rules/set-rule-logic-2.png" alt-text="Screenshot of second half of set rule logic tab in the analytics rule wizard in the Azure portal.":::
153+
154+
# [Defender portal](#tab/defender-portal)
155+
156+
:::image type="content" source="media/create-analytics-rules/defender-set-rule-logic-1.png" alt-text="Screenshot of first half of set rule logic tab in the analytics rule wizard in the Defender portal.":::
157+
158+
:::image type="content" source="media/create-analytics-rules/defender-set-rule-logic-2.png" alt-text="Screenshot of second half of set rule logic tab in the analytics rule wizard in the Defender portal.":::
159+
160+
---
161+
177162
### Configure the incident creation settings
178163

179164
In the **Incident settings** tab, choose whether Microsoft Sentinel turns alerts into actionable incidents, and whether and how alerts are grouped together in incidents.
@@ -223,14 +208,20 @@ In the **Incident settings** tab, choose whether Microsoft Sentinel turns alerts
223208

224209
---
225210

226-
### Set automated responses and create the rule
211+
### Review or add automated responses
212+
213+
In the **Automated responses** tab, see the [automation rules](automate-incident-handling-with-automation-rules.md) displayed in the list. If you want to add any responses that aren't already covered by existing rules, you have two choices:
214+
215+
- Edit an existing rule if you want the added response to apply to many or all rules.
216+
- Select **Add new** to [create a new automation rule](create-manage-use-automation-rules.md) that will apply only to this analytics rule.
217+
227218

228-
In the **Automated responses** tab, you can use [automation rules](automate-incident-handling-with-automation-rules.md) to set automated responses to occur at any of three types of occasions:
219+
to set automated responses to occur at any of three types of occasions:
229220
- When an alert is generated by this analytics rule.
230221
- When an incident is created from alerts generated by this analytics rule.
231222
- When an incident is updated with alerts generated by this analytics rule.
232223

233-
The grid displayed under **Automation rules** shows the automation rules that already apply to this analytics rule (by virtue of it meeting the conditions defined in those rules). You can edit any of these by selecting the name of the rule or the ellipsis at the end of each row. Or, you can select **Add new** to [create a new automation rule](create-manage-use-automation-rules.md).
224+
The grid displayed under **Automation rules** shows the automation rules that already apply to this analytics rule (by virtue of it meeting the conditions defined in those rules). You can edit any of these by selecting the name of the rule or the ellipsis at the end of each row. Or, you can
234225

235226
Use automation rules to perform [basic triage](investigate-incidents.md#navigate-and-triage-incidents), assignment, [workflow](incident-tasks.md), and closing of incidents.
236227

2.4 KB
Loading

0 commit comments

Comments
 (0)