sentinel_onboarding_states

Creates, updates, deletes, gets or lists a sentinel_onboarding_states resource.

Overview

Name	sentinel_onboarding_states
Type	Resource
Id	azure.security_insight.sentinel_onboarding_states

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customerManagedKey	boolean	Flag that indicates the status of the CMK setting.
etag	string	Etag of the azure resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customerManagedKey	boolean	Flag that indicates the status of the CMK setting.
etag	string	Etag of the azure resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, sentinel_onboarding_state_name, subscription_id		Get Sentinel onboarding state.
list	select	resource_group_name, workspace_name, subscription_id		Gets all Sentinel onboarding states.
create	insert	resource_group_name, workspace_name, sentinel_onboarding_state_name, subscription_id		Create Sentinel onboarding state.
delete	delete	resource_group_name, workspace_name, sentinel_onboarding_state_name, subscription_id		Delete Sentinel onboarding state.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sentinel_onboarding_state_name	string	The Sentinel onboarding state name. Supports - default. Required.
subscription_id	string
workspace_name	string	The name of the monitor workspace. Required.

SELECT examples

get

Get Sentinel onboarding state.

SELECT
id,
name,
customerManagedKey,
etag,
systemData,
type
FROM azure.security_insight.sentinel_onboarding_states
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sentinel_onboarding_state_name = '{{ sentinel_onboarding_state_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all Sentinel onboarding states.

SELECT
id,
name,
customerManagedKey,
etag,
systemData,
type
FROM azure.security_insight.sentinel_onboarding_states
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Sentinel onboarding state.

INSERT INTO azure.security_insight.sentinel_onboarding_states (
properties,
etag,
resource_group_name,
workspace_name,
sentinel_onboarding_state_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sentinel_onboarding_state_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sentinel_onboarding_states
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sentinel_onboarding_states resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sentinel_onboarding_states resource.
  - name: sentinel_onboarding_state_name
    value: "{{ sentinel_onboarding_state_name }}"
    description: Required parameter for the sentinel_onboarding_states resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sentinel_onboarding_states resource.
  - name: properties
    description: |
      The Sentinel onboarding state object.
    value:
      customerManagedKey: {{ customerManagedKey }}
  - name: etag
    value: "{{ etag }}"
    description: |
      Etag of the azure resource.

DELETE examples

delete

Delete Sentinel onboarding state.

DELETE FROM azure.security_insight.sentinel_onboarding_states
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sentinel_onboarding_state_name = '{{ sentinel_onboarding_state_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;