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

action

dictionary

Действия, которые будут активированы при выполнении условия

azns_action

dictionary

Ссылка на группу действий Azure

action_group

list / elements=string

Список идентификаторов групп действий

email_subject

string

Переопределение темы письма для всех адресов электронной почты в группе действий Azure

odata_type

string

Указывает действие

Варианты:

• "AlertingAction"
• "LogToMetricAction"
• "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"

severity

integer

Серьёзность оповещения

Варианты:

• 0
• 1
• 2
• 3
• 4

trigger

dictionary

Условие срабатывания, при котором активируется правило оповещения.

metric_trigger

dictionary

Условие срабатывания, при котором активируется правило оповещения.

metric_column

string

Оценка метрики по определённому столбцу.

metric_trigger_type

string

Тип триггера метрики.

Варианты:

• "Consecutive"
• "Total"

threshold

float

Пороговое значение триггера метрики.

threshold_operator

string

Операция оценки метрики.

Варианты:

• "GreaterThanOrEqual"
• "GreaterThan"
• "LessThan"
• "Equal"

threshold

float

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

threshold_operator

string

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

Варианты:

• "GreaterThanOrEqual"
• "GreaterThan"
• "LessThan"

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 каноническим или только добавляет значения к существующим тегам.

Если поле является каноническим, все теги, отсутствующие в параметре 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; в противном случае используется подписка az cli по умолчанию.

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

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

Варианты:

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

auto_mitigate

boolean

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

Варианты:

• false
• true

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"

description

string

Описание правила поиска в журнале.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

display_name

string

Отображаемое имя правила оповещения.

enabled

string

Флаг, указывающий, включено ли правило поиска в журнале.

Варианты:

• "False"
• "True"

location

string

Расположение правила запланированного запроса

Обычно правила запланированных запросов находятся в расположении рабочей области Log Analytics.

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

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

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

schedule

dictionary

Расписание (частота, временное окно) для правила. Обязательно для типа действия AlertingAction.

frequency_in_minutes

integer

Частота (в минутах), с которой следует оценивать условие правила.

time_window_in_minutes

integer

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

secret

string

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

source

dictionary

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

authorized_resources

list / elements=string

Список ресурсов, на которые ссылается запрос.

data_source_id

string

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

query

string

Запрос поиска в журнале. Обязателен для типа действия AlertingAction.

query_type

string

Задайте значение ‘ResultCount’.

Варианты:

• "ResultCount"

state

string

Состояние правила запланированного запроса

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

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

Варианты:

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

subscription_id

string

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

tags

dictionary

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

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

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

В настоящее время зоны Azure DNS и службы 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, используемому для создания субъекта-службы.

Сертификат должен быть добавлен в конец файла закрытого ключа.

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

scheduledqueryrule

словарь

Сведения о правиле запланированного запроса

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

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

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

Пример: {"action": {"azns_action": {"action_group": ["/subscriptions/<sub-id>/resourceGroups/myrg/providers/microsoft.insights/actionGroups/action_group_name"], "email_subject": ""}, "odata_type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", "severity": "2", "trigger": {"metric_trigger": {"metric_column": "InstanceName,_ResourceId", "metric_trigger_type": "Total", "threshold": 1.0, "threshold_operator": "GreaterThanOrEqual"}, "threshold": 10.0, "threshold_operator": "LessThan"}}, "auto_mitigate": true, "created_with_api_version": "2018-04-16", "description": "Monitoring: Disks/logical volumes with less than 10% free space", "display_name": "scheduled_query_alert_name", "enabled": "true", "id": "/subscriptions/<sub-id>/resourceGroups/myrg/providers/microsoft.insights/scheduledqueryrules/scheduled_query_alert_name", "last_updated_time": "2025-10-30T16:07:30.773011Z", "location": "eastus", "name": "scheduled_query_alert_name", "provisioning_state": "Succeeded", "schedule": {"frequency_in_minutes": 5, "time_window_in_minutes": 5}, "source": {"authorized_resources": [], "data_source_id": "/subscriptions/<sub-id>/resourceGroups/myrg/providers/Microsoft.OperationalInsights/workspaces/log_analytics_workspace_name", "query": "actual query", "query_type": "ResultCount"}, "tags": {}, "type": "Microsoft.Insights/scheduledQueryRules"}