az sentinel onboarding-state

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

Manage onboarding state with sentinel.

Commands

Name Description Type Status
az sentinel onboarding-state create

Create Sentinel onboarding state.

 Extension Experimental
az sentinel onboarding-state delete

Delete Sentinel onboarding state.

 Extension Experimental
az sentinel onboarding-state list

Get all Sentinel onboarding states.

 Extension Experimental
az sentinel onboarding-state show

Get Sentinel onboarding state.

 Extension Experimental
az sentinel onboarding-state update

Update Sentinel onboarding state.

 Extension Experimental

az sentinel onboarding-state create

Experimental

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

Create Sentinel onboarding state.

az sentinel onboarding-state create --name
                                    --resource-group
                                    --workspace-name
                                    [--customer-managed-key {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--etag]

Required Parameters

--name --sentinel-onboarding-state-name -n

The Sentinel onboarding state name. Supports - default.

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

--customer-managed-key

Flag that indicates the status of the CMK setting.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--etag

Etag of the azure resource.

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 onboarding-state delete

Experimental

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

Delete Sentinel onboarding state.

az sentinel onboarding-state 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 --sentinel-onboarding-state-name -n

The Sentinel onboarding state name. Supports - default.

--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 onboarding-state list

Experimental

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

Get all Sentinel onboarding states.

az sentinel onboarding-state 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 onboarding-state show

Experimental

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

Get Sentinel onboarding state.

az sentinel onboarding-state 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 --sentinel-onboarding-state-name -n

The Sentinel onboarding state name. Supports - default.

--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 onboarding-state update

Experimental

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

Update Sentinel onboarding state.

az sentinel onboarding-state update [--add]
                                    [--customer-managed-key {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--etag]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--name]
                                    [--remove]
                                    [--resource-group]
                                    [--set]
                                    [--subscription]
                                    [--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>.

--customer-managed-key

Flag that indicates the status of the CMK setting.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 --sentinel-onboarding-state-name -n

The Sentinel onboarding state name. Supports - default.

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

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