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

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 ← (по умолчанию)

arm_role_receivers

list / elements=dictionary

Список получателей ролей ARM, входящих в эту группу действий. Роли являются ролями Azure RBAC; поддерживаются только встроенные роли.

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

name

string

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

Обязателен при настройке этого получателя.

role_id

string

Идентификатор роли ARM.

Обязателен при настройке этого получателя.

use_common_alert_schema

boolean

Указывает, следует ли использовать общую схему оповещений.

Если значение не задано, по умолчанию используется False (значение по умолчанию на стороне сервера).

Варианты:

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

automation_runbook_receivers

list / elements=dictionary

Список получателей AutomationRunbook, входящих в эту группу действий.

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

automation_account_id

string

Идентификатор учетной записи Azure Automation, в которой находится эта книга runbook и которая выполняет аутентификацию в ресурсе Azure.

Обязательно при настройке этого получателя.

is_global_runbook

boolean

Указывает, является ли этот экземпляр глобальной книгой runbook.

Варианты:

• false
• true

name

string

Имя веб-перехватчика.

runbook_name

string

Имя этой книги runbook.

Обязательно при настройке этого получателя.

service_uri

string

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

use_common_alert_schema

boolean

Указывает, следует ли использовать общую схему оповещений.

По умолчанию False, если значение не задано (значение по умолчанию на стороне сервера).

Варианты:

• false
• true

webhook_resource_id

string

Идентификатор ресурса веб-перехватчика, связанного с этой книгой runbook.

Обязательно при настройке этого получателя.

azure_app_push_receivers

list / elements=dictionary

Список получателей AzureAppPush, входящих в эту группу действий.

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

email_address

string

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

Обязательно при настройке этого получателя.

name

string

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

Обязательно при настройке этого получателя.

azure_function_receivers

list / elements=dictionary

Список получателей функций Azure, входящих в эту группу действий.

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

function_app_resource_id

string

Идентификатор ресурса Azure для приложения-функции.

Обязателен при настройке этого получателя.

function_name

string

Имя функции в приложении-функции.

Обязателен при настройке этого получателя.

http_trigger_url

string

URL-адрес HTTP-триггера, на который отправляется HTTP-запрос.

Обязателен при настройке этого получателя.

name

string

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

Обязателен при настройке этого получателя.

use_common_alert_schema

boolean

Указывает, следует ли использовать общую схему оповещений.

Если параметр не задан, по умолчанию используется значение False (значение по умолчанию на стороне сервера).

Варианты:

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

disable_instance_discovery

boolean

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

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

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

Варианты:

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

email_receivers

list / elements=dictionary

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

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

email_address

string

Адрес электронной почты этого получателя.

Обязательный параметр при настройке этого получателя.

name

string

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

Обязательный параметр при настройке этого получателя.

use_common_alert_schema

boolean

Указывает, следует ли использовать общую схему оповещений.

Если параметр не задан, по умолчанию используется значение False (значение по умолчанию на стороне сервера).

Варианты:

• false
• true

enabled

boolean

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

Варианты:

• false
• true

event_hub_receivers

list / elements=dictionary

Список получателей Event Hub, входящих в эту группу действий.

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

event_hub_name

string

Имя конкретной очереди Event Hub.

Обязательный параметр при настройке этого получателя.

event_hub_name_space

string

Пространство имен Event Hub.

Обязательный параметр при настройке этого получателя.

name

string

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

Обязательный параметр при настройке этого получателя.

subscription_id

string

Идентификатор подписки, содержащей этот Event Hub.

Обязательный параметр при настройке этого получателя.

tenant_id

string

Идентификатор клиента для подписки, содержащей этот Event Hub.

use_common_alert_schema

boolean

Указывает, следует ли использовать общую схему оповещений.

Если параметр не задан, по умолчанию используется значение False (значение по умолчанию на стороне сервера).

Варианты:

• false
• true

group_short_name

string

Краткое имя группы действий. Оно будет использоваться в SMS-сообщениях.

itsm_receivers

list / elements=dictionary

Список получателей веб-перехватчиков, входящих в эту группу действий.

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

connection_id

string

Уникальный идентификатор подключения ITSM среди нескольких подключений, определённых в указанной выше рабочей области.

Обязательно при настройке этого получателя.

name

string

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

Обязательно при настройке этого получателя.

region

string

Регион, в котором находится рабочая область.

Обязательно при настройке этого получателя.

ticket_configuration

string

JSON-объект с конфигурацией действия ITSM. Параметр CreateMultipleWorkItems также будет включён в этот объект.

Обязательно при настройке этого получателя.

workspace_id

string

Идентификатор экземпляра OMS LA.

Обязательно при настройке этого получателя.

location

string

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

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

Обычно группы действий имеют расположение «Global».

log_mode

string

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

log_path

string

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

logic_app_receivers

list / elements=dictionary

Список получателей Logic App, входящих в эту группу действий.

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

callback_url

string

URL обратного вызова, на который отправляется HTTP-запрос.

Обязательно при настройке этого получателя.

name

string

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

Обязательно при настройке этого получателя.

resource_id

string

Идентификатор ресурса Azure получателя Logic App.

Обязательно при настройке этого получателя.

use_common_alert_schema

boolean

Указывает, следует ли использовать общую схему оповещений.

Если параметр не задан, по умолчанию используется значение False (значение по умолчанию на стороне сервера).

Варианты:

• false
• true

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

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

secret

string

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

sms_receivers

list / elements=dictionary

Список получателей SMS, входящих в эту группу действий.

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

country_code

string

Код страны получателя SMS.

Обязательно при настройке этого получателя.

name

string

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

Обязательно при настройке этого получателя.

phone_number

string

Номер телефона получателя SMS.

Обязательно при настройке этого получателя.

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.

voice_receivers

list / elements=dictionary

Список получателей голосовых вызовов, входящих в эту группу действий.

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

country_code

string

Код страны получателя голосовых вызовов.

Обязательный параметр при настройке этого получателя.

name

string

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

Обязательный параметр при настройке этого получателя.

phone_number

string

Номер телефона получателя голосовых вызовов.

Обязательный параметр при настройке этого получателя.

webhook_receivers

list / elements=dictionary

Список получателей веб-перехватчиков, входящих в эту группу действий.

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

identifier_uri

string

Указывает URI идентификатора для аутентификации AAD.

name

string

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

Обязательный параметр при настройке этого получателя.

object_id

string

Указывает идентификатор объекта приложения веб-перехватчика для аутентификации AAD.

service_uri

string

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

Обязательный параметр при настройке этого получателя.

tenant_id

string

Указывает идентификатор клиента для аутентификации AAD.

use_aad_auth

boolean

Указывает, следует ли использовать аутентификацию AAD.

По умолчанию False, если параметр не задан (значение по умолчанию на стороне сервера).

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

• false
• true

use_common_alert_schema

boolean

Указывает, следует ли использовать общую схему оповещений.

Если параметр не задан, по умолчанию используется False (значение по умолчанию на стороне сервера).

Варианты:

• false
• true

x509_certificate_path

path

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

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

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

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

actiongroup

dictionary

Сведения о группе действий

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

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

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

Пример: {"arm_role_receivers": [], "automation_runbook_receivers": [], "azure_app_push_receivers": [], "azure_function_receivers": [], "email_receivers": [{"email_address": "xxx@hostname.tld", "name": "sendmail", "use_common_alert_schema": true}], "enabled": true, "event_hub_receivers": [], "group_short_name": "shortname", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resougce_group_name/providers/microsoft.insights/actionGroups/action_group_name", "itsm_receivers": [], "location": "Global", "logic_app_receivers": [], "name": "action_group_name", "sms_receivers": [], "tags": {}, "type": "Microsoft.Insights/ActionGroups", "voice_receivers": [], "webhook_receivers": []}