Skip to content

Commit 519c82f

Browse files
Merge pull request #278055 from cwatson-cat/6-12-24-wbs-usx
Convert dashboard to workbook upds
2 parents 37096e2 + 369141b commit 519c82f

File tree

1 file changed

+44
-33
lines changed

1 file changed

+44
-33
lines changed

articles/sentinel/migration-convert-dashboards.md

Lines changed: 44 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,86 @@
11
---
2-
title: "Convert dashboards to Azure Monitor Workbooks | Microsoft Docs"
3-
description: Learn how to review, planning and migrate your current workbooks to Azure Workbooks.
4-
author: limwainstein
5-
ms.author: lwainstein
2+
title: Convert dashboards to Azure Workbooks in Microsoft Sentinel
3+
description: Learn how to review, planning, and migrate your current dashboards to Azure Workbooks.
4+
author: cwatson-cat
5+
ms.author: cwatson
66
ms.topic: how-to
7-
ms.date: 05/03/2022
7+
ms.date: 06/12/2024
8+
appliesto:
9+
- Microsoft Sentinel in the Azure portal and the Microsoft Defender portal
10+
ms.collection: usx-security
811
---
912

1013
# Convert dashboards to Azure Workbooks
1114

12-
Dashboards in your existing SIEM will convert to [Azure Monitor Workbooks](monitor-your-data.md), the Microsoft Sentinel adoption of Azure Monitor Workbooks, which provides versatility in creating custom dashboards.
13-
14-
This article describes how to review, plan, and convert your current workbooks to Azure Monitor Workbooks.
15+
Convert dashboards from your existing security information and event management (SIEM) solution to an Azure workbook for Microsoft Sentinel. Azure Workbooks provide versatility to create custom dashboards for Microsoft Sentinel. This article describes how to review, plan, and convert your current dashboards to Azure Workbooks.
1516

1617
## Review dashboards in your current SIEM
1718

18-
Review these considerations when designing your migration.
19+
Consider the following steps when you design your migration.
1920

20-
- **Discover dashboards**. Gather information about your dashboards, including design, parameters, data sources, and other details. Identify the purpose or usage of each dashboard.
21-
- **Select**. Don’t migrate all dashboards without consideration. Focus on dashboards that are critical and used regularly.
22-
- **Consider permissions**. Consider who are the target users for workbooks. Microsoft Sentinel uses Azure Workbooks, and [access is controlled](../azure-monitor/visualize/workbooks-overview.md#access-control) using Azure Role Based Access Control (RBAC). To create dashboards outside Azure, for example for business execs without Azure access, using a reporting tool such as Power BI.
21+
- **Analyze dashboards**. Gather information about your dashboards, including design, parameters, data sources, and other details. Identify the purpose or usage of each dashboard.
22+
- **Be selective**. Don’t migrate all dashboards without consideration. Focus on dashboards that are critical and used regularly.
23+
- **Consider permissions**. Consider who are the target users for workbooks. Azure Workbooks use Azure role-based access control (Azure RBAC). For more information, see [Assess control in Azure Workbooks](/azure/azure-monitor/visualize/workbooks-overview#access-control). To create dashboards outside Azure, for example for business executives without Azure access, use a reporting tool such as Power BI.
2324

2425
## Prepare for the dashboard conversion
2526

26-
After reviewing your dashboards, do the following to prepare for your dashboard migration:
27+
After reviewing your dashboards, complete the following tasks to prepare for your dashboard migration:
2728

2829
- Review all of the visualizations in each dashboard. The dashboards in your current SIEM might contain several charts or panels. It's crucial to review the content of your short-listed dashboards to eliminate any unwanted visualizations or data.
2930
- Capture the dashboard design and interactivity.
3031
- Identify any design elements that are important to your users. For example, the layout of the dashboard, the arrangement of the charts or even the font size or color of the graphs.
31-
- Capture any interactivity such as drilldown, filtering, and others that you need to carry over to Azure Monitor Workbooks.
32-
- Identify required parameters or user inputs. In most cases, you need to define parameters for users to perform search, filtering, or scoping the results (for example, date range, account name and others). Hence, it's crucial to capture the details around parameters. Here are some of the key points to help you with collecting the parameter requirements:
33-
- The type of parameter for users to perform selection or input. For example, date range, text, or others.
34-
- How the parameters are represented, such as drop-down, text box, or others.
35-
- The expected value format, for example, time, string, integer, or others.
36-
- Other properties, such as the default value, allow multi-select, conditional visibility, or others.
32+
- Capture any interactivity such as drilldown, filtering, and others that you need to carry over to Azure Workbooks.
33+
- Identify required parameters or user inputs. In most cases, you need to define parameters for users to perform search, filtering, or scoping the results (for example, date range, account name and others). Hence, it's crucial to capture the details around parameters. Here are some of the key parameter requirements to collect:
34+
35+
- The type of parameter for users to perform selection or input. For example, date range, text, or others.
36+
- How the parameters are represented, such as drop-down, text box, or others.
37+
- The expected value format, for example, time, string, integer, or others.
38+
- Other properties, such as the default value, allow multi-select, conditional visibility, or others.
3739

3840
## Convert dashboards
3941

40-
Perform the following tasks in Azure Workbook and Microsoft Sentinel to convert your dashboard.
42+
To convert your dashboard, complete the following tasks in Azure Workbooks and Microsoft Sentinel.
43+
44+
### 1. Identify data sources
45+
46+
Azure Workbooks are compatible with a large number of data sources. For more information, see [Azure Workbooks data sources](../azure-monitor/visualize/workbooks-data-sources.md). In most cases, use the Azure Monitor logs data source and Kusto Query Language (KQL) queries to visualize the underlying logs in your Microsoft Sentinel workspace.
4147

42-
#### 1. Identify data sources
48+
### 2. Construct or review KQL queries
4349

44-
Azure Monitor workbooks are [compatible with a large number of data sources](../azure-monitor/visualize/workbooks-data-sources.md). In most cases, use the Azure Monitor Logs data source and use Kusto Query Language (KQL) queries to visualize the underlying logs in your Microsoft Sentinel workspace.
50+
In this step, you mainly work with KQL to visualize your data. You can construct and test your queries in Microsoft Sentinel before converting them to Azure Workbooks. To test the queries from Microsoft Sentinel in the Azure portal, go to **Logs**. From Microsoft Sentinel in the Defender portal, go to **Investigation & response** > **Hunting** > **Advanced hunting**.
4551

46-
#### 2. Construct or review KQL queries
52+
Before finalizing your KQL queries, always review and tune the queries to improve query performance. Optimized queries:
4753

48-
In this step, you mainly work with KQL to visualize your data. You can construct and test your queries in the Microsoft Sentinel Logs page before converting them to Azure Monitor workbooks. Before finalizing your KQL queries, always review and tune the queries to improve query performance. Optimized queries:
4954
- Run faster, reduce the overall duration of the query execution.
5055
- Have a smaller chance of being throttled or rejected.
5156

52-
Learn how to optimize KQL queries:
57+
For more information, see the following resources:
58+
5359
- [KQL query best practices](/azure/data-explorer/kusto/query/best-practices)
5460
- [Optimize queries in Azure Monitor Logs](../azure-monitor/logs/query-optimization.md)
55-
- [Optimizing KQL performance (webinar)](https://youtu.be/jN1Cz0JcLYU)
61+
- [Optimizing KQL performance (webinar)](https://youtu.be/jN1Cz0JcLYU)
5662

57-
#### 3. Create or update the workbook
63+
### 3. Create or update the workbook
5864

59-
[Create](tutorial-monitor-your-data.md#create-new-workbook) a workbook, update the workbook, or clone an existing workbook so that you don’t have to start from scratch. Also, specify how the data or visualizations will be represented, arranged and [grouped](../azure-monitor/visualize/workbooks-groups.md). There are two common designs:
65+
Create a workbook, update the workbook, or clone an existing workbook so that you don’t have to start from scratch. Also, specify how the data or visualizations is represented, arranged, and grouped. There are two common designs:
6066

6167
- Vertical workbook
6268
- Tabbed workbook
6369

64-
#### 4. Create or update workbook parameters or user inputs
70+
For more information, see the following articles:
71+
72+
- [Visualize and monitor your data by using workbooks in Microsoft Sentinel](monitor-your-data.md)
73+
- [Add groups in Azure Workbooks](../azure-monitor/visualize/workbooks-create-workbook.md#add-groups)
74+
75+
### 4. Create or update workbook parameters or user inputs
6576

66-
By the time you arrive at this stage, you should have [identified the required parameters](#prepare-for-the-dashboard-conversion). With parameters, you can collect input from the consumers and reference the input in other parts of the workbook. This input is typically used to scope the result set, to set the correct visualization, and allows you to build interactive reports and experiences.
77+
By the time you arrive at this stage, you identified the required parameters for your workbook. With parameters, you can collect input from the consumers and reference the input in other parts of the workbook. This input is typically used to scope the result set, to set the correct visualization, and allows you to build interactive reports and experiences.
6778

6879
Workbooks allow you to control how your parameter controls are presented to consumers. For example, you select whether the controls are presented as a text box vs. drop down, or single- vs. multi-select. You can also select which values to use, from text, JSON, KQL, or Azure Resource Graph, and more.
6980

7081
Review the [supported workbook parameters](../azure-monitor/visualize/workbooks-parameters.md). You can reference these parameter values in other parts of workbooks either via bindings or value expansions.
7182

72-
#### 5. Create or update visualizations
83+
### 5. Create or update visualizations
7384

7485
Workbooks provide a rich set of capabilities for visualizing your data. Review these detailed examples of each visualization type.
7586

@@ -83,9 +94,9 @@ Workbooks provide a rich set of capabilities for visualizing your data. Review t
8394
- [Honey comb](../azure-monitor/visualize/workbooks-honey-comb.md)
8495
- [Composite bar](../azure-monitor/visualize/workbooks-composite-bar.md)
8596

86-
#### 6. Preview and save the workbook
97+
### 6. Preview and save the workbook
8798

88-
Once you've saved your workbook, specify the parameters, if any exist, and validate the results. You can also try the [auto refresh](tutorial-monitor-your-data.md#refresh-your-workbook-data) or the print feature to [save as a PDF](monitor-your-data.md#print-a-workbook-or-save-as-pdf).
99+
After you save your workbook, specify the parameters, and validate the results. You can also try the [auto refresh](tutorial-monitor-your-data.md#refresh-your-workbook-data) or the print feature to [save as a PDF](monitor-your-data.md#print-a-workbook-or-save-as-pdf).
89100

90101
## Next steps
91102

0 commit comments

Comments
 (0)