onboarding_states

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

Overview

Name	onboarding_states
Type	Resource
Id	azure.sentinel.onboarding_states

Fields

vw_onboarding_states

Name	Datatype	Description
customer_managed_key	text	field from the properties object
etag	text	Etag of the azure resource
resourceGroupName	text	field from the properties object
sentinelOnboardingStateName	text	field from the properties object
subscriptionId	text	field from the properties object
workspaceName	text	field from the properties object

onboarding_states

Name	Datatype	Description
etag	string	Etag of the azure resource
properties	object	The Sentinel onboarding state properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, sentinelOnboardingStateName, subscriptionId, workspaceName	Get Sentinel onboarding state
list	SELECT	resourceGroupName, subscriptionId, workspaceName	Gets all Sentinel onboarding states
create	INSERT	resourceGroupName, sentinelOnboardingStateName, subscriptionId, workspaceName	Create Sentinel onboarding state
delete	DELETE	resourceGroupName, sentinelOnboardingStateName, subscriptionId, workspaceName	Delete Sentinel onboarding state

SELECT examples

Gets all Sentinel onboarding states

vw_onboarding_states

SELECT
customer_managed_key,
etag,
resourceGroupName,
sentinelOnboardingStateName,
subscriptionId,
workspaceName
FROM azure.sentinel.vw_onboarding_states
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

onboarding_states

SELECT
etag,
properties
FROM azure.sentinel.onboarding_states
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

Use the following StackQL query and manifest file to create a new onboarding_states resource.

All Properties

/*+ create */
INSERT INTO azure.sentinel.onboarding_states (
resourceGroupName,
sentinelOnboardingStateName,
subscriptionId,
workspaceName,
etag,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ sentinelOnboardingStateName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ etag }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: etag
      value: string
    - name: properties
      value:
        - name: customerManagedKey
          value: boolean

DELETE example

Deletes the specified onboarding_states resource.

/*+ delete */
DELETE FROM azure.sentinel.onboarding_states
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND sentinelOnboardingStateName = '{{ sentinelOnboardingStateName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';