data_sources

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

Overview

Name	data_sources
Type	Resource
Id	azure.log_analytics.data_sources

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	The ETag of the data source.
kind	string	The kind of the DataSource. Required. Known values are: "WindowsEvent", "WindowsPerformanceCounter", "IISLogs", "LinuxSyslog", "LinuxSyslogCollection", "LinuxPerformanceObject", "LinuxPerformanceCollection", "CustomLog", "CustomLogCollection", "AzureAuditLog", "AzureActivityLog", "GenericDataSource", "ChangeTrackingCustomPath", "ChangeTrackingPath", "ChangeTrackingServices", "ChangeTrackingDataTypeConfiguration", "ChangeTrackingDefaultRegistry", "ChangeTrackingRegistry", "ChangeTrackingLinuxPath", "LinuxChangeTrackingPath", "ChangeTrackingContentLocation", "WindowsTelemetry", "Office365", "SecurityWindowsBaselineConfiguration", "SecurityCenterSecurityWindowsBaselineConfiguration", "SecurityEventCollectionConfiguration", "SecurityInsightsSecurityEventCollectionConfiguration", "ImportComputerGroup", "NetworkMonitoring", "Itsm", "DnsAnalytics", "ApplicationInsights", and "SqlDataClassification". (WindowsEvent, WindowsPerformanceCounter, IISLogs, LinuxSyslog, LinuxSyslogCollection, LinuxPerformanceObject, LinuxPerformanceCollection, CustomLog, CustomLogCollection, AzureAuditLog, AzureActivityLog, GenericDataSource, ChangeTrackingCustomPath, ChangeTrackingPath, ChangeTrackingServices, ChangeTrackingDataTypeConfiguration, ChangeTrackingDefaultRegistry, ChangeTrackingRegistry, ChangeTrackingLinuxPath, LinuxChangeTrackingPath, ChangeTrackingContentLocation, WindowsTelemetry, Office365, SecurityWindowsBaselineConfiguration, SecurityCenterSecurityWindowsBaselineConfiguration, SecurityEventCollectionConfiguration, SecurityInsightsSecurityEventCollectionConfiguration, ImportComputerGroup, NetworkMonitoring, Itsm, DnsAnalytics, ApplicationInsights, SqlDataClassification)
properties	object	The data source properties in raw json format, each kind of data source have it's own schema. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

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	The ETag of the data source.
kind	string	The kind of the DataSource. Required. Known values are: "WindowsEvent", "WindowsPerformanceCounter", "IISLogs", "LinuxSyslog", "LinuxSyslogCollection", "LinuxPerformanceObject", "LinuxPerformanceCollection", "CustomLog", "CustomLogCollection", "AzureAuditLog", "AzureActivityLog", "GenericDataSource", "ChangeTrackingCustomPath", "ChangeTrackingPath", "ChangeTrackingServices", "ChangeTrackingDataTypeConfiguration", "ChangeTrackingDefaultRegistry", "ChangeTrackingRegistry", "ChangeTrackingLinuxPath", "LinuxChangeTrackingPath", "ChangeTrackingContentLocation", "WindowsTelemetry", "Office365", "SecurityWindowsBaselineConfiguration", "SecurityCenterSecurityWindowsBaselineConfiguration", "SecurityEventCollectionConfiguration", "SecurityInsightsSecurityEventCollectionConfiguration", "ImportComputerGroup", "NetworkMonitoring", "Itsm", "DnsAnalytics", "ApplicationInsights", and "SqlDataClassification". (WindowsEvent, WindowsPerformanceCounter, IISLogs, LinuxSyslog, LinuxSyslogCollection, LinuxPerformanceObject, LinuxPerformanceCollection, CustomLog, CustomLogCollection, AzureAuditLog, AzureActivityLog, GenericDataSource, ChangeTrackingCustomPath, ChangeTrackingPath, ChangeTrackingServices, ChangeTrackingDataTypeConfiguration, ChangeTrackingDefaultRegistry, ChangeTrackingRegistry, ChangeTrackingLinuxPath, LinuxChangeTrackingPath, ChangeTrackingContentLocation, WindowsTelemetry, Office365, SecurityWindowsBaselineConfiguration, SecurityCenterSecurityWindowsBaselineConfiguration, SecurityEventCollectionConfiguration, SecurityInsightsSecurityEventCollectionConfiguration, ImportComputerGroup, NetworkMonitoring, Itsm, DnsAnalytics, ApplicationInsights, SqlDataClassification)
properties	object	The data source properties in raw json format, each kind of data source have it's own schema. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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_source_name, subscription_id		Gets a datasource instance.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id, $filter	$skiptoken	Gets the first page of data source instances in a workspace with the link to the next page.
create_or_update	insert	resource_group_name, workspace_name, data_source_name, subscription_id, properties, kind		Create or update a data source.
create_or_update	replace	resource_group_name, workspace_name, data_source_name, subscription_id, properties, kind		Create or update a data source.
delete	delete	resource_group_name, workspace_name, data_source_name, subscription_id		Deletes a data source instance.

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
$filter	string	The filter to apply on the operation. Required.
data_source_name	string	Name of the datasource. 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 workspace. Required.
$skiptoken	string	Starting point of the collection of data source instances. Default value is None.

SELECT examples

get

Gets a datasource instance.

SELECT
id,
name,
etag,
kind,
properties,
systemData,
tags,
type
FROM azure.log_analytics.data_sources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND data_source_name = '{{ data_source_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Gets the first page of data source instances in a workspace with the link to the next page.

SELECT
id,
name,
etag,
kind,
properties,
systemData,
tags,
type
FROM azure.log_analytics.data_sources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Create or update a data source.

INSERT INTO azure.log_analytics.data_sources (
properties,
etag,
kind,
tags,
resource_group_name,
workspace_name,
data_source_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ etag }}',
'{{ kind }}' /* required */,
'{{ tags }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ data_source_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_sources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_sources resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the data_sources resource.
  - name: data_source_name
    value: "{{ data_source_name }}"
    description: Required parameter for the data_sources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_sources resource.
  - name: properties
    value: "{{ properties }}"
    description: |
      The data source properties in raw json format, each kind of data source have it's own schema. Required.
  - name: etag
    value: "{{ etag }}"
    description: |
      The ETag of the data source.
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of the DataSource. Required. Known values are: "WindowsEvent", "WindowsPerformanceCounter", "IISLogs", "LinuxSyslog", "LinuxSyslogCollection", "LinuxPerformanceObject", "LinuxPerformanceCollection", "CustomLog", "CustomLogCollection", "AzureAuditLog", "AzureActivityLog", "GenericDataSource", "ChangeTrackingCustomPath", "ChangeTrackingPath", "ChangeTrackingServices", "ChangeTrackingDataTypeConfiguration", "ChangeTrackingDefaultRegistry", "ChangeTrackingRegistry", "ChangeTrackingLinuxPath", "LinuxChangeTrackingPath", "ChangeTrackingContentLocation", "WindowsTelemetry", "Office365", "SecurityWindowsBaselineConfiguration", "SecurityCenterSecurityWindowsBaselineConfiguration", "SecurityEventCollectionConfiguration", "SecurityInsightsSecurityEventCollectionConfiguration", "ImportComputerGroup", "NetworkMonitoring", "Itsm", "DnsAnalytics", "ApplicationInsights", and "SqlDataClassification".
    valid_values: ['WindowsEvent', 'WindowsPerformanceCounter', 'IISLogs', 'LinuxSyslog', 'LinuxSyslogCollection', 'LinuxPerformanceObject', 'LinuxPerformanceCollection', 'CustomLog', 'CustomLogCollection', 'AzureAuditLog', 'AzureActivityLog', 'GenericDataSource', 'ChangeTrackingCustomPath', 'ChangeTrackingPath', 'ChangeTrackingServices', 'ChangeTrackingDataTypeConfiguration', 'ChangeTrackingDefaultRegistry', 'ChangeTrackingRegistry', 'ChangeTrackingLinuxPath', 'LinuxChangeTrackingPath', 'ChangeTrackingContentLocation', 'WindowsTelemetry', 'Office365', 'SecurityWindowsBaselineConfiguration', 'SecurityCenterSecurityWindowsBaselineConfiguration', 'SecurityEventCollectionConfiguration', 'SecurityInsightsSecurityEventCollectionConfiguration', 'ImportComputerGroup', 'NetworkMonitoring', 'Itsm', 'DnsAnalytics', 'ApplicationInsights', 'SqlDataClassification']
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

REPLACE examples

create_or_update

Create or update a data source.

REPLACE azure.log_analytics.data_sources
SET 
properties = '{{ properties }}',
etag = '{{ etag }}',
kind = '{{ kind }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND data_source_name = '{{ data_source_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
etag,
kind,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a data source instance.

DELETE FROM azure.log_analytics.data_sources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND data_source_name = '{{ data_source_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;