az monitor action-group
Manage action groups.
Commands
az monitor action-group create |
Create a new action group. |
az monitor action-group delete |
Delete an action group. |
az monitor action-group enable-receiver |
Enable a receiver in an action group. |
az monitor action-group list |
List action groups under a resource group or the current subscription. |
az monitor action-group show |
Show the details of an action group. |
az monitor action-group update |
Update an action group. |
az monitor action-group create
Create a new action group.
az monitor action-group create --name
--resource-group
[--action]
[--short-name]
[--subscription]
[--tags]
Examples
Create a new action group (autogenerated)
az monitor action-group create --action webhook https://alerts.contoso.com apiKey={APIKey} type=HighCPU --name MyActionGroup --resource-group MyResourceGroup
Required Parameters
The name of the action group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Add receivers to the action group during the creation.
The short name of the action group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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.
Increase logging verbosity. Use --debug for full debug logs.
az monitor action-group delete
Delete an action group.
az monitor action-group delete [--ids]
[--name]
[--resource-group]
[--subscription]
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 name of the action group.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az monitor action-group enable-receiver
Enable a receiver in an action group.
This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.
az monitor action-group enable-receiver --name
[--action-group]
[--ids]
[--resource-group]
[--subscription]
Required Parameters
The name of the receiver to resubscribe.
Optional Parameters
The name of the action group.
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.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az monitor action-group list
List action groups under a resource group or the current subscription.
az monitor action-group list [--query-examples]
[--resource-group]
[--subscription]
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name of the resource group under which the action groups are being listed. If it is omitted, all the action groups under the current subscription are listed.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az monitor action-group show
Show the details of an action group.
az monitor action-group show [--ids]
[--name]
[--query-examples]
[--resource-group]
[--subscription]
Examples
Show the details of an action group (commonly used with --output and --query). (autogenerated)
az monitor action-group show --name MyActionGroup --resource-group MyResourceGroup
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 name of the action group.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az monitor action-group update
Update an action group.
az monitor action-group update [--add]
[--add-action]
[--force-string]
[--ids]
[--name]
[--remove]
[--remove-action]
[--resource-group]
[--set]
[--short-name]
[--subscription]
[--tags]
Examples
Update an action group (autogenerated)
az monitor action-group update --name MyActionGroup --resource-group MyResourceGroup --set retentionPolicy.days=365 --subscription MySubscription
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>.
Add receivers to the action group.
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 name of the action group.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Remove receivers from the action group. Accept space-separated list of receiver names.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Update the group short name of the action group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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.
Increase logging verbosity. Use --debug for full debug logs.