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

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_loganalyticsworkspace.

Новое в версии 0.1.2: of azure.azcollection

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

Обзор

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

Требования

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

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 булево	Варианты: no да ←	Управляет тем, является ли поле тегов каноническим или просто добавляет теги к существующим. Когда канонический, любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 azure.azcollection	Варианты: auto ← 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.
cert_validation_mode строка добавлен в 0.0.1 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		ID клиента Azure. Используйте при аутентификации служебным принципалом.
cloud_environment строка добавлен в 0.0.1 azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки доступа к метаданным (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
force булево	Варианты: нет ← да	Удаляет рабочее пространство без возможности восстановления. Рабочее пространство, удалённое с этим флагом, не может быть восстановлено.
intelligence_packs словарь		Управление возможными пакетами интеллектуальных решений для данного рабочего пространства. Включить пакет, установив значение `true`. Например, "Backup:true". Выключить пакет, установив значение `false`. Например, "Backup:false". Другие пакеты интеллектуальных решений, не перечисленные в этом свойстве, не будут изменены.
location строка		Местоположение ресурса.
name строка / обязательно		Имя рабочего пространства.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов.
retention_in_days строка		Срок хранения данных рабочего пространства в днях. -1 означает неограниченное хранение для sku=unlimited. 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 строка		ID 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 string	успех	Путь к ресурсу рабочей области. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/m yLogAnalyticsWorkspace
intelligence_packs список / элементы=строка	успех	Список всех возможных пакетов интеллектуального анализа и информация о том, включены они или отключены для данной рабочей области. Пример: [{'name': 'CapacityPerformance'}, {'enabled': True}]
location строка	успех	Расположение ресурса. Пример: eastus
management_groups словарь	успех	Управляющие группы, подключенные к рабочей области. Пример: {'value': []}
retention_in_days целое число	успех	Срок хранения данных в рабочей области в днях. -1 означает неограниченное хранение для sku=unlimited. 730 дней — максимальный срок для всех других SKU. Пример: 40
shared_keys словарь	успех	Общие ключи для рабочей области. Пример: {'primarySharedKey': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'secondarySharedKey': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'}
sku строка	успех	SKU рабочей области. Пример: per_gb2018
usages словарь	успех	Метрики использования для рабочей области. Пример: {'value': [{'currentValue': 0, 'limit': 524288000, 'name': {'localizedValue': 'Обработанные данные', 'value': 'DataAnalyzed'}, 'nextResetTime': '2017-10-03T00:00:00Z', 'quotaPeriod': 'P1D', 'unit': 'Байты'}]}

Авторы

Ювей Чжоу (@yuwzho)

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