Skip to content

Commit 72479d1

Browse files
authored
Merge pull request #225626 from austinmccollum/austinmc-content-central
new article for content central
2 parents b065f21 + 57911e2 commit 72479d1

File tree

5 files changed

+137
-0
lines changed

5 files changed

+137
-0
lines changed

articles/sentinel/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@
8989
href: sentinel-solutions-catalog.md
9090
- name: Manage custom content with repositories
9191
href: ci-cd-custom-content.md
92+
- name: OOTB content centralization changes
93+
href: sentinel-content-centralize.md
9294
- name: Collect data
9395
items:
9496
- name: Data collection methods
29.9 KB
Loading
30.3 KB
Loading
79.4 KB
Loading
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
title: Out-of-the-box (OOTB) content centralization changes
3+
titleSuffix: Microsoft Sentinel
4+
description: This article describes the centralization changes about to take place for out-of-the-box content in Microsoft Sentinel.
5+
author: austinmccollum
6+
ms.topic: conceptual
7+
ms.date: 01/30/2023
8+
ms.author: austinmc
9+
#Customer intent: As a SIEM decision maker or implementer, I want to know about changes to out of the box content, and how to centralize the management, discovery and inventory of content in Microsoft Sentinel.
10+
---
11+
12+
# Microsoft Sentinel out-of-the-box content centralization changes
13+
14+
Microsoft Sentinel Content hub enables discovery and on-demand installation of out-of-the-box (OOTB) content and solutions in a single step. Previously, some of this OOTB content only existed in various gallery sections of Sentinel. We're excited to announce *all* of the following gallery content templates are now available in content hub as standalone items or part of packaged solutions.
15+
16+
- **Data connectors**
17+
- **Hunting queries**
18+
- **Analytics rule templates**
19+
- **Playbook templates**
20+
- **Workbook templates**
21+
22+
## Content hub changes
23+
In order to centralize all out-of-the-box content, we're planning to retire the gallery-only content templates. The legacy gallery content templates are no longer being updated consistently, and the content hub is where OOTB content is kept up to date. Content hub also provides update workflows for solutions and automatic updates for standalone content. To facilitate this transition, we're going to publish a central tool to reinstate corresponding **IN USE** retired templates from corresponding Content hub solutions.
24+
25+
## Sentinel GitHub changes
26+
Microsoft Sentinel has an official [GitHub repository](https://github.com/Azure/Azure-Sentinel) for community contributions vetted by Microsoft and the community. It's the source for most of the content items in Content hub. For consistent discovery of this content, the OOTB content centralization changes have already been extended to the Sentinel GitHub repo.
27+
28+
- All OOTB content packaged from content hub solutions is now stored in the GitHub repo [Solutions folder](https://github.com/Azure/Azure-Sentinel/tree/master/Solutions).
29+
- All standalone OOTB content will continue to remain in their respective locations.
30+
31+
Together, these Content hub and Sentinel GitHub repo changes will complete the journey towards centralizing Sentinel content.
32+
33+
## When is this change coming?
34+
> [!IMPORTANT]
35+
> The following timeline is tentative and subject to change.
36+
>
37+
38+
The centralization change in the Sentinel portal is expected to go live in all Sentinel workspaces Q2 2023. The Microsoft Sentinel GitHub changes have already been done. Standalone content is available in existing GitHub folders and solutions content has been moved to the solutions folder.
39+
40+
## Scope of change
41+
This change is only scoped to *gallery content* type templates. All these same templates and more OOTB content are available in *Content hub* as solutions or standalone content.
42+
43+
For Microsoft Sentinel GitHub, OOTB content packaged in solutions in content hub is now only listed under the GitHub repo [Solutions folder](https://github.com/Azure/Azure-Sentinel/tree/master/Solutions). The other existing GitHub content is scoped to the following folders and only contains standalone content items. Content in the remaining GitHub folders not called out in this list don't have any changes.
44+
45+
- [DataConnectors folder](https://github.com/Azure/Azure-Sentinel/tree/master/DataConnectors)
46+
- [Detections folder](https://github.com/Azure/Azure-Sentinel/tree/master/Detections) (Analytics rules)
47+
- [Hunting queries folder](https://github.com/Azure/Azure-Sentinel/tree/master/Hunting%20Queries)
48+
- [Parsers folder](https://github.com/Azure/Azure-Sentinel/tree/master/Parsers)
49+
- [Playbooks folder](https://github.com/Azure/Azure-Sentinel/tree/master/Playbooks)
50+
- [Workbooks folder](https://github.com/Azure/Azure-Sentinel/tree/master/Workbooks)
51+
52+
53+
### What's not changing?
54+
The active or custom items created in any manner (from templates or otherwise) are **NOT** impacted by this change. More specifically, the following are **NOT** affected by this change:
55+
56+
- Data Connectors with *Status = Connected*.
57+
- Alert rules or detections (enabled or disabled) in the **'Active rules'** tab in the Analytics gallery.
58+
- Saved workbooks in the **'My workbooks'** tab in the Workbooks gallery.
59+
- Cloned content or *Content source = Custom* in the Hunting gallery.
60+
- Active playbooks (enabled or disabled) in the **'Active playbooks'** tab in the Automation gallery.
61+
62+
Any OOTB content templates installed from content hub (identifiable as *Content source = Content hub*) are NOT affected by this change.
63+
64+
### What's changing?
65+
All template galleries will display an in-product warning banner. This banner will contain a link to a tool that will run within the Microsoft Sentinel portal. Activating the tool will initiate a guided experience to reinstate the content templates for the **IN USE** retired templates from the Content hub. This tool only needs to be run once per workspace, so be sure to plan with your organization. Once the tool runs successfully, the warning banner will resolve and no longer be visible from the template galleries of that workspace.
66+
67+
Specific impact to the gallery content templates for each of these galleries are detailed in the following table. Expect these changes when the OOTB content centralization goes live.
68+
69+
| Content Type | Impact |
70+
| ------- | ------- |
71+
| [Data connectors](connect-data-sources.md) | The templates identifiable as `content source = "Gallery content"` and `Status = "Not connected"` will no longer appear in the data connectors gallery. |
72+
| [Analytics templates](detect-threats-built-in.md#view-built-in-detections) | The templates identifiable as `source name = "Gallery content"` will no longer appear in the Analytics template gallery. |
73+
| [Hunting](hunting.md#use-built-in-queries) | The templates with `Content source = "Gallery content"` will no longer appear in the Hunting gallery. |
74+
| [Workbooks templates](get-visibility.md#use-built-in-workbooks) | The templates with `Content source = "Gallery content"` will no longer appear in the Workbooks template gallery. |
75+
| [Playbooks templates](use-playbook-templates.md#explore-playbook-templates) | The templates identifiable as `source name = "Gallery content"` will no longer appear in the Automation Playbook templates gallery. |
76+
77+
Here's an example of an Analytics rule before and after the centralization changes and the tool has run.
78+
- The active Analytics rule won't change at all. We can see it's based on an Analytics rule template that will be retired.
79+
:::image type="content" source="media/sentinel-content-centralize/before-tool-analytic-rule-active-2.png" alt-text="This screenshot shows an active Analytics rule before centralization changes.":::
80+
81+
- This screenshot shows an Analytics rule template that will be retired.
82+
:::image type="content" source="media/sentinel-content-centralize/before-tool-analytic-rule-templates-2.png" alt-text="This screenshot shows the Analytics rule template that will be retired.":::
83+
84+
- After the tool has been run to reinstate the Analytics rule template, the source changes to the solution it's reinstated from.
85+
:::image type="content" source="media/sentinel-content-centralize/after-tool-analytic-rule-template-2.png" alt-text="This screenshot shows the Analytics rule template after being reinstated from the Content hub Azure Active Directory solution.":::
86+
87+
## Action needed
88+
- Starting now, install new OOTB content from Content hub and update solutions as needed to have the latest version of templates.
89+
- For existing gallery content templates in use, get future updates by installing the respective solutions or standalone content items from Content hub. The gallery content in the feature galleries may be out-of-date.
90+
- If you have applications or processes that directly get OOTB content from the Microsoft Sentinel GitHub repository, update the locations to include getting OOTB content from the solutions folder in addition to existing content folders.
91+
- Plan with your organization who and when will run the tool when you see the warning banner and the change goes live in Q2 2023. The tool needs to be run once in a workspace to reinstate all **IN USE** retired templates from the Content hub.
92+
- Review the FAQs section to learn more details that may be applicable to your environment.
93+
94+
## Content centralization FAQs
95+
#### Will my SOC alert generation or incidents generation and management be impacted by this change?
96+
No, there's no impact to active alert rules or detections, or active playbooks, or cloned hunting queries, or saved workbooks. The OOTB content centralization change won't impact your current incident generation and management processes.
97+
98+
#### Are there any gallery content exceptions?
99+
Yes, the following Analytics rule template types are exempt from this change.
100+
101+
- Anomalies rule templates
102+
- Fusion rule templates
103+
- ML (Machine Learning) Behavior Analytics rule templates
104+
- Microsoft Security (incident creation) rule templates
105+
- Threat Intelligence rule template
106+
107+
#### Will any of the APIs be impacted with this change?
108+
Yes. Currently the only Sentinel REST API calls that exist for content template management are the `Get` and `List` operations for alert rule templates. These operations only surface gallery content templates and won't be updated. For more information on these operations see the current [Alert Rule Templates REST API reference](/rest/api/securityinsights/stable/alert-rule-templates).
109+
110+
New content hub REST API operations will be available soon to enable OOTB content management scenarios more broadly. This API update will include operations for the same content types scoped in the centralization changes (data connectors, playbook templates, workbook templates, analytic rule templates, hunting queries). A mechanism to update Analytics rule templates installed on the workspace is also on the roadmap.
111+
112+
**Action needed:** Plan to update your applications and processes to utilize the new content hub OOTB content management API operations when those are available in Q2 2023.
113+
114+
#### How will the central tool identify my in-use OOTB content templates?
115+
The tool builds a list of solutions based on two criteria: data connectors with `Status = "Connected"` and **IN USE** Playbook templates. Once the proposed list of solutions is generated, the tool will present them for approval. If approved, the tool installs all those solutions. Because the OOTB content is reinstated based on solutions you may get more templates than you might actually be using.
116+
117+
Please note that this central tool is a best-effort to get your **IN USE** OOTB content templates reinstated from Content hub. You can install OOTB content omitted directly from Content hub.
118+
119+
#### What if I'm using APIs to connect data sources in my Sentinel workspace?
120+
Currently, if an API data connection matches the data connector data type, it will show up as `Status = "Connected"` in the Data connectors gallery. After the centralization changes go live, the specific data connector needs to be installed from a respective solution to get the same behavior.
121+
122+
**Action needed:** Plan to update processes or tooling for your data connector deployments to install from Content hub solution(s) before the connecting with data ingestion APIs. The REST API operator for installing a solution will be coming in Q2 2023 with the OOTB content management APIs.
123+
124+
#### What if I'm working with content using Repositories feature in Microsoft Sentinel?
125+
Repositories specifically deploy custom or active content in Microsoft Sentinel. Content deployed through the Repositories feature won't be impacted by the OOTB content centralization changes.
126+
127+
## Next steps
128+
Take a look at these other resources for OOTB content and Content hub.
129+
130+
- [About OOTB content and solutions in Microsoft Sentinel](sentinel-solutions.md)
131+
- [Discover OOTB content and solutions in Content hub](sentinel-solutions-deploy.md)
132+
- [How to install and update OOTB content and solutions in Content hub](sentinel-solutions-deploy.md#install-or-update-content)
133+
- [Bulk install and update solutions and standalone content in Content hub](sentinel-solutions-deploy.md#bulk-install-and-update-content)
134+
- [How to enable OOTB content and solutions in Content hub](sentinel-solutions-deploy.md#enable-content-items-in-a-solution)
135+
- Video: [Using content hub to manage your SIEM content](https://www.youtube.com/watch?v=OtHs4dnR0yA&list=PL3ZTgFEc7LyvY90VTpKVFf70DXM7--47u&index=10)

0 commit comments

Comments
 (0)