azure.azcollection.azure_rm_devtestlab – Управление экземпляром Azure DevTest Lab

Примечание

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

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

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

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

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

Обзор

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

Требования

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

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	Варианты: 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` могут использоваться для определения идентификатора подписки, если их несколько; в противном случае используется стандартная подписка az 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 строка		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 из azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, используется имя среды (определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки конечного доступа для обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
location строка		Расположение ресурса.
name строка / обязательно		Имя лаборатории.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
premium_data_disks логический тип	Варианты: нет да	Разрешить создание премиальных дисков данных.
profile строка		Профиль безопасности в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
state строка	Варианты: absent present ←	Утверждает состояние DevTest Lab. Используйте `present` для создания или обновления DevTest Lab и `absent` для его удаления.
storage_type строка	Варианты: standard premium	Тип хранилища, используемого лабораторией. Может быть либо `premium`, либо `standard`.
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 (or update) DevTest Lab
  azure_rm_devtestlab:
    resource_group: myResourceGroup
    name: mylab
    storage_type: standard

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

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

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/mylab

Авторы

Zim Kalinowski (@zikalino)

© 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_devtestlab_module.html