azure_rm_loganalyticsworkspace – Управление рабочими пространствами Azure Log Analytics

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

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

Обзор

Создание, удаление рабочих пространств Azure Log Analytics.

Требования

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

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 логическое	Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В случае канонического значения любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5	Варианты: auto 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.
cert_validation_mode строка добавлено в 2.5	Варианты: ignore validate	Управление поведением проверки сертификатов для 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`.
intelligence_packs словарь		Управление возможными пакетами интеллектуального анализа для этого рабочего пространства. Включить пакет, установив значение `true`. Например, {'Backup': true}. Выключить пакет, установив значение `false`. Например, {'Backup': false}. Другие пакеты интеллектуального анализа, не указанные в этом свойстве, не будут изменены.
location -		Расположение ресурса.
name - / обязательно		Имя рабочего пространства.
password -		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов.
retention_in_days -		Срок хранения данных рабочего пространства в днях. -1 означает неограниченное хранение для `unlimited` `sku`. 730 дней — максимальный разрешенный срок для всех остальных `sku`.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала.
sku -	Варианты: free standard premium unlimited per_node per_gb2018 ← standalone	SKU рабочего пространства.
state -	Варианты: absent present ←	Утверждение состояния изображения. Используйте `present` для создания или обновления изображения и `absent` для удаления изображения.
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 workspace with backup enabled
  azure_rm_loganalyticsworkspace:
    resource_group: myResourceGroup
    name: myLogAnalyticsWorkspace
    intelligence_pack:
        Backup: true

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

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

Ключ	Возвращаемое значение	Описание
id строка	успех	Путь к ресурсу рабочей области.
intelligence_packs список	успех	Список всех возможных пакетов интеллектуального анализа и их включение/выключение для данной рабочей области.
location строка	успех	Расположение ресурса.
management_groups список	успех	Список групп управления, подключенных к рабочей области.
retention_in_days целое число	успех	Срок хранения данных в рабочей области в днях. -1 означает неограниченное хранение для `unlimited` `sku`. 730 дней — максимальное значение для всех остальных `sku`.
shared_keys список	успех	Общие ключи для рабочей области.
sku строка	успех	SKU рабочей области
usages список	успех	Список метрик использования для рабочей области.

Статус

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

Авторы

Yuwei Zhou (@yuwzho)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_loganalyticsworkspace_module.html