azure.azcollection.azure_rm_devtestlabvirtualmachine – Управление экземпляром виртуальной машины Azure DevTest Lab

Примечание

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

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

Для использования в playbook, укажите: azure.azcollection.azure_rm_devtestlabvirtualmachine.

Введено в версии 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.
allow_claim строка				Указывает, может ли другой пользователь принять на себя владение виртуальной машиной.
api_profile строка добавлено в 0.0.1 azure.azcollection			По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево			Варианты: no да ←	Используется для управления тем, является ли поле тегов стандартным или просто добавляется к существующим тегам. Когда стандартное, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
artifacts список / элементы=строка				Артефакты, которые будут установлены на виртуальной машине.
	parameters список / элементы=строка			Параметры артефакта.
		name строка		Имя параметра артефакта.
		value строка		Значение параметра артефакта.
	source_name строка			Имя источника артефакта.
	source_path строка			Путь артефакта в репозитории источника.
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.
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`.
disallow_public_ip_address строка				Указывает, будет ли виртуальная машина создана без общедоступного IP-адреса.
expiration_date строка				Дата истечения срока действия ВМ.
image строка				Ссылка на изображение виртуальной машины из Microsoft Azure Marketplace.
	offer строка			Предложение галереи изображений.
	os_type строка			Тип ОС галереи изображений.
	publisher строка			Издатель галереи изображений.
	sku строка			SKU галереи изображений.
	version строка			Версия галереи изображений.
lab_name строка / обязательно				Имя лаборатории.
lab_subnet строка				Существующая подсеть в виртуальной сети лаборатории. Может быть идентификатором ресурса подсети. Может быть словарем, содержащим `virtual_network_name` и `name`.
name строка / обязательно				Имя виртуальной машины.
notes строка				Примечания к виртуальной машине.
os_type строка			Варианты: windows linux	Базовый тип операционной системы.
password строка				Пароль администратора виртуальной машины.
profile строка				Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно				Имя группы ресурсов.
secret строка				Секрет клиента Azure. Используется при аутентификации с главным принципом службы.
ssh_key строка				Ключ SSH администратора виртуальной машины.
state строка			Варианты: absent present ←	Утвердить состояние виртуальной машины. Используйте `present` для создания или обновления виртуальной машины и `absent` для ее удаления.
storage_type строка			Варианты: standard premium	Тип хранилища для использования с виртуальной машиной.
subscription_id строка				Идентификатор вашей подписки Azure.
tags словарь				Словарь пар ключ-значение строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant строка				Идентификатор Azure-арендатора. Используется при аутентификации с главным принципом службы.
user_name строка				Имя пользователя виртуальной машины.
vm_size строка				Действительное значение размера ВМ Azure. Например, `Standard_D4`. Список вариантов зависит от подписки и расположения. Проверьте доступные варианты для вашей подписки. Доступные значения можно найти на этом веб-сайте, ссылка https://docs.microsoft.com/ru-ru/azure/virtual-machines/windows/sizes-general. Требуется при state=present.

Примечания

Примечание

Для аутентификации с 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) Virtual Machine
  azure_rm_devtestlabvirtualmachine:
    resource_group: myrg
    lab_name: mylab
    name: myvm
    notes: Virtual machine notes....
    os_type: linux
    vm_size: Standard_A2_v2
    user_name: vmadmin
    password: ZSuppas$$21!
    lab_subnet:
      name: myvnSubnet
      virtual_network_name: myvn
    disallow_public_ip_address: no
    image:
      offer: UbuntuServer
      publisher: Canonical
      sku: 16.04-LTS
      os_type: Linux
      version: latest
    artifacts:
      - source_name: myartifact
        source_path: "/Artifacts/linux-install-mongodb"
    allow_claim: no
    expiration_date: "2019-02-22T01:49:12.117974Z"

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

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

Ключ	Возвращаемое значение	Описание
compute_id строка	всегда	Идентификатор базового ресурса виртуальной машины Compute. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm
fqdn строка	всегда	Полное доменное имя или IP-адрес виртуальной машины. Пример: myvm.eastus.cloudapp.azure.com
id строка	всегда	Идентификатор ресурса виртуальной машины DTL. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm

Авторы

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_devtestlabvirtualmachine_module.html