az monitor app-insights component favorite
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 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 sharedRequired Parameters
The Id of a specific favorite defined in the Application Insights component.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Application Insights component resource.
Optional Parameters
Favorite category, as defined by the user at creation time.
Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON.
Internally assigned unique id of the favorite definition.
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.
Flag denoting wether or not this favorite was generated from a template.
The source of the favorite definition.
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.
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.
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 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-nameRequired Parameters
Optional 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 Id of a specific favorite defined in the Application Insights component.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Application Insights component resource.
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 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
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Application Insights component resource.
Optional Parameters
Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites.
The type of favorite. Value can be either shared or user.
Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum).
Tags that must be present on each favorite 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 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-nameRequired Parameters
Optional 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 Id of a specific favorite defined in the Application Insights component.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Application Insights component resource.
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 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]Required Parameters
Optional 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>.
Favorite category, as defined by the user at creation time.
Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON.
Internally assigned unique id of the favorite definition.
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.
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.
Flag denoting wether or not this favorite was generated from a template.
The Id of a specific favorite defined in the Application Insights component.
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>.
The name of the Application Insights component resource.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
The source of the favorite definition.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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.
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.
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.
