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/azure-monitor/visualize/workbooks-commonly-used-components.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ You can summarize status by using a simple visual indication instead of presenti
22
22
The following example shows how to set up a traffic light icon per computer based on the CPU utilization metric.
23
23
24
24
1.[Create a new empty workbook](workbooks-create-workbook.md).
25
-
1.[Add a parameter](workbooks-create-workbook.md#add-a-parameter-to-an-azure-workbook), make it a [time range parameter](workbooks-time.md), and name it **TimeRange**.
25
+
1.[Add a parameter](workbooks-create-workbook.md#add-parameters), make it a [time range parameter](workbooks-time.md), and name it **TimeRange**.
26
26
1. Select **Add query** to add a log query control to the workbook.
27
27
1. For **Query type**, select `Logs`, and for **Resource type**, select `Log Analytics`. Select a Log Analytics workspace in your subscription that has VM performance data as a resource.
28
28
1. In the query editor, enter:
@@ -86,7 +86,7 @@ The following example shows how to enable this scenario. Let's say you want the
86
86
87
87
### Set up parameters
88
88
89
-
1.[Create a new empty workbook](workbooks-create-workbook.md) and [add a parameter component](workbooks-create-workbook.md#add-a-parameter-to-an-azure-workbook).
89
+
1.[Create a new empty workbook](workbooks-create-workbook.md) and [add a parameter component](workbooks-create-workbook.md#add-parameters).
90
90
1. Select **Add parameter** to create a new parameter. Use the following settings:
Copy file name to clipboardExpand all lines: articles/azure-monitor/visualize/workbooks-create-workbook.md
+28-22Lines changed: 28 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,15 +21,15 @@ This video walks you through creating workbooks.
21
21
To create a new Azure workbook:
22
22
1. From the Azure Workbooks page, select an empty template or select **New** in the top toolbar.
23
23
1. Combine any of these elements to add to your workbook:
24
-
-[Text](#adding-text)
25
-
-[Parameters](#adding-parameters)
26
-
-[Queries](#adding-queries)
27
-
-[Metric charts](#adding-metric-charts)
28
-
-[Links](#adding-links)
29
-
-[Groups](#adding-groups)
24
+
-[Text](#add-text)
25
+
-[Parameters](#add-parameters)
26
+
-[Queries](#add-queries)
27
+
-[Metric charts](#add-metric-charts)
28
+
-[Links](#add-links)
29
+
-[Groups](#add-groups)
30
30
- Configuration options
31
31
32
-
## Adding text
32
+
## Add text
33
33
34
34
Workbooks allow authors to include text blocks in their workbooks. The text can be human analysis of the telemetry, information to help users interpret the data, section headings, etc.
35
35
@@ -43,7 +43,7 @@ Text is added through a markdown control into which an author can add their cont
43
43
**Preview mode**:
44
44
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-control-edit-mode-preview.png" alt-text="Screenshot showing adding text to a workbook in preview mode.":::
45
45
46
-
### Add text to an Azure workbook
46
+
To add text to an Azure workbook:
47
47
48
48
1. Make sure you are in **Edit** mode by selecting the **Edit** in the toolbar. Add a query by doing either of these steps:
49
49
- Select **Add**, and **Add text** below an existing element, or at the bottom of the workbook.
@@ -80,13 +80,13 @@ You can also choose a text parameter as the source of the style. The parameter v
80
80
**Warning style example**:
81
81
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-example-warning.png" alt-text="Screenshot of a text visualization in warning style.":::
82
82
83
-
## Adding queries
83
+
## Add queries
84
84
85
85
Azure Workbooks allow you to query any of the supported workbook [data sources](workbooks-data-sources.md).
86
86
87
87
For example, you can query Azure Resource Health to help you view any service problems affecting your resources. You can also query Azure Monitor metrics, which is numeric data collected at regular intervals. Azure Monitor metrics provide information about an aspect of a system at a particular time.
88
88
89
-
### Add a query to an Azure Workbook
89
+
To add a query to an Azure Workbook:
90
90
91
91
1. Make sure you are in **Edit** mode by selecting the **Edit** in the toolbar. Add a query by doing either of these steps:
92
92
- Select **Add**, and **Add query** below an existing element, or at the bottom of the workbook.
@@ -125,13 +125,16 @@ For example, you can query Azure Resource Health to help you view any service pr
125
125
```
126
126
127
127
In this case, the query returns no rows if the **AzureDiagnostics** table is missing, or if the **ResourceId** column is missing from the table.
128
-
## Adding parameters
128
+
## Add parameters
129
129
130
-
You can collect input from consumers and reference it in other parts of the workbook using parameters. Often, you would use parameters to scope the result set or to set the right visual. Parameters help you build interactive reports and experiences.
130
+
You can collect input from consumers and reference it in other parts of the workbook using parameters. Use parameters to scope the result set or to set the right visual. Parameters help you build interactive reports and experiences. For more information on how parameters can be used, see [workbook parameters](workbooks-parameters.md).
131
131
132
132
Workbooks allow you to control how your parameter controls are presented to consumers – text box vs. drop down, single- vs. multi-select, values from text, JSON, KQL, or Azure Resource Graph, etc.
133
133
134
-
### Add a parameter to an Azure Workbook
134
+
Watch this video to learn how to use parameters and log data in Azure Workbooks.
1. Make sure you are in **Edit** mode by selecting the **Edit** in the toolbar. Add a parameter by doing either of these steps:
137
140
- Select **Add**, and **Add parameter** below an existing element, or at the bottom of the workbook.
@@ -147,15 +150,15 @@ Workbooks allow you to control how your parameter controls are presented to cons
147
150
148
151
:::image type="content" source="media/workbooks-parameters/workbooks-time-settings.png" alt-text="Screenshot showing the creation of a time range parameter.":::
149
152
150
-
## Adding metric charts
153
+
## Add metric charts
151
154
152
155
Most Azure resources emit metric data about state and health such as CPU utilization, storage availability, count of database transactions, failing app requests, etc. Using workbooks, you can create visualizations of the metric data as time-series charts.
153
156
154
157
The example below shows the number of transactions in a storage account over the prior hour. This allows the storage owner to see the transaction trend and look for anomalies in behavior.
155
158
156
159
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-area.png" alt-text="Screenshot showing a metric area chart for storage transactions in a workbook.":::
157
160
158
-
### Add a metric chart to an Azure Workbook
161
+
To add a metric chart to an Azure Workbook:
159
162
160
163
1. Make sure you are in **Edit** mode by selecting the **Edit** in the toolbar. Add a metric chart by doing either of these steps:
161
164
- Select **Add**, and **Add metric** below an existing element, or at the bottom of the workbook.
@@ -198,11 +201,14 @@ This is a metric chart in edit mode:
198
201
199
202
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-scatter.png" alt-text="Screenshot showing a metric scatter chart for storage latency.":::
200
203
201
-
## Adding links
204
+
## Add links
202
205
203
206
You can use links to create links to other views, workbooks, other items inside a workbook, or to create tabbed views within a workbook. The links can be styled as hyperlinks, buttons, and tabs.
204
207
205
208
:::image type="content" source="media/workbooks-create-workbook/workbooks-empty-links.png" alt-text="Screenshot of adding a link to a workbook.":::
209
+
210
+
Watch this video to learn how to use tabs, groups, and contextual links in Azure Workbooks:
You can apply styles to the link element itself and to individual links.
208
214
@@ -215,8 +221,8 @@ You can apply styles to the link element itself and to individual links.
215
221
|List |:::image type="content" source="media/workbooks-create-workbook/workbooks-link-style-list.png" alt-text="Screenshot of list style workbook link."::: | Links appear as a list of links, with no bullets. |
216
222
|Paragraph | :::image type="content" source="media/workbooks-create-workbook/workbooks-link-style-paragraph.png" alt-text="Screenshot of paragraph style workbook link."::: |Links appear as a paragraph of links, wrapped like a paragraph of text. |
217
223
|Navigation | :::image type="content" source="media/workbooks-create-workbook/workbooks-link-style-navigation.png" alt-text="Screenshot of navigation style workbook link."::: | Links appear as links, with vertical dividers, or pipes (`|`) between each link. |
218
-
|Tabs | :::image type="content" source="media/workbooks-create-workbook/workbooks-link-style-tabs.png" alt-text="Screenshot of tabs style workbook link."::: |Links appear as tabs. Each link appears as a tab, no link styling options apply to individual links. See the [tabs](#using-tabs) section below for how to configure tabs. |
219
-
|Toolbar | :::image type="content" source="media/workbooks-create-workbook/workbooks-link-style-toolbar.png" alt-text="Screenshot of toolbar style workbook link."::: | Links appear an Azure portal styled toolbar, with icons and text. Each link appears as a toolbar button. See the [toolbar](#using-toolbars) section below for how to configure toolbars. |
224
+
|Tabs | :::image type="content" source="media/workbooks-create-workbook/workbooks-link-style-tabs.png" alt-text="Screenshot of tabs style workbook link."::: |Links appear as tabs. Each link appears as a tab, no link styling options apply to individual links. See the [tabs](#tabs) section below for how to configure tabs. |
225
+
|Toolbar | :::image type="content" source="media/workbooks-create-workbook/workbooks-link-style-toolbar.png" alt-text="Screenshot of toolbar style workbook link."::: | Links appear an Azure portal styled toolbar, with icons and text. Each link appears as a toolbar button. See the [toolbar](#toolbars) section below for how to configure toolbars. |
220
226
221
227
222
228
**Link styles**
@@ -237,7 +243,7 @@ Links can use all of the link actions available in [link actions](workbooks-link
237
243
|Set a parameter value | A parameter can be set to a value when selecting a link, button, or tab. Tabs are often configured to set a parameter to a value, which hides and shows other parts of the workbook based on that value.|
238
244
|Scroll to a step| When selecting a link, the workbook will move focus and scroll to make another step visible. This action can be used to create a "table of contents", or a "go back to the top" style experience. |
239
245
240
-
### Using tabs
246
+
### Tabs
241
247
242
248
Most of the time, tab links are combined with the **Set a parameter value** action. Here's an example showing the links step configured to create 2 tabs, where selecting either tab will set a **selectedTab** parameter to a different value (the example shows a third tab being edited to show the parameter name and parameter value placeholders):
243
249
@@ -261,7 +267,7 @@ g
261
267
- The first tab is selected by default, invoking whatever action that tab has specified. If the first tab's action opens another view, as soon as the tabs are created, a view appears.
262
268
- You can use tabs to open another views, but this functionality should be used sparingly, since most users won't expect to navigate by selecting a tab. If other tabs are setting a parameter to a specific value, a tab that opens a view wouldn't change that value, so the rest of the workbook content will continue to show the view or data for the previous tab.
263
269
264
-
### Using toolbars
270
+
### Toolbars
265
271
266
272
Use the Toolbar style to have your links appear styled as a toolbar. In toolbar style, the author must fill in fields for:
267
273
@@ -275,7 +281,7 @@ If any required parameters are used in button text, tooltip text, or value field
275
281
276
282
A sample workbook with toolbars, globals parameters, and ARM Actions is available in [sample Azure Workbooks with links](workbooks-sample-links.md#sample-workbook-with-toolbar-links).
277
283
278
-
## Adding groups
284
+
## Add groups
279
285
280
286
A group item in a workbook allows you to logically group a set of steps in a workbook.
281
287
@@ -285,7 +291,7 @@ Groups in workbooks are useful for several things:
285
291
- **Visibility**: When you want several items to hide or show together, you can set the visibility of the entire group of items, instead of setting visibility settings on each individual item. This can be useful in templates that use tabs, as you can use a group as the content of the tab, and the entire group can be hidden/shown based on a parameter set by the selected tab.
286
292
- **Performance**: When you have a large template with many sections or tabs, you can convert each section into its own subtemplate, and use groups to load all the subtemplates within the top-level template. The content of the subtemplates won't load or run until a user makes those groups visible. Learn more about [how to split a large template into many templates](#splitting-a-large-template-into-many-templates).
287
293
288
-
### Add a group to your workbook
294
+
To add a group to your workbook:
289
295
290
296
1. Make sure you are in **Edit** mode by selecting the **Edit** in the toolbar. Add a parameter by doing either of these steps:
291
297
- Select **Add**, and **Add group** below an existing element, or at the bottom of the workbook.
Copy file name to clipboardExpand all lines: articles/azure-monitor/visualize/workbooks-graph-visualizations.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,9 @@ The following graph shows data flowing in and out of a computer via various port
16
16
17
17
[](./media/workbooks-graph-visualizations/graph.png#lightbox)
18
18
19
+
Watch this video to learn how to create graphs and use links in Azure Workbooks.
0 commit comments