модуль azure.azcollection.azure_rm_monitordiagnosticsetting_info — Получение сведений о параметрах диагностики 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_info.

Добавлено в 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`
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 any / обязательный	Ресурс, который будет отслеживаться с помощью параметра диагностики. Это может быть строка, содержащая идентификатор ресурса. Это может быть словарь, содержащий name, type, resource_group и, необязательно, subscription_id. name. Имя ресурса. type. Тип ресурса, включая пространство имен, например ‘Microsoft.Network/virtualNetworks’. resource_group. Группа ресурсов, содержащая ресурс. subscription_id. Идентификатор подписки, содержащей ресурс. Если он не указан, используется идентификатор подписки из учетных данных.
secret string	Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы.
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: Get all diagnostic settings for a resource
  azure_rm_monitordiagnosticsetting_info:
    resource: "/subscriptions/my-resource-group/resourceGroups/my-resource-group/providers/Microsoft.Web/sites/my-web-app"

- name: Get all diagnostic settings for a resource using a dictionary
  azure_rm_monitordiagnosticsetting_info:
    resource:
      name: "my-web-app"
      type: "Microsoft.Web/sites"
      resource_group: "my-resource-group"

- name: Get a specific diagnostic setting
  azure_rm_monitordiagnosticsetting_info:
    name: "my-diagnostic-setting"
    resource: "/subscriptions/my-resource-group/resourceGroups/my-resource-group/providers/Microsoft.Network/virtualNetworks/my-vnet"

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

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

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