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

OK response definition.

Name	Datatype	Description
etag	string	The ETag of the data source.
kind	string	The kind of the DataSource.
properties	object	The data source properties in raw json format, each kind of data source have it's own schema.
tags	object	Resource tags.

list_by_workspace

OK response definition.

Name	Datatype	Description
etag	string	The ETag of the data source.
kind	string	The kind of the DataSource.
properties	object	The data source properties in raw json format, each kind of data source have it's own schema.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, workspaceName, dataSourceName, subscriptionId		Gets a datasource instance.
list_by_workspace	select	resourceGroupName, workspaceName, $filter, subscriptionId	$skiptoken	Gets the first page of data source instances in a workspace with the link to the next page.
create_or_update	insert	resourceGroupName, workspaceName, dataSourceName, subscriptionId, data__kind, data__properties		Create or update a data source.
delete	delete	resourceGroupName, workspaceName, dataSourceName, subscriptionId		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.
dataSourceName	string	Name of the datasource.
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.
$skiptoken	string	Starting point of the collection of data source instances.

SELECT examples

get

Gets a datasource instance.

SELECT
etag,
kind,
properties,
tags
FROM azure.log_analytics.data_sources
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND dataSourceName = '{{ dataSourceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_workspace

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

SELECT
etag,
kind,
properties,
tags
FROM azure.log_analytics.data_sources
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND $filter = '{{ $filter }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Create or update a data source.

INSERT INTO azure.log_analytics.data_sources (
data__properties,
data__etag,
data__kind,
data__tags,
resourceGroupName,
workspaceName,
dataSourceName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ etag }}',
'{{ kind }}' /* required */,
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ dataSourceName }}',
'{{ subscriptionId }}'
RETURNING
etag,
kind,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: data_sources
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_sources resource.
    - name: workspaceName
      value: string
      description: Required parameter for the data_sources resource.
    - name: dataSourceName
      value: string
      description: Required parameter for the data_sources resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the data_sources resource.
    - name: properties
      value: object
      description: |
        The data source properties in raw json format, each kind of data source have it's own schema.
    - name: etag
      value: string
      description: |
        The ETag of the data source.
    - name: kind
      value: string
      description: |
        The kind of the DataSource.
      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: object
      description: |
        Resource tags.

DELETE examples

delete

Deletes a data source instance.

DELETE FROM azure.log_analytics.data_sources
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND dataSourceName = '{{ dataSourceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;