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_data_collection_endpoint

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.
dataCollectionEndpointId	string	The resource ID of the data collection endpoint that is to be associated.
dataCollectionRuleId	string	The resource ID of the data collection rule that is to be associated.
description	string	Description of the association.
etag	string	Resource entity tag (ETag).
metadata	object	Metadata about the resource.
provisioningState	string	The resource provisioning state. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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_by_rule

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.
dataCollectionEndpointId	string	The resource ID of the data collection endpoint that is to be associated.
dataCollectionRuleId	string	The resource ID of the data collection rule that is to be associated.
description	string	Description of the association.
etag	string	Resource entity tag (ETag).
metadata	object	Metadata about the resource.
provisioningState	string	The resource provisioning state. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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".

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.
dataCollectionEndpointId	string	The resource ID of the data collection endpoint that is to be associated.
dataCollectionRuleId	string	The resource ID of the data collection rule that is to be associated.
description	string	Description of the association.
etag	string	Resource entity tag (ETag).
metadata	object	Metadata about the resource.
provisioningState	string	The resource provisioning state. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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_by_resource

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.
dataCollectionEndpointId	string	The resource ID of the data collection endpoint that is to be associated.
dataCollectionRuleId	string	The resource ID of the data collection rule that is to be associated.
description	string	Description of the association.
etag	string	Resource entity tag (ETag).
metadata	object	Metadata about the resource.
provisioningState	string	The resource provisioning state. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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
list_by_data_collection_endpoint	select	resource_group_name, data_collection_endpoint_name, subscription_id		Lists associations for the specified data collection endpoint. Lists associations for the specified data collection endpoint.
list_by_rule	select	resource_group_name, data_collection_rule_name, subscription_id	$skipToken, $top	Lists associations for the specified data collection rule. Lists associations for the specified data collection rule.
get	select	resource_uri, association_name		Returns the specified association. Returns the specified association.
list_by_resource	select	resource_uri		Lists associations for the specified resource. Lists associations for the specified resource.
create	insert	resource_uri, association_name		Creates or updates an association. Creates or updates an association.
delete	delete	resource_uri, association_name		Deletes an association. Deletes an association.

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
association_name	string	The name of the association. The name is case insensitive. Required.
data_collection_endpoint_name	string	The name of the data collection endpoint. The name is case insensitive. Required.
data_collection_rule_name	string	The name of the data collection rule. The name is case insensitive. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.
subscription_id	string
$skipToken	string	(Optional) The continuation token for paginated responses. Default value is None.
$top	integer	(Optional) The max number of items to return per page. Default value is None.

SELECT examples

list_by_data_collection_endpoint

Lists associations for the specified data collection endpoint. Lists associations for the specified data collection endpoint.

SELECT
id,
name,
dataCollectionEndpointId,
dataCollectionRuleId,
description,
etag,
metadata,
provisioningState,
systemData,
type
FROM azure.monitor.data_collection_rule_associations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_collection_endpoint_name = '{{ data_collection_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_rule

Lists associations for the specified data collection rule. Lists associations for the specified data collection rule.

SELECT
id,
name,
dataCollectionEndpointId,
dataCollectionRuleId,
description,
etag,
metadata,
provisioningState,
systemData,
type
FROM azure.monitor.data_collection_rule_associations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_collection_rule_name = '{{ data_collection_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

get

Returns the specified association. Returns the specified association.

SELECT
id,
name,
dataCollectionEndpointId,
dataCollectionRuleId,
description,
etag,
metadata,
provisioningState,
systemData,
type
FROM azure.monitor.data_collection_rule_associations
WHERE resource_uri = '{{ resource_uri }}' -- required
AND association_name = '{{ association_name }}' -- required
;

list_by_resource

Lists associations for the specified resource. Lists associations for the specified resource.

SELECT
id,
name,
dataCollectionEndpointId,
dataCollectionRuleId,
description,
etag,
metadata,
provisioningState,
systemData,
type
FROM azure.monitor.data_collection_rule_associations
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create

Creates or updates an association. Creates or updates an association.

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

Manifest

# Description fields are for documentation purposes
- name: data_collection_rule_associations
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the data_collection_rule_associations resource.
  - name: association_name
    value: "{{ association_name }}"
    description: Required parameter for the data_collection_rule_associations resource.
  - name: properties
    description: |
      :vartype properties: ~azure.mgmt.monitor.models.DataCollectionRuleAssociationProxyOnlyResourceProperties
    value:
      description: "{{ description }}"
      dataCollectionRuleId: "{{ dataCollectionRuleId }}"
      dataCollectionEndpointId: "{{ dataCollectionEndpointId }}"
      provisioningState: "{{ provisioningState }}"
      metadata:
        provisionedBy: "{{ provisionedBy }}"
        provisionedByResourceId: "{{ provisionedByResourceId }}"
        provisionedByImmutableId: "{{ provisionedByImmutableId }}"

DELETE examples

delete

Deletes an association. Deletes an association.

DELETE FROM azure.monitor.data_collection_rule_associations
WHERE resource_uri = '{{ resource_uri }}' --required
AND association_name = '{{ association_name }}' --required
;