модуль azure.azcollection.azure_rm_monitormetricalerts — создание, обновление и удаление оповещений метрик.

actions

list / elements=dictionary

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

https://learn.microsoft.com/en-us/rest/api/monitor/metric-alerts/create-or-update?view=rest-monitor-2018-03-01&tabs=HTTP#metricalertaction

action_group_id

string

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

Необходимо задать при указании группы действий.

webhook_properties

dictionary

Словарь пользовательских свойств, которые будут включены в операцию POST. Эти данные добавляются к полезной нагрузке webhook.

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

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

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

Варианты:

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

auto_mitigate

boolean

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

Варианты:

• 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"

criteria

dictionary

Задает сведения о критериях оповещения.

Обязательный параметр при создании.

extra_keys

dictionary

https://learn.microsoft.com/en-us/rest/api/monitor/metric-alerts/create-or-update?view=rest-monitor-2018-03-01&tabs=HTTP#request-body

Дополнительные ключи зависят от odata_type

odata_type

string

Задает тип критериев оповещения.

Обязательный параметр при создании.

Варианты:

• "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
• "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
• "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria"

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

enabled

boolean

Указывает, включено ли это оповещение метрик.

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

Обязательный параметр при создании.

Варианты:

• false
• true

evaluation_frequency

string

Частота оценки оповещения метрик, заданная в формате длительности ISO 8601.

https://en.wikipedia.org/wiki/ISO_8601#Durations

Обязательный параметр при создании.

location

string

Расположение оповещения метрик.

Обычно для оповещений метрик указывается значение «Global».

Если значение не указано, при создании используется «Global».

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 / обязательный

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

scopes

list / elements=string

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

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

При создании список должен содержать хотя бы один элемент.

secret

string

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

severity

integer

Степень серьезности оповещения от 1 до 4.

Обязательный параметр при создании.

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 тегов для ресурсов.

target_resource_region

string

Регион целевого ресурса или ресурсов, для которых создается или обновляется оповещение.

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

target_resource_type

string

Тип целевого ресурса или ресурсов, для которых создается или обновляется оповещение.

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

tenant

string

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

thumbprint

string

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

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

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

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

window_size

string

Период времени (в формате длительности ISO 8601), используемый для мониторинга активности оповещения на основе порогового значения.

https://en.wikipedia.org/wiki/ISO_8601#Durations

Обязательный параметр при создании.

x509_certificate_path

path

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

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

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

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

metricalert

словарь

Сведения о предупреждении метрики

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

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

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

Пример: {"actions": [{"action_group_id": "subscriptions/<sub-id>/resourceGroups/myrg/providers/microsoft.insights/actionGroups/action_group_name"}], "auto_mitigate": true, "criteria": {"all_of": [{"criterion_type": "StaticThresholdCriterion", "dimensions": [{"name": "dataSourceURL", "operator": "Include", "values": ["*"]}, {"name": "healthStatus", "operator": "Exclude", "values": ["Healthy"]}], "metric_name": "BackupHealthEvent", "metric_namespace": "Microsoft.RecoveryServices/vaults", "name": "Metric1", "operator": "GreaterThan", "skip_metric_validation": false, "threshold": 0.0, "time_aggregation": "Count"}], "odata_type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"}, "description": "Alert on Backup Health Events", "enabled": true, "evaluation_frequency": "PT1H", "id": "subscriptions/<sub-id>/resourceGroups/myrg/providers/Microsoft.Insights/metricAlerts/metric_alert_name", "location": "Global", "name": "metric_alert_name", "scopes": ["/subscriptions/<sub-id>/resourceGroups/myrg/providers/Microsoft.RecoveryServices/vaults/recovery_vault_name"], "severity": 3, "tags": {"TestTag1": "TestValue1"}, "target_resource_type": "Microsoft.RecoveryServices/vaults", "type": "Microsoft.Insights/metricAlerts", "window_size": "P1D"}