az monitor app-insights workbook
Note
This reference is part of the application-insights extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az monitor app-insights workbook command. Learn more about extensions.
Manage app-insights workbook.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az monitor app-insights workbook create |
Create a workbook. |
Extension | GA |
| az monitor app-insights workbook delete |
Delete a workbook. |
Extension | GA |
| az monitor app-insights workbook identity |
Manage workbook idneity. |
Extension | GA |
| az monitor app-insights workbook identity assign |
Assign identities. |
Extension | GA |
| az monitor app-insights workbook identity remove |
Remove identities. |
Extension | GA |
| az monitor app-insights workbook list |
List all workbooks defined within a specified resource group and category. |
Extension | GA |
| az monitor app-insights workbook revision |
Manage workbook revision. |
Extension | GA |
| az monitor app-insights workbook revision list |
List the revisions for the workbook. |
Extension | GA |
| az monitor app-insights workbook revision show |
Show workbook revision. |
Extension | GA |
| az monitor app-insights workbook show |
Show a single workbook by its resource name. |
Extension | GA |
| az monitor app-insights workbook update |
Update a workbook. |
Extension | GA |
az monitor app-insights workbook create
Create a workbook.
az monitor app-insights workbook create --name
--resource-group
[--category]
[--description]
[--display-name]
[--kind {shared}]
[--location]
[--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
[--mi-user-assigned]
[--serialized-data]
[--source-id]
[--storage-uri]
[--tags]
[--version]Examples
Create workbook
az monitor app-insights workbook create -n 00000000-0000-0000-0000-000000000000 -g rg --serialized-data mydata --kind shared --category workbook --display-name workbooknameRequired Parameters
The name of the workbook resource. The value must be an UUID.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Workbook category, as defined by the user at creation time.
The description of the workbook.
The user-defined name (display name) of the workbook.
The kind of workbook. Only valid value is shared.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Enable system assigned identity.
Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Configuration of this particular workbook. Configuration data is a string containing valid JSON.
Azure Resource Id that will fetch all linked workbooks.
The resourceId to the storage account when bring your own storage is used.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor app-insights workbook delete
Delete a workbook.
az monitor app-insights workbook delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]Examples
Delete workbook
az monitor app-insights workbook delete -n 00000000-0000-0000-0000-000000000000 -g wktestOptional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the workbook resource. The value must be an UUID.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor app-insights workbook list
List all workbooks defined within a specified resource group and category.
az monitor app-insights workbook list --category {TSG, performance, retention, workbook}
[--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
[--max-items]
[--next-token]
[--resource-group]
[--source-id]
[--tags]Examples
List workbook
az monitor app-insights workbook list -g rg --category workbookRequired Parameters
Category of workbook to return.
Optional Parameters
Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Azure Resource Id that will fetch all linked workbooks.
Tags presents on each workbook returned. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor app-insights workbook show
Show a single workbook by its resource name.
az monitor app-insights workbook show [--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
Show workbook
az monitor app-insights workbook show -n 00000000-0000-0000-0000-000000000000 -g wktestOptional Parameters
Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the workbook resource. The value must be an UUID.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor app-insights workbook update
Update a workbook.
az monitor app-insights workbook update [--add]
[--category]
[--description]
[--display-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--kind {shared}]
[--name]
[--remove]
[--resource-group]
[--serialized-data]
[--set]
[--source-id]
[--storage-uri]
[--subscription]
[--tags]
[--version]Examples
Update workbook
az monitor app-insights workbook update -n 00000000-0000-0000-0000-000000000000 -g rg --tags tag=testOptional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Workbook category, as defined by the user at creation time.
The description of the workbook.
The user-defined name (display name) of the workbook.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The kind of workbook. Only valid value is shared.
The name of the workbook resource. The value must be an UUID.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Configuration of this particular workbook. Configuration data is a string containing valid JSON.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Azure Resource Id that will fetch all linked workbooks.
The resourceId to the storage account when bring your own storage is used.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for