data_collection_rules

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

Overview

Name	data_collection_rules
Type	Resource
Id	azure.monitor.data_collection_rules

Fields

The following fields are returned by SELECT queries:

get

Request completed successfully

Name	Datatype	Description
id	string	Fully qualified ID of the resource. (example: /subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule)
name	string	The name of the resource. (example: myCollectionRule)
etag	string	Resource entity tag (ETag).
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of the resource. (example: Linux)
location	string	The geo-location where the resource lives.
properties	object	Definition of what monitoring data to collect and where that data should be sent.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionRules)

list_by_resource_group

Request completed successfully

Name	Datatype	Description
id	string	Fully qualified ID of the resource. (example: /subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule)
name	string	The name of the resource. (example: myCollectionRule)
etag	string	Resource entity tag (ETag).
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of the resource. (example: Linux)
location	string	The geo-location where the resource lives.
properties	object	Definition of what monitoring data to collect and where that data should be sent.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionRules)

list_by_subscription

Request completed successfully

Name	Datatype	Description
id	string	Fully qualified ID of the resource. (example: /subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule)
name	string	The name of the resource. (example: myCollectionRule)
etag	string	Resource entity tag (ETag).
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of the resource. (example: Linux)
location	string	The geo-location where the resource lives.
properties	object	Definition of what monitoring data to collect and where that data should be sent.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionRules)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dataCollectionRuleName
list_by_resource_group	select	subscriptionId, resourceGroupName
list_by_subscription	select	subscriptionId
create	insert	subscriptionId, resourceGroupName, dataCollectionRuleName, data__location
update	update	subscriptionId, resourceGroupName, dataCollectionRuleName
delete	delete	subscriptionId, resourceGroupName, dataCollectionRuleName	deleteAssociations

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
dataCollectionRuleName	string	The name of the data collection rule. The name is case insensitive.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
deleteAssociations	boolean	If set to 'true' then all associations of this data collection rule will also be deleted

SELECT examples

get

Request completed successfully

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
FROM azure.monitor.data_collection_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataCollectionRuleName = '{{ dataCollectionRuleName }}' -- required
;

list_by_resource_group

Request completed successfully

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
FROM azure.monitor.data_collection_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Request completed successfully

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
FROM azure.monitor.data_collection_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO azure.monitor.data_collection_rules (
data__properties,
data__location,
data__tags,
data__kind,
data__identity,
subscriptionId,
resourceGroupName,
dataCollectionRuleName
)
SELECT 
'{{ properties }}',
'{{ location }}' /* required */,
'{{ tags }}',
'{{ kind }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dataCollectionRuleName }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_collection_rules
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_collection_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_collection_rules resource.
    - name: dataCollectionRuleName
      value: string
      description: Required parameter for the data_collection_rules resource.
    - name: properties
      value: object
      description: |
        Definition of what monitoring data to collect and where that data should be sent.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: kind
      value: string
      description: |
        The kind of the resource.
      valid_values: ['Linux', 'Windows']
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)

UPDATE examples

update

No description available.

UPDATE azure.monitor.data_collection_rules
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataCollectionRuleName = '{{ dataCollectionRuleName }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

No description available.

DELETE FROM azure.monitor.data_collection_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataCollectionRuleName = '{{ dataCollectionRuleName }}' --required
AND deleteAssociations = '{{ deleteAssociations }}'
;