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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 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"`
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"`
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`
event_hub dictionary	Центр событий, в который будут поступать журналы диагностики. Для параметра диагностики необходимо указать как минимум один из параметров storage_account, log_analytics или event_hub.
hub string	Имя центра событий, в который будут поступать журналы. Если имя не указано, будет выбран центр событий по умолчанию.
namespace string / обязательный	Пространство имен центра событий.
policy string / обязательный	Политика общего доступа.
resource_group string	Группа ресурсов, содержащая центр событий. Если не указана, будет использоваться группа ресурсов параметра resource.
subscription_id string	Идентификатор подписки, содержащей центр событий. Если не указан, будет использоваться идентификатор подписки параметра resource.
log_analytics any	Рабочая область Log Analytics, в которую будут поступать журналы диагностики. Можно указать строку с идентификатором ресурса рабочей области Log Analytics. Можно указать словарь с параметром name и необязательными параметрами subscription_id и resource_group. Для параметра диагностики необходимо указать как минимум один из параметров storage_account, log_analytics или event_hub.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
logs list / элементы=dictionary	Список параметров журналирования. Для параметра диагностики необходимо указать как минимум один из параметров metrics или logs.
category string	Имя категории журнала диагностики группы управления для типа ресурса, к которому применяется этот параметр.
category_group string	Имя группы категорий журналов диагностики группы управления для типа ресурса, к которому применяется этот параметр.
enabled boolean	Включено ли журналирование. Варианты: `false` `true` ← (по умолчанию)
retention_policy dictionary	Политика хранения для этого журнала.
days integer	Количество дней хранения по политике. По умолчанию: `0`
enabled boolean	Включена ли политика хранения. Варианты: `false` `true` ← (по умолчанию)
metrics list / элементы=dictionary	Список параметров метрик. Для параметра диагностики необходимо указать как минимум один из параметров metrics или logs.
category string	Имя категории диагностических метрик для типа ресурса, к которому применяется этот параметр.
enabled boolean	Включена ли категория метрик. Варианты: `false` `true` ← (по умолчанию)
retention_policy dictionary	Политика хранения для этой метрики.
days integer	Количество дней хранения по политике. По умолчанию: `0`
enabled boolean	Включена ли политика хранения. Варианты: `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 any / обязательный	Ресурс, мониторинг которого будет выполняться с помощью параметра диагностики. Можно указать строку с идентификатором ресурса. Можно указать словарь с параметрами name, type, resource_group и необязательным параметром subscription_id. name. Имя ресурса. type. Тип ресурса вместе с пространством имен, например ‘Microsoft.Network/virtualNetworks’. resource_group. Группа ресурсов, содержащая ресурс. subscription_id. Идентификатор подписки, содержащей ресурс. Если не указан, будет использоваться идентификатор подписки из учетных данных.
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.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации с помощью субъекта-службы передайте 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"

Возвращаемые значения

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

Ключ	Описание
state словарь	Состояние параметра диагностики. Возвращается: всегда
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 словарь	Рабочая область Log Analytics для параметра диагностики, если она настроена. Возвращается: всегда
id строка	Идентификатор рабочей области Log Analytics. Возвращается: всегда Пример: `"/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 логическое значение	Определяет, включена ли категория метрик. Возвращается: всегда
retention_policy словарь	Политика хранения для категории метрик. Возвращается: всегда
days целое число	Количество дней хранения. Возвращается: всегда
enabled логическое значение	Определяет, включена ли политика хранения. Возвращается: всегда
name строка	Имя параметра диагностики. Возвращается: всегда Пример: `"my-diagnostic-setting"`
storage_account словарь	Учётная запись хранения для параметра диагностики, если она настроена. Возвращается: всегда
id строка	Идентификатор учётной записи хранения. Возвращается: всегда Пример: `"/subscriptions/xxx/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"`

Авторы

Ross Bender (@l3ender)

Ссылки на коллекцию

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