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/sentinel/watchlists.md
+31-27Lines changed: 31 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,43 +31,48 @@ Use watchlists in these scenarios:
31
31
32
32
-**Investigate threats** and respond to incidents quickly by importing IP addresses, file hashes, and other data from CSV files. After you import the data, use watchlist name-value pairs for joins and filters in alert rules, threat hunting, workbooks, notebooks, and queries.
33
33
34
-
-**Import business data** as a watchlist. For example, import user lists with privileged system access, or terminated employees. Then, use the watchlist to create allowlists and blocklists to detect or prevent those users from logging in to the network.
34
+
-**Import business data** as a watchlist. For example, import user lists with privileged system access or lists of terminated employees. Then, use the watchlist to create allowlists and blocklists to detect or prevent those users from signing in to the network.
35
35
36
-
-**Reduce alert fatigue**. Create allowlists to suppress alerts from a group of users, such as users from authorized IP addresses that perform tasks that would normally trigger the alert. Prevent benign events from becoming alerts.
36
+
-**Reduce alert fatigue**. Create allowlists to suppress alerts from a group of users, like users from authorized IP addresses who perform tasks that would normally trigger the alert. Prevent benign events from becoming alerts.
37
37
38
-
-**Enrich event data**. Use watchlists to enrich your event data with name-value combinations derived from external data sources.
38
+
-**Enrich event data**. Use watchlists to add name-value combinations from external data sources to your event data.
39
39
40
-
## Limitations of watchlists
40
+
## Watchlist limitations
41
41
42
-
Before you create a watchlist, be aware of the following limitations:
42
+
We recommend reviewing the following limitations before creating watchlists:
43
43
44
-
- When you create a watchlist, the watchlist name and alias must each be between 3 and 64 characters. The first and last characters must be alphanumeric. But you can include whitespaces, hyphens, and underscores in between the first and last characters.
45
-
- The use of watchlists should be limited to reference data, as they aren't designed for large data volumes.
46
-
- The **total number of active watchlist items** across all watchlists in a single workspace is currently limited to **10 million**. Deleted watchlist items don't count against this total. If you require the ability to reference large data volumes, consider ingesting them using [custom logs](/azure/azure-monitor/agents/data-sources-custom-logs) instead.
47
-
- Watchlists are refreshed in your workspace every 12 days, updating the `TimeGenerated` field.
48
-
- Using Lighthouse to manage watchlists across different workspaces is not supported at this time.
49
-
- Local file uploads are currently limited to files of up to 3.8 MB in size.
50
-
- File uploads from an Azure Storage account (in preview) are currently limited to files up to 500 MB in size.
51
-
- Watchlists must adhere to the same column and table restrictions as KQL entities. For more information, see [KQL entity names](/kusto/query/schema-entities/entity-names?view=microsoft-sentinel&preserve-view=true).
44
+
| Limitation | Details |
45
+
|------------|---------|
46
+
|**Watchlist name and alias length**| Watchlist names and aliases must be between 3 and 64 characters. First and last characters must be alphanumeric; spaces, hyphens, and underscores allowed between. |
47
+
|**Intended use**| Use watchlists only for reference data. Watchlists aren't designed for large data volumes. |
48
+
|**Maximum active watchlist items**| You can have a maximum of 10 million active watchlist items across all watchlists in a workspace. Deleted items don't count. For larger volumes, use [custom logs](/azure/azure-monitor/agents/data-sources-custom-logs). |
49
+
|**Refresh interval**| Watchlists refresh every 12 days, updating the `TimeGenerated` field. |
50
+
|**Cross-workspace management**| Managing watchlists across workspaces using Azure Lighthouse isn't supported. |
51
+
|**Local file upload size**| Local file uploads are limited to files of up to 3.8 MB. |
52
+
|**Azure Storage file upload size (preview)**| Azure Storage uploads are limited to files of up to 500 MB. |
53
+
|**Column and table restrictions**| Watchlists must follow [KQL entity naming restrictions](/kusto/query/schema-entities/entity-names?view=microsoft-sentinel&preserve-view=true) for columns and names. |
52
54
53
-
## Ways to create watchlists in Microsoft Sentinel
55
+
## Microsoft Sentinel watchlist creation methods
54
56
55
-
Create a watchlist in Microsoft Sentinel from a file you upload from a local folder or from a file in your Azure Storage account.
57
+
Use one of the following methods to create watchlists in Microsoft Sentinel:
56
58
57
-
You have the option to download one of the watchlist templates from Microsoft Sentinel to populate with your data. Then upload that file when you create the watchlist in Microsoft Sentinel.
59
+
- Uploading a file from a local folder or from your Azure Storage account.
58
60
59
-
To create a watchlist from a large file that's up to 500 MB in size, upload the file to your Azure Storage account. Then create a shared access signature URL for Microsoft Sentinel to retrieve the watchlist data. A shared access signature URL is an URI that contains both the resource URI and shared access signature token of a resource like a csv file in your storage account. Finally, add the watchlist to your workspace in Microsoft Sentinel.
61
+
- Download a watchlist template from Microsoft Sentinel, add your data, and then upload the file when you create the watchlist.
60
62
61
-
For more information, see the following articles:
63
+
To create a watchlist from a large file (up to 500 MB), upload the file to your Azure Storage account. Create a shared access signature (SAS) URL so Microsoft Sentinel can retrieve the watchlist data. A SAS URL includes both the resource URI and the SAS token for a resource, like a CSV file in your storage account. Add the watchlist to your workspace in Microsoft Sentinel.
64
+
65
+
For more information, see:
62
66
63
67
-[Create watchlists in Microsoft Sentinel](watchlists-create.md)
-[Azure Storage SAS token](../storage/common/storage-sas-overview.md#sas-token)
66
70
67
71
## Watchlists in queries for searches and detection rules
68
72
69
-
To correlate your watchlist data with other Microsoft Sentinel data, use Kusto tabular operators such as `join` and `lookup` with the `Watchlist` table. Microsoft Sentinel creates two functions in the workspace to help reference and query your watchlists.
70
-
-`_GetWatchlistAlias` - simply returns the aliases of all your watchlists
73
+
To correlate your watchlist data with other Microsoft Sentinel data, use Kusto tabular operators such as `join` and `lookup` with the `Watchlist` table. Microsoft Sentinel creates the following functions in the workspace to help reference and query your watchlists:
74
+
75
+
-`_GetWatchlistAlias` - returns the aliases of all your watchlists
71
76
-`_GetWatchlist` - queries the name-value pairs of the specified watchlist
72
77
73
78
When you create a watchlist, you define the *SearchKey*. The search key is the name of a column in your watchlist that you expect to use as a join with other data or as a frequent object of searches. For example, suppose you have a server watchlist that contains country/region names and their respective two-letter country codes. You expect to use the country codes often for searches or joins. So you use the country code column as the search key.
@@ -78,9 +83,9 @@ When you create a watchlist, you define the *SearchKey*. The search key is the n
78
83
on $left.RemoteIPCountry == $right.SearchKey
79
84
```
80
85
81
-
Let's look some other example queries.
86
+
Let's look at some other example queries.
82
87
83
-
Suppose you want to use a watchlist in an analytics rule. You create a watchlist called `ipwatchlist`that includes columns for `IPAddress` and `Location`. You define`IPAddress` as the **SearchKey**.
88
+
Suppose you want to use a watchlist in an analytics rule. You create a watchlist called `ipwatchlist`with columns for `IPAddress` and `Location`. You set`IPAddress` as the **SearchKey**.
84
89
85
90
|`IPAddress,Location`|
86
91
|---------|
@@ -89,9 +94,9 @@ Suppose you want to use a watchlist in an analytics rule. You create a watchlist
89
94
|`10.0.150.39,Home`|
90
95
|`172.20.32.117,Work`|
91
96
92
-
To only include events from IP addresses in the watchlist, you might use a query where `watchlist` is used as a variable or where the watchlist is used inline.
97
+
To include only events from IP addresses in the watchlist, you might use a query where `watchlist` is used as a variable or inline.
93
98
94
-
The following example query uses the watchlist as a variable:
99
+
This example query uses the watchlist as a variable:
95
100
96
101
```kusto
97
102
//Watchlist as a variable
@@ -100,7 +105,7 @@ The following example query uses the watchlist as a variable:
100
105
| where ComputerIP in (watchlist)
101
106
```
102
107
103
-
The following example query uses the watchlist inline with the query and the search key defined for the watchlist.
108
+
This example query uses the watchlist inline with the query and the search key defined for the watchlist.
104
109
105
110
```kusto
106
111
//Watchlist inline with the query
@@ -112,9 +117,8 @@ The following example query uses the watchlist inline with the query and the sea
112
117
)
113
118
```
114
119
115
-
For more information, see [Build queries and detection rules with watchlists in Microsoft Sentinel](watchlists-queries.md).
120
+
For more information, see [Build queries and detection rules with watchlists in Microsoft Sentinel](watchlists-queries.md) and the following articles in the Kusto documentation:
116
121
117
-
See more information on the following items used in the preceding examples, in the Kusto documentation:
0 commit comments