az sentinel alert-rule

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

Manage alert rule with sentinel.

Commands

Name	Description	Type	Status
az sentinel alert-rule action	Manage alert rule action with sentinel.	Extension	GA
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 create	Create the alert rule.	Extension	Experimental
az sentinel alert-rule delete	Delete the alert rule.	Extension	Experimental
az sentinel alert-rule list	Get all alert rules.	Extension	Experimental
az sentinel alert-rule show	Get the alert rule.	Extension	Experimental
az sentinel alert-rule template	Manage alert rule template with sentinel.	Extension	GA
az sentinel alert-rule template list	Get all alert rule templates.	Extension	Experimental
az sentinel alert-rule template show	Get the alert rule template.	Extension	Experimental
az sentinel alert-rule update	Update the alert rule.	Extension	Experimental

az sentinel alert-rule create

Experimental

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

Create the alert rule.

az sentinel alert-rule create --name --rule-name
                              --resource-group
                              --workspace-name
                              [--etag]
                              [--fusion]
                              [--ml-behavior-analytics]
                              [--ms-security-incident]
                              [--nrt]
                              [--scheduled]
                              [--threat-intelligence]

Required Parameters

--name --rule-name -n

Experimental

Name of alert rule.

--resource-group -g

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

--workspace-name -w

Experimental

The name of the workspace.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--etag

Etag of the azure resource.

Property	Value
Parameter group:	AlertRule Arguments

--fusion

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

--ml-behavior-analytics

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

--ms-security-incident

Experimental

Microsoft security incident creation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

--nrt

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

--scheduled

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

--threat-intelligence

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule 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 sentinel alert-rule delete

Experimental

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

Delete the alert rule.

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

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

Experimental

Name of alert rule.

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

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

--workspace-name -w

Experimental

The name of the workspace.

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 sentinel alert-rule list

Experimental

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

Get all alert rules.

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

Required Parameters

--resource-group -g

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

--workspace-name -w

Experimental

The name of the workspace.

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 sentinel alert-rule show

Experimental

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

Get the alert rule.

az sentinel alert-rule show [--ids]
                            [--name --rule-name]
                            [--resource-group]
                            [--subscription]
                            [--workspace-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 --rule-name -n

Experimental

Name of alert rule.

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

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

--workspace-name -w

Experimental

The name of the workspace.

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 sentinel alert-rule update

Experimental

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

Update the alert rule.

az sentinel alert-rule update [--add]
                              [--etag]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--fusion]
                              [--ids]
                              [--ml-behavior-analytics]
                              [--ms-security-incident]
                              [--name --rule-name]
                              [--nrt]
                              [--remove]
                              [--resource-group]
                              [--scheduled]
                              [--set]
                              [--subscription]
                              [--threat-intelligence]
                              [--workspace-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.

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

--etag

Etag of the azure resource.

Property	Value
Parameter group:	AlertRule Arguments

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

--fusion

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

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

--ml-behavior-analytics

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

--ms-security-incident

Experimental

Microsoft security incident creation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

--name --rule-name -n

Experimental

Name of alert rule.

Property	Value
Parameter group:	Resource Id Arguments

--nrt

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--scheduled

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

--threat-intelligence

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AlertRule Arguments

--workspace-name -w

Experimental

The name of the workspace.

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