az monitor app-insights my-workbook

Reference

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 my-workbook command. Learn more about extensions.

Manage my-workbook.

Commands

Name	Description	Type	Status
az monitor app-insights my-workbook list	List all private workbooks defined within a specified subscription and category.	Extension	GA

az monitor app-insights my-workbook list

List all private workbooks defined within a specified subscription and category.

az monitor app-insights my-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 my workbook

az monitor app-insights my-workbook list  -g rg --category retention

Required Parameters

--category

Category of workbook to return.

Accepted values: TSG, performance, retention, workbook

Optional Parameters

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

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.

--next-token

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

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via