community.azure.azure_rm_devtestlabvirtualmachine_info – Получение фактов о виртуальной машине Azure DevTest Lab

Примечание

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

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

Для использования в плейбуке укажите: community.azure.azure_rm_devtestlabvirtualmachine_info.

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

Обзор

Получение фактов о виртуальной машине 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.
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`.
lab_name строка / обязательно		Имя лаборатории.
name строка		Имя виртуальной машины.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секретный ключ клиента Azure. Используйте при аутентификации с помощью службы-принципала.
subscription_id строка		Ваш идентификатор Azure-подписки.
tags список / элементы=строка		Ограничьте результаты, указав список тегов. Формат тегов — 'ключ' или 'ключ:значение'.
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: Get instance of DTL Virtual Machine
  community.azure.azure_rm_devtestlabvirtualmachine_info:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myVm

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

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

Ключевые значения			Возвращаемое значение	Описание
virtualmachines сложный тип			всегда	Список словарей, содержащих факты о виртуальной машине DevTest Lab.
	compute_vm_id строка		всегда	Идентификатор ресурса виртуальной машины вычислений. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myLab-myVm-097933/providers/Microsoft.Compute/virtualMachines/myVm
	compute_vm_name строка		всегда	Имя виртуальной машины вычислений. Пример: myVm
	compute_vm_resource_group строка		всегда	Группа ресурсов, в которой создана виртуальная машина вычислений. Пример: myLab-myVm-097933
	disallow_public_ip_address логическое значение		всегда	Разрешено ли использование публичного IP-адреса?
	expiration_date строка		всегда	Дата истечения срока действия виртуальной машины. Пример: 2029-02-22T01:49:12.117974Z
	fqdn строка		всегда	Полное доменное имя. Пример: myvm.eastus.cloudapp.azure.com
	id строка		всегда	Идентификатор виртуальной машины. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/virt ualmachines/myVm
	image сложный тип		всегда	Ссылка на изображение из галереи.
		offer строка	при создании из изображения галереи	Предложение изображения из галереи. Пример: UbuntuServer
		os_type строка	при создании из изображения галереи	Тип операционной системы. Пример: Linux
		publisher строка	при создании из изображения галереи	Издатель изображения из галереи. Пример: Canonical
		sku строка	при создании из изображения галереи	SKU изображения из галереи. Пример: 16.04-LTS
		version строка	при создании из изображения галереи	Версия изображения из галереи. Пример: latest
	lab_name строка		всегда	Имя лаборатории. Пример: myLab
	name строка		всегда	Имя виртуальной машины. Пример: myVm
	notes строка		всегда	Примечания к виртуальной машине. Пример: Примечания к моей ВМ
	os_type строка		всегда	Тип операционной системы. Пример: linux
	provisioning_state строка		всегда	Состояние подготовки виртуальной сети. Пример: Успешно
	resource_group строка		всегда	Имя группы ресурсов. Пример: myResourceGroup
	storage_type строка		всегда	Тип хранения для виртуальной машины. Пример: стандартный
	tags сложный тип		всегда	Теги ресурса. Пример: { 'foo': 'bar' }
	user_name строка		всегда	Имя администраторского пользователя. Пример: dtl_admin
	vm_size строка		всегда	Размер виртуальной машины. Пример: Standard_A2_v2

Авторы

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/community/azure/azure_rm_devtestlabvirtualmachine_info_module.html