onboarding_states

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

Overview

Name	onboarding_states
Type	Resource
Id	azure.sentinel.onboarding_states

Fields

The following fields are returned by SELECT queries:

get

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

list

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sentinelOnboardingStateName		Get Sentinel onboarding state
list	select	subscriptionId, resourceGroupName, workspaceName		Gets all Sentinel onboarding states
create	insert	subscriptionId, resourceGroupName, workspaceName, sentinelOnboardingStateName		Create Sentinel onboarding state
delete	delete	subscriptionId, resourceGroupName, workspaceName, sentinelOnboardingStateName		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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sentinelOnboardingStateName	string	The Sentinel onboarding state name. Supports - default
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get Sentinel onboarding state

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

list

Gets all Sentinel onboarding states

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

INSERT examples

create

Create Sentinel onboarding state

INSERT INTO azure.sentinel.onboarding_states (
data__etag,
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sentinelOnboardingStateName
)
SELECT 
'{{ etag }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sentinelOnboardingStateName }}'
RETURNING
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: onboarding_states
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the onboarding_states resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the onboarding_states resource.
    - name: workspaceName
      value: string
      description: Required parameter for the onboarding_states resource.
    - name: sentinelOnboardingStateName
      value: string
      description: Required parameter for the onboarding_states resource.
    - name: etag
      value: string
      description: |
        Etag of the azure resource
    - name: properties
      value: object
      description: |
        The Sentinel onboarding state object

DELETE examples

delete

Delete Sentinel onboarding state

DELETE FROM azure.sentinel.onboarding_states
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND sentinelOnboardingStateName = '{{ sentinelOnboardingStateName }}' --required
;