azure.azcollection.azure_rm_devtestlabcustomimage – Управление экземпляром пользовательского образа Azure DevTest Lab

Примечание

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

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

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

Новое в версии 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	Варианты: авто ← 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.
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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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–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_devtestlabcustomimage_module.html