Spec-Zone.ru › Ansible

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

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in 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

added in 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

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен с помощью профиля файла учетных данных или переменной среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in 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

Ограничивает результаты одной настройкой диагностики в ресурсе.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource

any / required

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

Это может быть строка, содержащая идентификатор ресурса.

Это может быть словарь, содержащий 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.
  • Для аутентификации через службу принципала передайте 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

ID учетной записи хранилища.

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

Пример: "/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_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API