source_controls

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

Overview

Name	source_controls
Type	Resource
Id	azure.sentinel.source_controls

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
etag	string	Etag of the azure resource
properties	object	source control properties

list

Name	Datatype	Description
etag	string	Etag of the azure resource
properties	object	source control properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sourceControlId		Gets a source control byt its identifier.
list	select	subscriptionId, resourceGroupName, workspaceName		Gets all source controls, without source control items.
create	insert	subscriptionId, resourceGroupName, workspaceName, sourceControlId, data__properties		Creates a source control.
delete	exec	subscriptionId, resourceGroupName, workspaceName, sourceControlId, repositoryAccess		Delete a source control.

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.
sourceControlId	string	Source control Id
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a source control byt its identifier.

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

list

Gets all source controls, without source control items.

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

INSERT examples

create

Creates a source control.

INSERT INTO azure.sentinel.source_controls (
data__etag,
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sourceControlId
)
SELECT 
'{{ etag }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sourceControlId }}'
RETURNING
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: source_controls
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the source_controls resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the source_controls resource.
    - name: workspaceName
      value: string
      description: Required parameter for the source_controls resource.
    - name: sourceControlId
      value: string
      description: Required parameter for the source_controls resource.
    - name: etag
      value: string
      description: |
        Etag of the azure resource
    - name: properties
      value: object
      description: |
        source control properties

Lifecycle Methods

delete

Delete a source control.

EXEC azure.sentinel.source_controls.delete 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@sourceControlId='{{ sourceControlId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;