az monitor action-group

  • Reference

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

Edit

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

--name -n

The name of the action group.

--resource-group -g

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

Optional Parameters

--action -a

Add receivers to the action group during the creation.

--short-name

The short name of the action group.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az monitor action-group delete

Edit

Delete an action group.

az monitor action-group delete [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

Optional Parameters

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

--name -n

The name of the action group.

--resource-group -g

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

--subscription

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

az monitor action-group enable-receiver

Edit

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

--name -n

The name of the receiver to resubscribe.

Optional Parameters

--action-group

The name of the action group.

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

--resource-group -g

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

--subscription

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

az monitor action-group list

Edit

List action groups under a resource group or the current subscription.

az monitor action-group list [--query-examples]
                             [--resource-group]
                             [--subscription]

Optional Parameters

--query-examples

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.

--resource-group -g

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.

--subscription

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

az monitor action-group show

Edit

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

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

--name -n

The name of the action group.

--query-examples

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.

--resource-group -g

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

--subscription

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

az monitor action-group update

Edit

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

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

Add receivers to the action group.

--force-string

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

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

--name -n

The name of the action group.

--remove

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

--remove-action -r

Remove receivers from the action group. Accept space-separated list of receiver names.

--resource-group -g

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

--set

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

--short-name

Update the group short name of the action group.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.