Skip to content

Commit 9850248

Browse files
Merge pull request #292462 from austinmccollum/patch-1
Clarify watchlist conceptual
2 parents a33e5ec + e6e2e38 commit 9850248

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

articles/sentinel/watchlists-queries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.collection: usx-security
1717

1818
# Build queries or detection rules with watchlists in Microsoft Sentinel
1919

20-
Query data in any table against data from a watchlist by treating the watchlist as a table for joins and lookups. 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.
20+
Correlate your watchlist data against any Microsoft Sentinel data with Kusto tabular operators such as `join` and `lookup`. 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.
2121

2222
For optimal query performance, use **SearchKey** as the key for joins in your queries.
2323

articles/sentinel/watchlists.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Watchlists in Microsoft Sentinel allow you to correlate data from a data source
2222

2323
Use watchlists in your search, detection rules, threat hunting, and response playbooks.
2424

25-
Watchlists are stored in your Microsoft Sentinel workspace as name-value pairs and are cached for optimal query performance and low latency.
25+
Watchlists are stored in your Microsoft Sentinel workspace in the `Watchlist` table as name-value pairs and are cached for optimal query performance and low latency.
2626

2727
> [!IMPORTANT]
2828
> The features for watchlist templates and the ability to create a watchlist from a file in Azure Storage are currently in **PREVIEW**. The [Azure Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) include additional legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
@@ -69,9 +69,11 @@ For more information, see the following articles:
6969

7070
## Watchlists in queries for searches and detection rules
7171

72-
Query data in any table against data from a watchlist by treating the watchlist as a table for joins and lookups. 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.
72+
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.
73+
- `_GetWatchlistAlias` - simply returns the aliases of all your watchlists
74+
- `_GetWatchlist` - queries the name-value pairs of the specified watchlist
7375

74-
The following example query joins the `RemoteIPCountry` column in the `Heartbeat` table with the search key defined for the watchlist named `mywatchlist`.
76+
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.
7577

7678
```kusto
7779
Heartbeat
@@ -90,7 +92,7 @@ Suppose you want to use a watchlist in an analytics rule. You create a watchlist
9092
|`10.0.150.39,Home` |
9193
|`172.20.32.117,Work` |
9294

93-
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.
95+
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.
9496

9597
The following example query uses the watchlist as a variable:
9698

0 commit comments

Comments
 (0)