Модуль azure.azcollection.azure_rm_monitordiagnosticsetting – Создание, обновление или управление настройками диагностики Azure Monitor.

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: azure.azcollection.azure_rm_monitordiagnosticsetting.

Новая версия в azure.azcollection 1.10.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление или управление настройками диагностики Azure Monitor для любого типа ресурса.

Требования

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

python >= 2.7
На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлен в azure.azcollection 0.0.1	URL-адрес службы Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлен в azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
auth_source строка добавлен в 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"`
cert_validation_mode строка добавлен в azure.azcollection 0.0.1	Управляет поведением проверки сертификатов для Azure-точек конечных. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задан в профиле файла учетных данных или переменной среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала или управляемой учетной записи (msi). Также может быть задан через переменную окружения `AZURE_CLIENT_ID`.
cloud_environment строка добавлен в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (определенное Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан в профиле файла учетных данных или переменной среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery булево добавлен в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка значения true полностью отключит обнаружение экземпляра и проверку полномочий. Эта функция предназначена для сценариев, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра предполагает получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, отключается проверка полномочий. Поэтому крайне важно убедиться, что заданный хост полномочий действителен и надежен. Задаётся в профиле файла учетных данных или переменной окружения `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
event_hub словарь	Центр событий, который будет получать диагностические журналы. Хотя бы один из параметров storage_account, log_analytics или event_hub должен быть указан для настройки диагностики.
hub строка	Имя центра событий для получения журналов. Если не указано, будет выбран стандартный центр событий.
namespace строка / обязательно	Имя пространства центра событий.
policy строка / обязательно	Политика совместного доступа.
resource_group строка	Группа ресурсов, содержащая центр событий. Если не указано, используется группа ресурсов из параметра resource.
subscription_id строка	Идентификатор подписки, содержащей центр событий. Если не указано, используется идентификатор подписки из параметра resource.

END_OF_DOCUMENT_MARKER

log_analytics any	Рабочее пространство аналитики журналов, которое будет получать диагностические журналы. Может быть строкой, содержащей идентификатор ресурса рабочего пространства аналитики журналов. Может быть словарем, содержащим поля name и необязательно subscription_id и resource_group. Необходимо указать хотя бы одно из полей storage_account, log_analytics или event_hub для диагностической настройки.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
logs list / elements=dictionary	Список настроек журналов. Необходимо указать хотя бы одно из полей metrics или logs для диагностической настройки.
category string	Имя категории диагностических журналов группы управления для типа ресурса, к которому применяется данная настройка.
category_group string	Имя группы категории диагностических журналов группы управления для типа ресурса, к которому применяется данная настройка.
enabled boolean	Включен ли журнал. Варианты: `false` `true` ← (по умолчанию)
retention_policy dictionary	Политика хранения для этого журнала.
days integer	Количество дней для политики хранения. По умолчанию: `0`
enabled boolean	Включена ли политика хранения. Варианты: `false` `true` ← (по умолчанию)
metrics list / elements=dictionary	Список настроек метрик. Необходимо указать хотя бы одно из полей metrics или logs для диагностической настройки.
category string	Имя категории диагностической метрики для типа ресурса, к которому применяется данная настройка.
enabled boolean	Включена ли категория метрик. Варианты: `false` `true` ← (по умолчанию)
retention_policy dictionary	Политика хранения для этой метрики.
days integer	Количество дней для политики хранения. По умолчанию: `0`
enabled boolean	Включена ли политика хранения. Варианты: `false` `true` ← (по умолчанию)
name string / обязательно	Имя диагностических настроек.
password string	Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо службы-принципала.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource any / обязательно	Ресурс, который будет отслеживаться с помощью диагностической настройки. Может быть строкой, содержащей идентификатор ресурса. Может быть словарем, содержащим поля name, type, resource_group и необязательно subscription_id. name. Имя ресурса. type. Тип ресурса, включая имя пространства, например, ‘Microsoft.Network/virtualNetworks’. resource_group. Группа ресурсов, содержащая ресурс. subscription_id. Идентификатор подписки, содержащей ресурс. Если не указано, будет использоваться идентификатор подписки учетных данных.

END_OF_DOCUMENT_MARKER

secret string	Секретный ключ Azure. Используется при аутентификации с помощью Служебного принципала.
state string	Состояние группы DNS-зон частного конечного пункта. Используйте `present` для создания или обновления и `absent` для удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
storage_account any	Учетная запись хранилища, которая будет получать диагностические журналы. Может быть строкой, содержащей идентификатор ресурса учетной записи хранилища. Может быть словарем, содержащим name и необязательно subscription_id и resource_group. Для диагностической настройки необходимо указать как минимум один из параметров: storage_account, log_analytics или event_hub.
subscription_id string	Идентификатор вашей подписки Azure.
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. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью Служебного принципала.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные окружения, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
Аутентификация также возможна с помощью служебного принципала или пользователя Active Directory.
Для аутентификации через служебный принцип передайте subscription_id, client_id, secret и tenant или установите переменные окружения AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в переменных окружения.
В качестве альтернативы данные учетных данных могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавление дополнительных профилей. Укажите профиль, передав profile или установив AZURE_PROFILE в переменных окружения.

См. также

Вход в Azure CLI: Как войти в систему, используя команду az login.

Примеры

- name: Create storage-based diagnostic setting for a virtual network
  azure_rm_monitordiagnosticsetting:
    name: "logs-storage"
    resource: "{{ vnet_output.state.id }}"
    storage_account: "{{ storage_output.state.id }}"
    logs:
      - category_group: "allLogs"
    metrics:
      - category: "AllMetrics"

- name: Create diagnostic setting for webapp with log analytics, event hub, and storage
  azure_rm_monitordiagnosticsetting:
    name: "webapp-logs"
    resource:
      name: "my-webapp"
      type: "Microsoft.Web/sites"
      resource_group: "my-webapp-resource-group"
    event_hub:
      namespace: "my-event-hub"
      policy: "RootManageSharedAccessKey"
    log_analytics:
      name: "my-log-analytics-workspace"
      resource_group: "my-log-analytics-workspace-resource-group"
    storage_account:
      name: "mystorageaccount"
    logs:
      - category: "AppServiceHTTPLogs"
      - category: "AppServiceConsoleLogs"
      - category: "AppServiceAppLogs"
      - category: "AppServiceAuditLogs"
      - category: "AppServiceIPSecAuditLogs"
      - category: "AppServicePlatformLogs"

- name: Delete diagnostic setting
  azure_rm_monitordiagnosticsetting:
    name: "webapp-logs"
    resource:
      name: "my-webapp"
      type: "Microsoft.Web/sites"
      resource_group: "my-webapp-resource-group"
    state: "absent"

Значения возврата

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

Ключ	Описание
состояние словарь	Состояние настройки диагностики. Возвращается: всегда
event_hub словарь	Центр событий для настройки диагностики, если настроен. Возвращается: всегда
hub строка	Имя центра в пространстве имен. Возвращается: всегда Пример: `"my-event-hub"`
id строка	Идентификатор пространства имен центра событий. Возвращается: всегда Пример: `"/subscriptions/xxx/resourceGroups/my-resource-group/providers/Microsoft.EventHub/namespaces/my-event-hub-namespace"`
namespace строка	Имя пространства имен центра событий. Возвращается: всегда Пример: `"my-event-hub-namespace"`
policy строка	Имя политики общего доступа к центру событий. Возвращается: всегда Пример: `"RootManageSharedAccessKey"`
id строка	Идентификатор настройки диагностики. Возвращается: всегда Пример: `"/subscriptions/xxx/resourcegroups/my-resource-group/providers/microsoft.network/applicationgateways/my-appgw/ providers/microsoft.insights/diagnosticSettings/my-diagnostic-setting"`
log_analytics словарь	Рабочее пространство анализа журналов для настройки диагностики, если оно настроено. Возвращается: всегда
id строка	Идентификатор рабочего пространства анализа журналов. Возвращается: всегда Пример: `"/subscriptions/xxx/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-log-analytics-workspace"`
logs список / элементы=словарь	Настроенные конфигурации журналов для настройки диагностики. Возвращается: всегда
category строка	Имя категории диагностических журналов группы управления для типа ресурса, к которому применена эта настройка. Возвращается: всегда
category_group строка	Имя группы категории диагностических журналов группы управления для типа ресурса, к которому применена эта настройка. Возвращается: всегда
enabled булево	Включен ли данный журнал. Возвращается: всегда
retention_policy словарь	Политика хранения для данного журнала. Возвращается: всегда
days целое число	Количество дней для политики хранения. Возвращается: всегда
enabled булево	Включена ли политика хранения. Возвращается: всегда
metrics список / элементы=словарь	Включенные метрики для настройки диагностики. Возвращается: всегда
category строка	Имя категории метрики диагностики для типа ресурса, к которому применена эта настройка. Возвращается: всегда
enabled булево	Включена ли категория метрики. Возвращается: всегда

END_OF_DOCUMENT_MARKER

retention_policy dictionary	Политика хранения данных метрик. Возвращается: всегда
days integer	Количество дней для политики хранения. Возвращается: всегда
enabled boolean	Включена ли политика хранения. Возвращается: всегда
name string	Имя параметра настройки диагностики. Возвращается: всегда Пример: `"my-diagnostic-setting"`
storage_account dictionary	Учетная запись хранения для параметра настройки диагностики (если настроена). Возвращается: всегда
id string	Идентификатор учетной записи хранения. Возвращается: всегда Пример: `"/subscriptions/xxx/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"`

Авторы

Ross Bender (@l3ender)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_monitordiagnosticsetting_module.html