data_collection_rule_associations

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

Overview

Name	data_collection_rule_associations
Type	Resource
Id	azure.monitor.data_collection_rule_associations

Fields

The following fields are returned by SELECT queries:

list_by_rule

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).
properties	object	Definition of association of a data collection rule with a monitored Azure resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionRules)

list_by_data_collection_endpoint

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).
properties	object	Definition of association of a data collection rule with a monitored Azure resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionRules)

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).
properties	object	Definition of association of a data collection rule with a monitored Azure resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. (example: Microsoft.Insights/dataCollectionRules)

list_by_resource

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).
properties	object	Definition of association of a data collection rule with a monitored Azure resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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
list_by_rule	select	subscriptionId, resourceGroupName, dataCollectionRuleName
list_by_data_collection_endpoint	select	subscriptionId, resourceGroupName, dataCollectionEndpointName
get	select	resourceUri, associationName
list_by_resource	select	resourceUri
create	insert	resourceUri, associationName
delete	delete	resourceUri, associationName

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
associationName	string	The name of the association. The name is case insensitive.
dataCollectionEndpointName	string	The name of the data collection endpoint. The name is case insensitive.
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.
resourceUri	string	The identifier of the resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

list_by_rule

Request completed successfully

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

list_by_data_collection_endpoint

Request completed successfully

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.monitor.data_collection_rule_associations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataCollectionEndpointName = '{{ dataCollectionEndpointName }}' -- required
;

get

Request completed successfully

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.monitor.data_collection_rule_associations
WHERE resourceUri = '{{ resourceUri }}' -- required
AND associationName = '{{ associationName }}' -- required
;

list_by_resource

Request completed successfully

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.monitor.data_collection_rule_associations
WHERE resourceUri = '{{ resourceUri }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO azure.monitor.data_collection_rule_associations (
data__properties,
resourceUri,
associationName
)
SELECT 
'{{ properties }}',
'{{ resourceUri }}',
'{{ associationName }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_collection_rule_associations
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the data_collection_rule_associations resource.
    - name: associationName
      value: string
      description: Required parameter for the data_collection_rule_associations resource.
    - name: properties
      value: object
      description: |
        Definition of association of a data collection rule with a monitored Azure resource.

DELETE examples

delete

No description available.

DELETE FROM azure.monitor.data_collection_rule_associations
WHERE resourceUri = '{{ resourceUri }}' --required
AND associationName = '{{ associationName }}' --required
;