Share via

az sentinel alert-rule action

  • Reference

Note

This reference is part of the sentinel extension for the Azure CLI (version 2.37.0 or higher). The extension will automatically install the first time you run an az sentinel alert-rule action command. Learn more about extensions.

Manage alert rule action with sentinel.

Commands

Name Description Type Status
az sentinel alert-rule action create

Create the action of alert rule.

 Extension Experimental
az sentinel alert-rule action delete

Delete the action of alert rule.

 Extension Experimental
az sentinel alert-rule action list

Get all actions of alert rule.

 Extension Experimental
az sentinel alert-rule action show

Get the action of alert rule.

 Extension Experimental
az sentinel alert-rule action update

Update the action of alert rule.

 Extension Experimental

az sentinel alert-rule action create

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the action of alert rule.

az sentinel alert-rule action create --action-name
                                     --resource-group
                                     --rule-name
                                     --workspace-name
                                     [--etag]
                                     [--logic-app-resource-id]
                                     [--trigger-uri]

Required Parameters

--action-name --name -n
Experimental

Name of action.

--resource-group -g

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

--rule-name
Experimental

Name of alert rule.

--workspace-name -w
Experimental

The name of the workspace.

Optional Parameters

--etag

Etag of the azure resource.

--logic-app-resource-id

Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.

--trigger-uri

Logic App Callback URL for this specific workflow.

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.

az sentinel alert-rule action delete

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the action of alert rule.

az sentinel alert-rule action delete [--action-name]
                                     [--ids]
                                     [--resource-group]
                                     [--rule-name]
                                     [--subscription]
                                     [--workspace-name]
                                     [--yes]

Optional Parameters

--action-name --name -n
Experimental

Name of action.

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

--rule-name
Experimental

Name of alert rule.

--subscription

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

--workspace-name -w
Experimental

The name of the workspace.

--yes -y

Do not prompt for confirmation.

Default value: False
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.

az sentinel alert-rule action list

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get all actions of alert rule.

az sentinel alert-rule action list --resource-group
                                   --rule-name
                                   --workspace-name

Required Parameters

--resource-group -g

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

--rule-name
Experimental

Name of alert rule.

--workspace-name -w
Experimental

The name of the workspace.

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.

az sentinel alert-rule action show

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the action of alert rule.

az sentinel alert-rule action show [--action-name]
                                   [--ids]
                                   [--resource-group]
                                   [--rule-name]
                                   [--subscription]
                                   [--workspace-name]

Optional Parameters

--action-name --name -n
Experimental

Name of action.

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

--rule-name
Experimental

Name of alert rule.

--subscription

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

--workspace-name -w
Experimental

The name of the workspace.

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.

az sentinel alert-rule action update

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the action of alert rule.

az sentinel alert-rule action update [--action-name]
                                     [--add]
                                     [--etag]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--logic-app-resource-id]
                                     [--remove]
                                     [--resource-group]
                                     [--rule-name]
                                     [--set]
                                     [--subscription]
                                     [--trigger-uri]
                                     [--workspace-name]

Optional Parameters

--action-name --name -n
Experimental

Name of action.

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

--etag

Etag of the azure resource.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--logic-app-resource-id

Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.

--remove

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

--resource-group -g

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

--rule-name
Experimental

Name of alert rule.

--set

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

--subscription

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

--trigger-uri

Logic App Callback URL for this specific workflow.

--workspace-name -w
Experimental

The name of the workspace.

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.