az monitor app-insights workbook

Note

This reference is part of the application-insights extension for the Azure CLI (version 2.71.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-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 workbookname

Required Parameters

--name --resource-name -n

The name of the workbook resource. The value must be an UUID.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--category

Workbook category, as defined by the user at creation time.

Property	Value
Parameter group:	Properties Arguments

--description

The description of the workbook.

Property	Value
Parameter group:	Properties Arguments

--display-name

The user-defined name (display name) of the workbook.

Property	Value
Parameter group:	Properties Arguments

--kind

The kind of workbook. Only valid value is shared.

Property	Value
Parameter group:	WorkbookProperties Arguments
Accepted values:	shared

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	WorkbookProperties Arguments

--mi-system-assigned

Enable system assigned identity.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--mi-user-assigned

Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--serialized-data

Configuration of this particular workbook. Configuration data is a string containing valid JSON.

Property	Value
Parameter group:	Properties Arguments

--source-id

Azure Resource Id that will fetch all linked workbooks.

--storage-uri

The resourceId to the storage account when bring your own storage is used.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	WorkbookProperties Arguments

--version

Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az monitor app-insights workbook delete

Delete a workbook.

az monitor app-insights workbook delete [--ids]
                                        [--name --resource-name]
                                        [--resource-group]
                                        [--subscription]
                                        [--yes]

Examples

Delete workbook

az monitor app-insights workbook delete -n 00000000-0000-0000-0000-000000000000 -g wktest

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--name --resource-name -n

The name of the workbook resource. The value must be an UUID.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 workbook

Required Parameters

--category

Category of workbook to return.

Property	Value
Accepted values:	TSG, performance, retention, workbook

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--can-fetch-content

Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--max-items

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.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--source-id

Azure Resource Id that will fetch all linked workbooks.

--tags

Tags presents on each workbook returned. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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-name]
                                      [--resource-group]
                                      [--subscription]

Examples

Show workbook

az monitor app-insights workbook show -n 00000000-0000-0000-0000-000000000000 -g wktest

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--can-fetch-content

Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--name --resource-name -n

The name of the workbook resource. The value must be an UUID.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 --resource-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=test

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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>.

Property	Value
Parameter group:	Generic Update Arguments

--category

Workbook category, as defined by the user at creation time.

Property	Value
Parameter group:	Properties Arguments

--description

The description of the workbook.

Property	Value
Parameter group:	Properties Arguments

--display-name

The user-defined name (display name) of the workbook.

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--kind

The kind of workbook. Only valid value is shared.

Property	Value
Parameter group:	WorkbookProperties Arguments
Accepted values:	shared

--name --resource-name -n

The name of the workbook resource. The value must be an UUID.

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--serialized-data

Configuration of this particular workbook. Configuration data is a string containing valid JSON.

Property	Value
Parameter group:	Properties Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--source-id

Azure Resource Id that will fetch all linked workbooks.

--storage-uri

The resourceId to the storage account when bring your own storage is used.

Property	Value
Parameter group:	Properties Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	WorkbookProperties Arguments

--version

Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False