az sentinel setting

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

Manage setting with sentinel.

Commands

Name Description Type Status
az sentinel setting create

Create setting.

 Extension Experimental
az sentinel setting delete

Delete setting of the product.

 Extension Experimental
az sentinel setting list

List of all the settings.

 Extension Experimental
az sentinel setting show

Get a setting.

 Extension Experimental
az sentinel setting update

Update setting.

 Extension Experimental

az sentinel setting create

Experimental

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

Create setting.

az sentinel setting create --name
                           --resource-group
                           --workspace-name
                           [--entity-analytics]
                           [--etag]
                           [--ueba]

Required Parameters

--name --settings-name -n

The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba.

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

--entity-analytics

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

--etag

Etag of the azure resource.

--ueba

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

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

Experimental

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

Delete setting of the product.

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

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

The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba.

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

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

Experimental

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

List of all the settings.

az sentinel setting 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.

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

Experimental

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

Get a setting.

az sentinel setting show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]
                         [--workspace-name]

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

The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba.

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

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

Experimental

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

Update setting.

az sentinel setting update [--add]
                           [--entity-analytics]
                           [--etag]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--subscription]
                           [--ueba]
                           [--workspace-name]

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

--entity-analytics

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

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

--name --settings-name -n

The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba.

--remove

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

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

--subscription

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

--ueba

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

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