Skip to main content

data_connectors

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

Overview​

Namedata_connectors
TypeResource
Idazure.security_insight.data_connectors

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
etagstringEtag of the azure resource.
kindstringMetadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. Required. Known values are: "AzureActiveDirectory", "AzureSecurityCenter", "MicrosoftCloudAppSecurity", "ThreatIntelligence", "ThreatIntelligenceTaxii", "Office365", "OfficeATP", "OfficeIRM", "Office365Project", "MicrosoftPurviewInformationProtection", "OfficePowerBI", "AmazonWebServicesCloudTrail", "AmazonWebServicesS3", "AzureAdvancedThreatProtection", "MicrosoftDefenderAdvancedThreatProtection", "Dynamics365", "MicrosoftThreatProtection", "MicrosoftThreatIntelligence", "PremiumMicrosoftDefenderForThreatIntelligence", "GenericUI", "APIPolling", "IOT", "GCP", "RestApiPoller", and "PurviewAudit".
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, workspace_name, data_connector_id, subscription_idGets a data connector.
listselectresource_group_name, workspace_name, subscription_idGets all data connectors.
create_or_updateinsertresource_group_name, workspace_name, data_connector_id, subscription_id, kindCreates or updates the data connector.
create_or_updatereplaceresource_group_name, workspace_name, data_connector_id, subscription_id, kindCreates or updates the data connector.
deletedeleteresource_group_name, workspace_name, data_connector_id, subscription_idDelete the data connector.
connectexecresource_group_name, workspace_name, data_connector_id, subscription_idConnects a data connector.
disconnectexecresource_group_name, workspace_name, data_connector_id, subscription_idDisconnect a 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.

NameDatatypeDescription
data_connector_idstringConnector ID. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
workspace_namestringThe name of the monitor workspace. Required.

SELECT examples​

Gets a data connector.

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

INSERT examples​

Creates or updates the data connector.

INSERT INTO azure.security_insight.data_connectors (
kind,
etag,
resource_group_name,
workspace_name,
data_connector_id,
subscription_id
)
SELECT 
'{{ kind }}' /* required */,
'{{ etag }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ data_connector_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
systemData,
type
;

REPLACE examples​

Creates or updates the data connector.

REPLACE azure.security_insight.data_connectors
SET 
kind = '{{ kind }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND data_connector_id = '{{ data_connector_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
etag,
kind,
systemData,
type;

DELETE examples​

Delete the data connector.

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

Lifecycle Methods​

Connects a data connector.

EXEC azure.security_insight.data_connectors.connect 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@data_connector_id='{{ data_connector_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"apiKey": "{{ apiKey }}", 
"dataCollectionEndpoint": "{{ dataCollectionEndpoint }}", 
"dataCollectionRuleImmutableId": "{{ dataCollectionRuleImmutableId }}", 
"outputStream": "{{ outputStream }}", 
"clientSecret": "{{ clientSecret }}", 
"clientId": "{{ clientId }}", 
"authorizationCode": "{{ authorizationCode }}", 
"userName": "{{ userName }}", 
"password": "{{ password }}", 
"requestConfigUserInputValues": "{{ requestConfigUserInputValues }}"
}'
;