az monitor app-insights component favorite

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 component favorite command. Learn more about extensions.

Manage component favorite.

Commands

Name	Description	Type	Status
az monitor app-insights component favorite create	Create a new favorites to an Application Insights component.	Extension	GA
az monitor app-insights component favorite delete	Delete a favorite that is associated to an Application Insights component.	Extension	GA
az monitor app-insights component favorite list	List a list of favorites defined within an Application Insights component.	Extension	GA
az monitor app-insights component favorite show	Get a single favorite by its FavoriteId, defined within an Application Insights component.	Extension	GA
az monitor app-insights component favorite update	Update a new favorites to an Application Insights component.	Extension	GA

az monitor app-insights component favorite create

Create a new favorites to an Application Insights component.

az monitor app-insights component favorite create --name
                                                  --resource-group
                                                  --resource-name
                                                  [--category]
                                                  [--config]
                                                  [--favorite-id]
                                                  [--favorite-type {shared, user}]
                                                  [--is-generated-from-template {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--source-type]
                                                  [--tags]
                                                  [--version]

Examples

Create favorite

az monitor app-insights component favorite create -g rg -n favorite-name --resource-name component-name --config 'myconfig' --version ME --favorite-id favorite-name --favorite-type shared

Required Parameters

--name -n

The Id of a specific favorite defined in the Application Insights component.

--resource-group -g

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

--resource-name

The name of the Application Insights component resource.

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

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

Property	Value
Parameter group:	FavoriteProperties Arguments

--config

Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON.

Property	Value
Parameter group:	FavoriteProperties Arguments

--favorite-id

Internally assigned unique id of the favorite definition.

Property	Value
Parameter group:	FavoriteProperties Arguments

--favorite-type

Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.

Property	Value
Parameter group:	FavoriteProperties Arguments
Accepted values:	shared, user

--is-generated-from-template

Flag denoting wether or not this favorite was generated from a template.

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

--source-type

The source of the favorite definition.

Property	Value
Parameter group:	FavoriteProperties Arguments

--tags

A list of 0 or more tags that are associated with this favorite definition Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	FavoriteProperties Arguments

--version

This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.

Property	Value
Parameter group:	FavoriteProperties 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 component favorite delete

Delete a favorite that is associated to an Application Insights component.

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

Examples

Delete favorite

az monitor app-insights component favorite delete -g rg -n favorite-name --resource-name component-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.

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

The Id of a specific favorite defined in the Application Insights component.

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

--resource-name

The name of the Application Insights component resource.

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 component favorite list

List a list of favorites defined within an Application Insights component.

az monitor app-insights component favorite list --resource-group
                                                --resource-name
                                                [--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--favorite-type {shared, user}]
                                                [--source-type {events, funnel, impact, notebook, retention, segmentation, sessions, userflows}]
                                                [--tags]

Examples

List favorite

az monitor app-insights component favorite list -g rg --resource-name component-name --favorite-type shared --tags [tag]

Required Parameters

--resource-group -g

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

--resource-name

The name of the Application Insights component resource.

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 favorite. If false, only return summary content for favorites.

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

--favorite-type

The type of favorite. Value can be either shared or user.

Property	Value
Default value:	shared
Accepted values:	shared, user

--source-type

Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum).

Property	Value
Accepted values:	events, funnel, impact, notebook, retention, segmentation, sessions, userflows

--tags

Tags that must be present on each favorite 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 component favorite show

Get a single favorite by its FavoriteId, defined within an Application Insights component.

az monitor app-insights component favorite show [--ids]
                                                [--name]
                                                [--resource-group]
                                                [--resource-name]
                                                [--subscription]

Examples

Show favorite

az monitor app-insights component favorite show -g rg -n favorite-name --resource-name component-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.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The Id of a specific favorite defined in the Application Insights component.

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

--resource-name

The name of the Application Insights component resource.

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 component favorite update

Update a new favorites to an Application Insights component.

az monitor app-insights component favorite update [--add]
                                                  [--category]
                                                  [--config]
                                                  [--favorite-id]
                                                  [--favorite-type {shared, user}]
                                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--ids]
                                                  [--is-generated-from-template {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--name]
                                                  [--remove]
                                                  [--resource-group]
                                                  [--resource-name]
                                                  [--set]
                                                  [--source-type]
                                                  [--subscription]
                                                  [--tags]
                                                  [--version]

Examples

Update favorite

az monitor app-insights component favorite update -g rg -n favorite-name --resource-name component-name --config 'myconfig' --version ME --favorite-id favorite-name --favorite-type shared --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

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

Property	Value
Parameter group:	FavoriteProperties Arguments

--config

Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON.

Property	Value
Parameter group:	FavoriteProperties Arguments

--favorite-id

Internally assigned unique id of the favorite definition.

Property	Value
Parameter group:	FavoriteProperties Arguments

--favorite-type

Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.

Property	Value
Parameter group:	FavoriteProperties Arguments
Accepted values:	shared, user

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

Property	Value
Parameter group:	Resource Id Arguments

--is-generated-from-template

Flag denoting wether or not this favorite was generated from a template.

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

--name -n

The Id of a specific favorite defined in the Application Insights component.

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

--resource-name

The name of the Application Insights component resource.

Property	Value
Parameter group:	Resource Id 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-type

The source of the favorite definition.

Property	Value
Parameter group:	FavoriteProperties 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

A list of 0 or more tags that are associated with this favorite definition Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	FavoriteProperties Arguments

--version

This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.

Property	Value
Parameter group:	FavoriteProperties 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

Share via

az monitor app-insights component favorite

Commands

az monitor app-insights component favorite create

Examples

Required Parameters

Optional Parameters

az monitor app-insights component favorite delete

Examples

Optional Parameters

az monitor app-insights component favorite list

Examples

Required Parameters

Optional Parameters

az monitor app-insights component favorite show

Examples

Optional Parameters

az monitor app-insights component favorite update

Examples

Optional Parameters

Feedback