data_connectors

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

Overview

Name	data_connectors
Type	Resource
Id	azure.sentinel.data_connectors

Fields

The following fields are returned by SELECT queries:

get

OK, Operation successfully completed

Name	Datatype	Description
etag	string	Etag of the azure resource
kind	string	The data connector kind

list

OK, Operation successfully completed

Name	Datatype	Description
etag	string	Etag of the azure resource
kind	string	The data connector kind

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, dataConnectorId		Gets a data connector.
list	select	subscriptionId, resourceGroupName, workspaceName		Gets all data connectors.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, dataConnectorId, data__kind		Creates or updates the data connector.
delete	delete	subscriptionId, resourceGroupName, workspaceName, dataConnectorId		Delete the data connector.

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
dataConnectorId	string	Connector ID
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a data connector.

SELECT
etag,
kind
FROM azure.sentinel.data_connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND dataConnectorId = '{{ dataConnectorId }}' -- required
;

list

Gets all data connectors.

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

INSERT examples

create_or_update

Creates or updates the data connector.

INSERT INTO azure.sentinel.data_connectors (
data__etag,
data__kind,
subscriptionId,
resourceGroupName,
workspaceName,
dataConnectorId
)
SELECT 
'{{ etag }}',
'{{ kind }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ dataConnectorId }}'
RETURNING
etag,
kind
;

Manifest

# Description fields are for documentation purposes
- name: data_connectors
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_connectors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_connectors resource.
    - name: workspaceName
      value: string
      description: Required parameter for the data_connectors resource.
    - name: dataConnectorId
      value: string
      description: Required parameter for the data_connectors resource.
    - name: etag
      value: string
      description: |
        Etag of the azure resource
    - name: kind
      value: string
      description: |
        The data connector kind
      valid_values: ['AzureActiveDirectory', 'AzureSecurityCenter', 'MicrosoftCloudAppSecurity', 'ThreatIntelligence', 'Office365', 'AmazonWebServicesCloudTrail', 'AzureAdvancedThreatProtection', 'MicrosoftDefenderAdvancedThreatProtection']

DELETE examples

delete

Delete the data connector.

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