Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az sentinel onboarding-state

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 --sentinel-onboarding-state-name
 --resource-group
 --workspace-name
 [--acquire-policy-token]
 [--change-reference]
 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--customer-managed-key

Flag that indicates the status of the CMK setting.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--etag

Etag of the azure resource.

Property Value
Parameter group: SentinelOnboardingStateParameter Arguments

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 [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name --sentinel-onboarding-state-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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
--name --sentinel-onboarding-state-name -n

The Sentinel onboarding state name. Supports - default.

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

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.

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

The Sentinel onboarding state name. Supports - default.

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

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 [--acquire-policy-token]
 [--add]
 [--change-reference]
 [--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 --sentinel-onboarding-state-name]
 [--remove]
 [--resource-group]
 [--set]
 [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--customer-managed-key

Flag that indicates the status of the CMK setting.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--etag

Etag of the azure resource.

Property Value
Parameter group: SentinelOnboardingStateParameter 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
--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 --sentinel-onboarding-state-name -n

The Sentinel onboarding state name. Supports - default.

Property Value
Parameter group: Resource Id 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
--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
--workspace-name -w
Experimental

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments

Feedback

Was this page helpful?