Модуль azure.azcollection.azure_rm_monitoractivitylogalerts — создание, обновление и удаление оповещений журнала действий.

actions

dictionary

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

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

action_groups

list / elements=dictionary

Список групп действий.

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

action_group_id

string

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

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

webhook_properties

dictionary

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

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"

condition

dictionary

Условие, при выполнении которого срабатывает это оповещение.

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

all_of

list / elements=dictionary

Список условий правила оповещения журнала действий.

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

any_of

list / elements=dictionary

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

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

contains_any

list / elements=string

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

equals

string

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

field

string

Имя поля событий журнала действий, которое проверяет это условие. Возможные значения этого поля (без учета регистра): resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType или любое значение, начинающееся с properties.

contains_any

list / elements=string

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

equals

string

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

field

string

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

Возможные значения этого поля (без учета регистра): resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType или любая строка, начинающаяся с properties.

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.

https://github.com/Azure/azure-rest-api-specs/issues/35343

Варианты:

• false
• true

location

string

Расположение оповещения журнала действий.

Этот параметр должен быть необязательным, но при создании он обязателен.

https://github.com/Azure/azure-rest-api-specs/issues/35342

Оповещения журнала действий обычно имеют расположение «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 / элементы=string

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

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

Для создания список должен содержать не менее одного элемента.

secret

string

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

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

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

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

activitylogalert

словарь

Сведения о предупреждении журнала действий

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

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

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

Пример: {"actions": {"action_groups": [{"action_group_id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name/providers/microsoft.insights/actionGroups/action_group_name"}]}, "condition": {"all_of": [{"equals": "ResourceHealth", "field": "category"}, {"any_of": [{"equals": "Unknown", "field": "properties.currentHealthStatus"}, {"equals": "Unavailable", "field": "properties.currentHealthStatus"}, {"equals": "Degraded", "field": "properties.currentHealthStatus"}]}, {"any_of": [{"equals": "Unknown", "field": "properties.previousHealthStatus"}, {"equals": "Unavailable", "field": "properties.previousHealthStatus"}, {"equals": "Degraded", "field": "properties.previousHealthStatus"}, {"equals": "Available", "field": "properties.previousHealthStatus"}]}, {"any_of": [{"equals": "PlatformInitiated", "field": "properties.cause"}]}]}, "enabled": false, "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name/providers/Microsoft.Insights/activityLogAlerts/activity_log_alert_name", "location": "global", "name": "activity_log_alert_name", "scopes": ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name"], "tags": {}, "type": "Microsoft.Insights/ActivityLogAlerts"}