azure.azcollection.azure_rm_monitorlogprofile – Управление профилем журнала Azure Monitor

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

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

Новое в версии 0.0.1: из azure.azcollection

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

Обзор

Создание, обновление и удаление экземпляра профиля журнала Azure Monitor.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 0.0.1 из azure.azcollection			URL авторитета Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS.
api_profile строка добавлено в 0.0.1 из azure.azcollection		По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево		Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 из azure.azcollection		Варианты: авто ← cli credential_file env msi	Управление источником учетных данных для аутентификации. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `auto` (по умолчанию) приоритет имеет: параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, учетные данные будут считываться из переменных среды При установке в `credential_file`, профиль будет считываться из `~/.azure/credentials`. При установке в `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут быть использованы для идентификации идентификатора подписки, если их несколько; в противном случае используется стандартная подписка Azure CLI. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
categories список / элементы=строка			Список категорий журналов. Эти категории создаются удобным для пользователя способом. Некоторые значения: `Write`, `Delete` и/или `Action`.
cert_validation_mode строка добавлено в 0.0.1 из azure.azcollection		Варианты: ignore validate	Управление поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 из azure.azcollection		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
location строка			Расположение ресурса.
locations список / элементы=строка			Список регионов, в которых должны храниться события журналов активности.
name строка / обязательно			Уникальное имя профиля журнала для создания или обновления.
password строка			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
retention_policy словарь			Политика хранения событий в журнале.
	days целое число		Количество дней для хранения. Значение 0 означает неограниченное хранение событий.
	enabled булево	Варианты: нет да	Включена ли политика хранения.
secret строка			Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
service_bus_rule_id строка			Идентификатор правила службы обмена сообщениями пространства имён службы обмена сообщениями, в котором вы хотите создать Event Hubs для потоковой передачи в журнал активности. Формат: {service_bus_resource_id}/authorizationrules{key_name}.
state строка		Варианты: отсутствует присутствует ←	Утверждение состояния профиля журнала. Используйте `present` для создания или обновления профиля журнала и `absent` для его удаления.
storage_account сырой			Учётная запись хранения, в которую отправляются журналы активности. Это может быть идентификатор ресурса. Это может быть словарь, содержащий resource_grorup и name.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка для назначения метаданных объекту. Метаданные-теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка			Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.

Примечания

Примечание

Для аутентификации с 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 a log profile
  azure_rm_monitorlogprofile:
    name: myProfile
    location: eastus
    locations:
      - eastus
      - westus
    categories:
      - Write
      - Action
    retention_policy:
      enabled: False
      days: 1
    storage_account:
      resource_group: myResourceGroup
      name: myStorageAccount
  register: output

- name: Delete a log profile
  azure_rm_monitorlogprofile:
    name: myProfile
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
id string	всегда	Идентификатор профиля логов. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/microsoft.insights/logprofiles/myProfile

Авторы

Yunge Zhu(@yungezz)

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