Модуль azure.azcollection.azure_rm_monitordatacollectionrules — создание, обновление и удаление правил сбора данных

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

Определяет, является ли поле тегов каноническим или только дополняет существующие теги.

При каноническом режиме все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

• false
• true ← (по умолчанию)

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной окружения ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), порядок приоритета следующий: параметры модуля -> env -> credential_file -> cli.

Если задано значение env, учетные данные будут получены из переменных окружения.

Если задано значение credential_file, профиль будет прочитан из ~/.azure/credentials.

Если задано значение cli, учетные данные будут получены из профиля Azure CLI. Для определения идентификатора подписки, если доступно несколько подписок, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет использована подписка Azure CLI по умолчанию.

Если задано значение msi, хост-компьютер должен быть ресурсом Azure с включенным расширением MSI. Для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет поведение проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, указав ignore. Это значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США: имя среды (согласно определению в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Это значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

data_collection_endpoint_id

string

Идентификатор ресурса конечной точки сбора данных, с которой можно использовать это правило

data_flows

list / elements=dictionary

Определение потоков данных, отправляемых в соответствующие целевые расположения.

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

Встроенное преобразование для преобразования данных потока.

destinations

list / elements=string

Список целевых расположений для этого потока данных.

output_stream

string

Выходной поток преобразования. Обязателен, только если в результате преобразования данные переводятся в другой поток.

streams

list / elements=string

Список потоков для этого потока данных.

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

Запрос KQL для преобразования данных потока.

data_sources

dictionary

Спецификация источников данных.

Это свойство необязательно и его можно опустить, если правило предназначено для использования посредством прямых вызовов подготовленной конечной точки.

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

Спецификации источников данных, использующих извлечение данных.

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

Определение конфигурации Event Hub.

consumer_group

string

Имя группы потребителей Event Hub.

name

string

Понятное имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от их типа) в пределах правила сбора данных.

stream

string

Поток, из которого выполняется сбор данных в Event Hub.

extensions

list / elements=dictionary

Определение данных, которые будут собираться из отдельного расширения виртуальной машины, интегрированного с Azure Monitor Agent.

Данные собираются с компьютеров под управлением Windows или Linux в зависимости от определённого расширения.

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

Имя расширения виртуальной машины.

extension_settings

string

Параметры расширения. Формат зависит от конкретного расширения.

input_data_sources

list / elements=string

Список источников данных, из которых этому расширению необходимы данные.

name

string

Удобочитаемое имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от типа) в пределах правила сбора данных.

streams

list / elements=string

Список потоков, в которые будут передаваться данные из этого источника данных.

Поток определяет схему, используемую для этих данных, и обычно указывает таблицу Log Analytics, в которую они будут передаваться.

iis_logs

list / elements=dictionary

Включает сбор журналов IIS этим правилом сбора данных.

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

Абсолютные пути к расположению файлов.

name

string

Удобочитаемое имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от типа) в пределах правила сбора данных.

streams

list / elements=string

Потоки IIS.

log_files

list / elements=dictionary

Определение пользовательских файлов журналов, которые будут собираться этим правилом сбора данных.

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

Шаблоны файлов, определяющие расположение файлов журналов

format

string

Формат файлов журналов.

name

string

Понятное имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от их типа) в пределах правила сбора данных.

settings

dictionary

Параметры, относящиеся к файлам журналов.

text

string

Текстовые параметры

streams

list / elements=string

Список потоков, в которые будет отправляться этот источник данных.

Поток определяет, какая схема будет использоваться для этих данных и обычно в какую таблицу Log Analytics они будут отправляться.

performance_counters

list / elements=dictionary

Определение счетчиков производительности, которые будут собираться, и способа их сбора этим правилом сбора данных.

Сбор выполняется на компьютерах под управлением Windows и Linux, на которых присутствует соответствующий счетчик.

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

Список имен счетчиков производительности, которые необходимо собирать.

Используйте подстановочный знак (*) для сбора счетчика для всех экземпляров.

Чтобы получить список счетчиков производительности в Windows, выполните команду ‘typeperf’

name

string

Понятное имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от их типа) в пределах правила сбора данных.

sampling_frequency_in_seconds

integer

Количество секунд между последовательными измерениями счетчика (выборками).

streams

list / elements=string

Список потоков, в которые будет отправляться этот источник данных.

Поток определяет, какая схема будет использоваться для этих данных и обычно в какую таблицу Log Analytics они будут отправляться.

platform_telemetry

list / elements=dictionary

Определение конфигурации источника данных телеметрии платформы.

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

name

string

Понятное имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от их типа) в пределах правила сбора данных.

streams

list / elements=string

Список потоков телеметрии платформы для сбора.

prometheus_forwarder

list / elements=dictionary

Определение конфигурации пересылки метрик Prometheus.

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

Список фильтров включения меток в виде пар «имя-значение» метки.

В настоящее время поддерживается только одна метка — “microsoft_metrics_include_label”. Значения меток сравниваются без учёта регистра.

name

string

Понятное имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от типа) в рамках правила сбора данных.

streams

list / elements=string

Список потоков, в которые будут передаваться данные из этого источника.

syslog

list / elements=dictionary

Определение собираемых данных syslog и способа их сбора. Сбор выполняется только с компьютеров под управлением Linux.

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

Список имён подсистем.

log_levels

list / elements=string

Уровни журналирования для сбора.

name

string

Понятное имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от типа) в рамках правила сбора данных.

streams

list / elements=string

Список потоков, в которые будут передаваться данные из этого источника.

Поток определяет схему, которая будет использоваться для этих данных, и обычно указывает таблицу в Log Analytics, в которую будут передаваться данные.

windows_event_logs

list / elements=dictionary

Определение собираемых событий журнала событий Windows и способа их сбора.

Сбор выполняется только с компьютеров под управлением Windows.

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

name

string

Понятное имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от типа) в рамках правила сбора данных.

streams

list / elements=string

Список потоков, в которые будет передаваться этот источник данных.

Поток указывает, какая схема будет использоваться для этих данных и, как правило, в какую таблицу Log Analytics они будут передаваться.

x_path_queries

list / elements=string

Список запросов к журналу событий Windows в формате XPATH.

windows_firewall_logs

list / elements=dictionary

Включает сбор журналов брандмауэра с помощью этого правила сбора данных.

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

name

string

Понятное имя источника данных.

Это имя должно быть уникальным среди всех источников данных (независимо от типа) в рамках правила сбора данных.

streams

list / elements=string

Потоки журналов брандмауэра.

description

string

Описание правила сбора данных

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

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

Список назначений Event Hubs.

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

Идентификатор ресурса Event Hub.

name

string

Понятное имя назначения.

Это имя должно быть уникальным среди всех назначений (независимо от типа) в рамках правила сбора данных.

event_hubs_direct

list / elements=dictionary

Список назначений Event Hubs Direct.

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

Идентификатор ресурса Event Hub.

name

string

Понятное имя назначения.

Это имя должно быть уникальным среди всех назначений (независимо от типа) в рамках правила сбора данных.

log_analytics

list / elements=dictionary

Список назначений Log Analytics.

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

name

string

Понятное имя назначения.

Это имя должно быть уникальным среди всех назначений (независимо от типа) в рамках правила сбора данных.

workspace_resource_id

string

Идентификатор ресурса рабочей области Log Analytics.

monitoring_accounts

list / elements=dictionary

Список назначений учетных записей мониторинга.

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

Идентификатор ресурса учетной записи мониторинга.

name

string

Понятное имя назначения.

Это имя должно быть уникальным среди всех назначений (независимо от типа) в рамках правила сбора данных.

storage_accounts

list / elements=dictionary

Список назначений учетных записей хранения данных.

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

Имя контейнера Storage Blob.

name

string

Понятное имя назначения.

Это имя должно быть уникальным среди всех назначений (независимо от типа) в рамках правила сбора данных.

storage_account_resource_id

string

Идентификатор ресурса учетной записи хранения.

storage_blobs_direct

list / elements=dictionary

Список назначений Storage Blob Direct. Используется только для отправки данных напрямую в хранилище из агента.

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

Имя контейнера Storage Blob.

name

string

Удобочитаемое имя назначения.

Это имя должно быть уникальным среди всех назначений (независимо от их типа) в правиле сбора данных.

storage_account_resource_id

string

Идентификатор ресурса учетной записи хранения.

storage_tables_direct

list / elements=dictionary

Список назначений Storage Table Direct.

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

name

string

Удобочитаемое имя назначения.

Это имя должно быть уникальным среди всех назначений (независимо от их типа) в правиле сбора данных.

storage_account_resource_id

string

Идентификатор ресурса учетной записи хранения.

table_name

string

Имя таблицы Storage Table.

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Значение true полностью отключает обнаружение экземпляров и проверку центра сертификации. Эта возможность предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает получение метаданных центра сертификации с сайта https://login.microsoft.com/ для проверки центра сертификации. Установив значение **True**, вы отключаете проверку центра сертификации. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является допустимым и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

kind

string

Тип правила сбора данных

Используйте Linux для Linux.

Используйте Windows для Windows.

Варианты:

• "Linux"
• "Windows"

location

string

Расположение правила сбора данных

По умолчанию используется расположение существующего правила сбора данных или

расположение группы ресурсов, если оно не указано

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string / обязательный

Имя создаваемого или изменяемого правила сбора данных

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

обязательный

Имя группы ресурсов

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

state

string

Состояние правила сбора данных

Используйте present для создания или обновления правила сбора данных.

Используйте absent для удаления правила сбора данных.

Варианты:

• "present" ← (по умолчанию)
• "absent"

stream_declarations

dictionary

Описание пользовательского потока. Вложенный словарь содержит список столбцов, используемых данными в этом потоке.

Ключ верхнего уровня — имя 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

Имя потока

columns

list / elements=dictionary

Объявление пользовательского потока.

name

string

Имя столбца.

type

string

Тип данных столбца.

Допустимые значения:

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

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар «строка:строка», назначаемых объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с использованием всех указанных значений.

Чтобы удалить теги, задайте для параметра append_tags значение false.

В настоящее время зоны DNS Azure и службы Traffic Manager также не допускают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат необходимо добавить к закрытому ключу.

Используется при аутентификации с помощью субъекта-службы.

datacollectionrule

словарь

Сведения о правиле сбора данных

Имеет значение null при state==absent (правило сбора данных не существует или будет удалено)

Предполагается, что в режиме проверки вы вносите допустимые изменения

Возвращается: всегда

Пример: {"data_flows": ["..."], "data_sources": {}, "description": "Description of your data collection rule", "destinations": {}, "etag": "str", "id": "/subscriptions/<sub-id>/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"}