data_connector_definitions

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

Overview

Name	data_connector_definitions
Type	Resource
Id	azure.security_insight.data_connector_definitions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	Etag of the azure resource.
kind	string	Metadata 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. "Customizable"
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	Etag of the azure resource.
kind	string	Metadata 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. "Customizable"
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, data_connector_definition_name, subscription_id		Gets a data connector definition.
list	select	resource_group_name, workspace_name, subscription_id		Gets all data connector definitions.
create_or_update	insert	resource_group_name, workspace_name, data_connector_definition_name, subscription_id, kind		Creates or updates the data connector definition.
create_or_update	replace	resource_group_name, workspace_name, data_connector_definition_name, subscription_id, kind		Creates or updates the data connector definition.
delete	delete	resource_group_name, workspace_name, data_connector_definition_name, subscription_id		Delete the data connector definition.

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
data_connector_definition_name	string	The data connector definition name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the monitor workspace. Required.

SELECT examples

get

Gets a data connector definition.

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

list

Gets all data connector definitions.

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

INSERT examples

create_or_update

Creates or updates the data connector definition.

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

Manifest

# Description fields are for documentation purposes
- name: data_connector_definitions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_connector_definitions resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the data_connector_definitions resource.
  - name: data_connector_definition_name
    value: "{{ data_connector_definition_name }}"
    description: Required parameter for the data_connector_definitions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_connector_definitions resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Metadata 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. "Customizable"
  - name: etag
    value: "{{ etag }}"
    description: |
      Etag of the azure resource.

REPLACE examples

create_or_update

Creates or updates the data connector definition.

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

DELETE examples

delete

Delete the data connector definition.

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