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-create-workbook.md
+52-48Lines changed: 52 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,16 +32,18 @@ To create a new Azure workbook:
32
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
-
36
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-example.png" lightbox="media/workbooks-create-workbook/workbooks-text-example.png" alt-text="Screenshot of adding text to a workbook.":::
35
+
<!-- convertborder later -->
36
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-example.png" lightbox="media/workbooks-create-workbook/workbooks-text-example.png" alt-text="Screenshot of adding text to a workbook." border="false":::
37
37
38
38
Text is added through a markdown control into which an author can add their content. An author can use the full formatting capabilities of markdown. These include different heading and font styles, hyperlinks, tables, etc. Markdown allows authors to create rich Word- or Portal-like reports or analytic narratives. Text can contain parameter values in the markdown text, and those parameter references will be updated as the parameters change.
39
39
40
40
**Edit mode**:
41
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-control-edit-mode.png" alt-text="Screenshot showing adding text to a workbook in edit mode.":::
41
+
<!-- convertborder later -->
42
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-control-edit-mode.png" lightbox="media/workbooks-create-workbook/workbooks-text-control-edit-mode.png" alt-text="Screenshot showing adding text to a workbook in edit mode." border="false":::
42
43
43
44
**Preview mode**:
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
+
<!-- convertborder later -->
46
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-control-edit-mode-preview.png" lightbox="media/workbooks-create-workbook/workbooks-text-control-edit-mode-preview.png" alt-text="Screenshot showing adding text to a workbook in preview mode." border="false":::
45
47
46
48
To add text to an Azure workbook:
47
49
@@ -75,10 +77,12 @@ You can also choose a text parameter as the source of the style. The parameter v
75
77
### Text style examples
76
78
77
79
**Info style example**:
78
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-control-edit-mode-preview.png" alt-text="Screenshot of adding text to a workbook in preview mode showing info style.":::
80
+
<!-- convertborder later -->
81
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-control-edit-mode-preview.png" lightbox="media/workbooks-create-workbook/workbooks-text-control-edit-mode-preview.png" alt-text="Screenshot of adding text to a workbook in preview mode showing info style." border="false":::
79
82
80
83
**Warning style example**:
81
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-example-warning.png" alt-text="Screenshot of a text visualization in warning style.":::
84
+
<!-- convertborder later -->
85
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-text-example-warning.png" lightbox="media/workbooks-create-workbook/workbooks-text-example-warning.png" alt-text="Screenshot of a text visualization in warning style." border="false":::
82
86
83
87
## Add queries
84
88
@@ -193,16 +197,16 @@ To add a parameter to an Azure Workbook:
193
197
- Required:
194
198
195
199
1. Select **Done editing**.
196
-
197
-
:::image type="content" source="media/workbooks-parameters/workbooks-time-settings.png" alt-text="Screenshot showing the creation of a time range parameter.":::
200
+
<!-- convertborder later -->
201
+
:::image type="content" source="media/workbooks-parameters/workbooks-time-settings.png" lightbox="media/workbooks-parameters/workbooks-time-settings.png" alt-text="Screenshot showing the creation of a time range parameter." border="false":::
198
202
199
203
## Add metric charts
200
204
201
205
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.
202
206
203
207
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.
204
-
205
-
:::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.":::
208
+
<!-- convertborder later -->
209
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-area.png" lightbox="media/workbooks-create-workbook/workbooks-metric-chart-storage-area.png" alt-text="Screenshot showing a metric area chart for storage transactions in a workbook." border="false":::
206
210
207
211
To add a metric chart to an Azure Workbook:
208
212
@@ -214,8 +218,8 @@ To add a metric chart to an Azure Workbook:
214
218
1. Select **Done Editing**.
215
219
216
220
This is a metric chart in edit mode:
217
-
218
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-area-edit.png" alt-text="Screenshot showing a metric area chart for Storage transactions in edit mode.":::
221
+
<!-- convertborder later -->
222
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-area-edit.png" lightbox="media/workbooks-create-workbook/workbooks-metric-chart-storage-area-edit.png" alt-text="Screenshot showing a metric area chart for Storage transactions in edit mode." border="false":::
219
223
220
224
### Metric chart parameters
221
225
@@ -235,23 +239,23 @@ This is a metric chart in edit mode:
235
239
### Metric chart examples
236
240
237
241
**Transactions split by API name as a line chart**
238
-
239
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-split-line.png" alt-text="Screenshot showing a metric line chart for Storage transactions split by API name.":::
242
+
<!-- convertborder later -->
243
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-split-line.png" lightbox="media/workbooks-create-workbook/workbooks-metric-chart-storage-split-line.png" alt-text="Screenshot showing a metric line chart for Storage transactions split by API name." border="false":::
240
244
241
245
242
246
**Transactions split by response type as a large bar chart**
243
-
244
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-bar-large.png" alt-text="Screenshot showing a large metric bar chart for Storage transactions split by response type.":::
247
+
<!-- convertborder later -->
248
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-bar-large.png" lightbox="media/workbooks-create-workbook/workbooks-metric-chart-storage-bar-large.png" alt-text="Screenshot showing a large metric bar chart for Storage transactions split by response type." border="false":::
245
249
246
250
**Average latency as a scatter chart**
247
-
248
-
:::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.":::
251
+
<!-- convertborder later -->
252
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-metric-chart-storage-scatter.png" lightbox="media/workbooks-create-workbook/workbooks-metric-chart-storage-scatter.png" alt-text="Screenshot showing a metric scatter chart for storage latency." border="false":::
249
253
250
254
## Add links
251
255
252
256
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.
253
-
254
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-empty-links.png" alt-text="Screenshot of adding a link to a workbook.":::
257
+
<!-- convertborder later -->
258
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-empty-links.png" lightbox="media/workbooks-create-workbook/workbooks-empty-links.png" alt-text="Screenshot of adding a link to a workbook." border="false":::
255
259
256
260
Watch this video to learn how to use tabs, groups, and contextual links in Azure Workbooks:
@@ -292,17 +296,17 @@ Links can use all of the link actions available in [link actions](workbooks-link
292
296
### Tabs
293
297
294
298
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):
295
-
296
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-creating-tabs.png" alt-text="Screenshot of creating tabs in workbooks.":::
299
+
<!-- convertborder later -->
300
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-creating-tabs.png" lightbox="media/workbooks-create-workbook/workbooks-creating-tabs.png" alt-text="Screenshot of creating tabs in workbooks." border="false":::
297
301
298
302
299
303
You can then add other items in the workbook that are conditionally visible if the **selectedTab** parameter value is "1" by using the advanced settings:
300
-
301
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-selected-tab.png" alt-text="Screenshot of conditionally visible tab in workbooks.":::
304
+
<!-- convertborder later -->
305
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-selected-tab.png" lightbox="media/workbooks-create-workbook/workbooks-selected-tab.png" alt-text="Screenshot of conditionally visible tab in workbooks." border="false":::
302
306
303
307
The first tab is selected by default, initially setting **selectedTab** to 1, and making that step visible. Selecting the second tab will change the value of the parameter to "2", and different content will be displayed:
304
-
305
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-selected-tab2.png" alt-text="Screenshot of workbooks with content displayed when selected tab is 2.":::
308
+
<!-- convertborder later -->
309
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-selected-tab2.png" lightbox="media/workbooks-create-workbook/workbooks-selected-tab2.png" alt-text="Screenshot of workbooks with content displayed when selected tab is 2." border="false":::
306
310
307
311
A sample workbook with the above tabs is available in [sample Azure Workbooks with links](workbooks-sample-links.md#sample-workbook-with-links).
308
312
g
@@ -320,8 +324,8 @@ Use the Toolbar style to have your links appear styled as a toolbar. In toolbar
320
324
- Button text, the text to display on the toolbar. Parameters may be used in this field.
321
325
- Icon, the icon to display in the toolbar.
322
326
- Tooltip Text, text to be displayed on the toolbar button's tooltip text. Parameters may be used in this field.
323
-
324
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-links-create-toolbar.png" alt-text="Screenshot of creating links styled as a toolbar in workbooks.":::
327
+
<!-- convertborder later -->
328
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-links-create-toolbar.png" lightbox="media/workbooks-create-workbook/workbooks-links-create-toolbar.png" alt-text="Screenshot of creating links styled as a toolbar in workbooks." border="false":::
325
329
326
330
If any required parameters are used in button text, tooltip text, or value fields, and the required parameter is unset, the toolbar button will be disabled. For example, this can be used to disable toolbar buttons when no value is selected in another parameter/control.
327
331
@@ -342,18 +346,18 @@ To add a group to your workbook:
342
346
1. Make sure you are in **Edit** mode by selecting the **Edit** in the toolbar. Add a parameter by doing either of these steps:
343
347
- Select **Add**, and **Add group** below an existing element, or at the bottom of the workbook.
344
348
- Select the ellipses (...) to the right of the **Edit** button next to one of the elements in the workbook, then select **Add** and then **Add group**.
345
-
346
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-add-group.png" alt-text="Screenshot showing selecting adding a group to a workbook. ":::
349
+
<!-- convertborder later -->
350
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-add-group.png" lightbox="media/workbooks-create-workbook/workbooks-add-group.png" alt-text="Screenshot showing selecting adding a group to a workbook. " border="false":::
347
351
1. Select items for your group.
348
352
1. Select **Done editing.**
349
353
350
354
This is a group in read mode with two items inside: a text item and a query item.
351
-
352
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-view.png" alt-text="Screenshot showing a group in read mode in a workbook.":::
355
+
<!-- convertborder later -->
356
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-view.png" lightbox="media/workbooks-create-workbook/workbooks-groups-view.png" alt-text="Screenshot showing a group in read mode in a workbook." border="false":::
353
357
354
358
In edit mode, you can see those two items are actually inside a group item. In the screenshot below, the group is in edit mode. The group contains two items inside the dashed area. Each item can be in edit or read mode, independent of each other. For example, the text step is in edit mode while the query step is in read mode.
355
-
356
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-edit.png" alt-text="Screenshot of a group in edit mode in a workbook.":::
359
+
<!-- convertborder later -->
360
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-edit.png" lightbox="media/workbooks-create-workbook/workbooks-groups-edit.png" alt-text="Screenshot of a group in edit mode in a workbook." border="false":::
357
361
358
362
### Scoping a group
359
363
@@ -381,17 +385,17 @@ For groups created from a template, the content of the template isn't retrieved
381
385
In this mode, a button is displayed where the group would be, and no content is retrieved or created until the user explicitly clicks the button to load the content. This is useful in scenarios where the content might be expensive to compute or rarely used. The author can specify the text to appear on the button.
382
386
383
387
This screenshot shows explicit load settings with a configured "Load more" button.
384
-
385
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded.png" alt-text="Screenshot of explicit load settings for a group in workbooks.":::
388
+
<!-- convertborder later -->
389
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded.png" lightbox="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded.png" alt-text="Screenshot of explicit load settings for a group in workbooks." border="false":::
386
390
387
391
This is the group before being loaded in the workbook:
388
-
389
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded-before.png" alt-text="Screenshot showing an explicit group before being loaded in the workbook.":::
392
+
<!-- convertborder later -->
393
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded-before.png" lightbox="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded-before.png" alt-text="Screenshot showing an explicit group before being loaded in the workbook." border="false":::
390
394
391
395
392
396
The group after being loaded in the workbook:
393
-
394
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded-after.png" alt-text="Screenshot showing an explicit group after being loaded in the workbook.":::
397
+
<!-- convertborder later -->
398
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded-after.png" lightbox="media/workbooks-create-workbook/workbooks-groups-explicitly-loaded-after.png" alt-text="Screenshot showing an explicit group after being loaded in the workbook." border="false":::
395
399
396
400
#### Always mode
397
401
@@ -406,24 +410,24 @@ When a template is loaded into a group, the workbook attempts to merge any param
406
410
#### Example 1: All parameters have identical names
407
411
408
412
Suppose you have a template that has two parameters at the top, a time range parameter and a text parameter named "**Filter**":
409
-
410
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-top-level-params.png" alt-text="Screenshot showing top level parameters in a workbook.":::
413
+
<!-- convertborder later -->
414
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-top-level-params.png" lightbox="media/workbooks-create-workbook/workbooks-groups-top-level-params.png" alt-text="Screenshot showing top level parameters in a workbook." border="false":::
411
415
412
416
Then a group item loads a second template that has its own two parameters and a text step, where the parameters are named the same:
413
-
414
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-merged-away.png" alt-text="Screenshot of a workbook template with top level parameters.":::
417
+
<!-- convertborder later -->
418
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-merged-away.png" lightbox="media/workbooks-create-workbook/workbooks-groups-merged-away.png" alt-text="Screenshot of a workbook template with top level parameters." border="false":::
415
419
416
420
When the second template is loaded into the group, the duplicate parameters are merged out. Since all of the parameters are merged away, the inner parameters step is also merged out, resulting in the group containing only the text step.
417
421
418
422
### Example 2: One parameter has an identical name
419
423
420
424
Suppose you have a template that has two parameters at the top, a **time range** parameter and a text parameter named "**FilterB**" ():
421
-
422
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-wont-merge-away.png" alt-text="Screenshot of a group item with the result of parameters merged away.":::
425
+
<!-- convertborder later -->
426
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-wont-merge-away.png" lightbox="media/workbooks-create-workbook/workbooks-groups-wont-merge-away.png" alt-text="Screenshot of a group item with the result of parameters merged away." border="false":::
423
427
424
428
When the group's item's template is loaded, the **TimeRange** parameter is merged out of the group. The workbook contains the initial parameters step with **TimeRange** and **Filter**, and the group's parameter only includes **FilterB**.
425
-
426
-
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-wont-merge-away-result.png" alt-text="Screenshot of workbook group where parameters won't merge away.":::
429
+
<!-- convertborder later -->
430
+
:::image type="content" source="media/workbooks-create-workbook/workbooks-groups-wont-merge-away-result.png" lightbox="media/workbooks-create-workbook/workbooks-groups-wont-merge-away-result.png" alt-text="Screenshot of workbook group where parameters won't merge away." border="false":::
427
431
428
432
If the loaded template had contained **TimeRange** and **Filter** (instead of **FilterB**), then the resulting workbook would have a parameters step and a group with only the text step remaining.
0 commit comments