azure.azcollection.azure_rm_monitordatacollectionrules module – Create, update and delete Data Collection Rules

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

• false
• true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

Choices:

• "auto" ← (default)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

• "ignore"
• "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

data_collection_endpoint_id

string

The resource ID of the data collection endpoint that this rule can be used with

data_flows

list / elements=dictionary

Definition of which streams are sent to which destinations.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.dataflow?view=azure-python

built_in_transform

string

The builtIn transform to transform stream data.

destinations

list / elements=string

List of destinations for this data flow.

output_stream

string

The output stream of the transform. Only required if the transform changes data to a different stream.

streams

list / elements=string

List of streams for this data flow.

https://learn.microsoft.com/en-us/rest/api/monitor/data-collection-rules/create?view=rest-monitor-2023-03-11&tabs=HTTP&tryIt=true#knowndataflowstreams

transform_kql

string

The KQL query to transform stream data.

data_sources

dictionary

The specification of data sources.

This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.datacollectionruledatasources?view=azure-python

data_imports

dictionary

Specifications of pull based data sources.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.datasourcesspecdataimports?view=azure-python

event_hub

dictionary

Definition of Event Hub configuration.

consumer_group

string

Event Hub consumer group name.

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

stream

string

The stream to collect from EventHub.

extensions

list / elements=dictionary

Definition of which data will be collected from a separate VM extension that integrates with the Azure Monitor Agent.

Collected from either Windows and Linux machines, depending on which extension is defined.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.extensiondatasource?view=azure-python

extension_name

list / elements=string

The name of the VM extension.

extension_settings

string

The extension settings. The format is specific for particular extension.

input_data_sources

list / elements=string

The list of data sources this extension needs data from.

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

streams

list / elements=string

List of streams that this data source will be sent to.

A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.

iis_logs

list / elements=dictionary

Enables IIS logs to be collected by this data collection rule.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.iislogsdatasource?view=azure-python

log_directories

list / elements=string

Absolute paths file location.

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

streams

list / elements=string

IIS streams.

log_files

list / elements=dictionary

Definition of which custom log files will be collected by this data collection rule.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.logfilesdatasource?view=azure-python

file_patterns

list / elements=string

File Patterns where the log files are located

format

string

The data format of the log files.

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

settings

dictionary

The log files specific settings.

text

string

Text settings

streams

list / elements=string

List of streams that this data source will be sent to.

A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.

performance_counters

list / elements=dictionary

Definition of which performance counters will be collected and how they will be collected by this data collection rule.

Collected from both Windows and Linux machines where the counter is present.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.perfcounterdatasource?view=azure-python

counter_specifiers

list / elements=string

A list of specifier names of the performance counters you want to collect.

Use a wildcard (*) to collect a counter for all instances.

To get a list of performance counters on Windows, run the command ‘typeperf’

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

sampling_frequency_in_seconds

integer

The number of seconds between consecutive counter measurements (samples).

streams

list / elements=string

List of streams that this data source will be sent to.

A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.

platform_telemetry

list / elements=dictionary

Definition of platform telemetry data source configuration.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.platformtelemetrydatasource?view=azure-python

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

streams

list / elements=string

List of platform telemetry streams to collect.

prometheus_forwarder

list / elements=dictionary

Definition of Prometheus metrics forwarding configuration.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.prometheusforwarderdatasource?view=azure-python

label_include_filter

dictionary

The list of label inclusion filters in the form of label “name-value” pairs.

Currently only one label is supported “microsoft_metrics_include_label”. Label values are matched case-insensitively.

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

streams

list / elements=string

List of streams that this data source will be sent to.

syslog

list / elements=dictionary

Definition of which syslog data will be collected and how it will be collected. Only collected from Linux machines.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.syslogdatasource?view=azure-python

facility_names

list / elements=string

The list of facility names.

log_levels

list / elements=string

The log levels to collect.

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

streams

list / elements=string

List of streams that this data source will be sent to.

A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.

windows_event_logs

list / elements=dictionary

Definition of which Windows Event Log events will be collected and how they will be collected.

Only collected from Windows machines.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.windowseventlogdatasource?view=azure-python

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

streams

list / elements=string

List of streams that this data source will be sent to.

A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.

x_path_queries

list / elements=string

A list of Windows Event Log queries in XPATH format.

windows_firewall_logs

list / elements=dictionary

Enables Firewall logs to be collected by this data collection rule.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.windowsfirewalllogsdatasource?view=azure-python

name

string

A friendly name for the data source.

This name should be unique across all data sources (regardless of type) within the data collection rule.

streams

list / elements=string

Firewall logs streams.

description

string

Description for the data collection rule

destinations

dictionary

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.datacollectionruledestinations?view=azure-python

azure_monitor_metrics

string

Azure Monitor Metrics destination

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.destinationsspecazuremonitormetrics?view=azure-python

event_hubs

list / elements=dictionary

List of Event Hubs destinations.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.eventhubdestination?view=azure-python

event_hub_resource_id

string

The resource ID of the event hub.

name

string

A friendly name for the destination.

This name should be unique across all destinations (regardless of type) within the data collection rule.

event_hubs_direct

list / elements=dictionary

List of Event Hubs Direct destinations.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.eventhubdirectdestination?view=azure-python

event_hub_resource_id

string

The resource ID of the event hub.

name

string

A friendly name for the destination.

This name should be unique across all destinations (regardless of type) within the data collection rule.

log_analytics

list / elements=dictionary

List of Log Analytics destinations.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.loganalyticsdestination?view=azure-python

name

string

A friendly name for the destination.

This name should be unique across all destinations (regardless of type) within the data collection rule.

workspace_resource_id

string

The resource ID of the Log Analytics workspace.

monitoring_accounts

list / elements=dictionary

List of monitoring account destinations.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.monitoringaccountdestination?view=azure-python

account_resource_id

string

The resource ID of the monitoring account.

name

string

A friendly name for the destination.

This name should be unique across all destinations (regardless of type) within the data collection rule.

storage_accounts

list / elements=dictionary

List of storage accounts destinations.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.storageblobdestination?view=azure-python

container_name

string

The container name of the Storage Blob.

name

string

A friendly name for the destination.

This name should be unique across all destinations (regardless of type) within the data collection rule.

storage_account_resource_id

string

The resource ID of the storage account.

storage_blobs_direct

list / elements=dictionary

List of Storage Blob Direct destinations. To be used only for sending data directly to store from the agent.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.storageblobdestination?view=azure-python

container_name

string

The container name of the Storage Blob.

name

string

A friendly name for the destination.

This name should be unique across all destinations (regardless of type) within the data collection rule.

storage_account_resource_id

string

The resource ID of the storage account.

storage_tables_direct

list / elements=dictionary

List of Storage Table Direct destinations.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.storagetabledestination?view=azure-python

name

string

A friendly name for the destination.

This name should be unique across all destinations (regardless of type) within the data collection rule.

storage_account_resource_id

string

The resource ID of the storage account.

table_name

string

The name of the Storage Table.

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.

Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

• false ← (default)
• true

kind

string

Kind of the data collection rule

Use Linux for Linux.

Use Windows for Windows.

Choices:

• "Linux"
• "Windows"

location

string

Location of the data colelction rule

defaults to location of exiting data collection rule or

location of the resource group if unspecified

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

The name of the data collection rule you’re creating/changing

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string / required

The name of the resource group

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string

State of the data collection rule

Use present for creating/updating a data collection rule.

Use absent for deleting a data collection rule.

Choices:

• "present" ← (default)
• "absent"

stream_declarations

dictionary

Declaration of a custom stream. Sub dict is a list of columns used by data in this stream.

top level key is the name of the stream_declaration

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2022_06_01.models.streamdeclaration?view=azure-python

name_of_stream

dictionary

Name of the stream

columns

list / elements=dictionary

Declaration of a custom stream.

name

string

The name of the column.

type

string

The type of the column data.

Choices:

• "string"
• "int"
• "long"
• "real"
• "boolean"
• "datetime"
• "dynamic"

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

datacollectionrule

dictionary

Details of the data collection rule

Is null on state==absent (data collection rule does not exist or will be deleted)

Assumes you make legal changes in check mode

Returned: always

Sample: {"data_flows": ["..."], "data_sources": {}, "description": "Description of your data collection rule", "destinations": {}, "etag": "str", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name/providers/Microsoft.Insights/dataCollectionRules/data_collection_rule_name", "immutable_id": "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "kind": "Linux", "location": "westeurope", "name": "data_collection_rule_name", "provisioning_state": "Succeeded", "system_data": {"created_at": "2025-01-01T00:00:00.000000Z", "created_by": "xxx@domain.tld", "created_by_type": "User", "last_modified_at": "2025-01-01T00:00:00.000000Z", "last_modified_by": "xxx@domain.tld", "last_modified_by_type": "User"}, "tags": {}, "type": "Microsoft.Insights/dataCollectionRules"}