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

Примечание

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

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

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

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

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

Обзор

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

Требования

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

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.
author строка		Автор пользовательской образа.
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`.
description строка		Описание пользовательского образа.
lab_name строка / обязательно		Название лаборатории.
linux_os_state строка	Варианты: non_deprovisioned deprovision_requested deprovision_applied	Состояние операционной системы Linux.
name строка / обязательно		Название пользовательского образа.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
source_vm строка		Имя виртуальной машины DevTest Lab-источника.
state строка	Варианты: absent present ←	Утверждение состояния пользовательского образа. Используйте `present` для создания или обновления пользовательского образа, и `absent` для его удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false.
tenant строка		Идентификатор арендатора Azure. Используйте при аутентификации с принципалом службы.
windows_os_state строка	Варианты: non_sysprepped sysprep_requested sysprep_applied	Состояние операционной системы Windows.

Примечания

Примечание

Для аутентификации в 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 instance of DevTest Lab Image
  azure_rm_devtestlabcustomimage:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myImage
    source_vm: myDevTestLabVm
    linux_os_state: non_deprovisioned

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

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

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

Авторы

Zim Kalinowski (@zikalino)

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