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

Новая версия с 2.9.

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы принципала.
adfs_authority_url строка добавлено в 2.6			URL авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлено в 2.5		По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево		Варианты: нет да ←	Управляет тем, является ли поле тегов стандартным или просто добавляется к существующим тегам. При стандартном формате любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5		Варианты: авто cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может быть использована для идентификации идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` было добавлено в Ansible 2.6.
categories список			Список категорий журналов. Эти категории создаются по удобству пользователя. Некоторые значения - `Write`, `Delete` и/или `Action`.
cert_validation_mode строка добавлено в 2.5		Варианты: игнорировать валидировать	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом.
cloud_environment строка добавлено в 2.4		По умолчанию: "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 строка			Идентификатор правила службы очередей сообщений (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 строка	всегда	ID профиля ведения журнала. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/microsoft.insights/logprofiles/myProfile

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. поддержка модулей. [сообщество]

Авторы

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.9/modules/azure_rm_monitorlogprofile_module.html