azure_rm_virtualmachine_facts – Получение фактов о виртуальных машинах

Новое в версии 2.7.

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

Описание

Получить факты обо всех виртуальных машинах группы ресурсов.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не сервисного принципала.
adfs_authority_url строка добавлен в 2.6		URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлен в 2.5	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source строка добавлен в 2.5	Варианты: auto cli credential_file env msi	Определяет источник учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также можно установить через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-сервисов. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить эту функцию, передав `ignore`. Также можно настроить через профиль в файле учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
cloud_environment строка добавлен в 2.4	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также можно установить через профиль в файле учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
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 facts for all virtual machines of a resource group
  azure_rm_virtualmachine_facts:
    resource_group: myResourceGroup

- name: Get facts by name
  azure_rm_virtualmachine_facts:
    resource_group: myResourceGroup
    name: myVm

- name: Get facts by tags
  azure_rm_virtualmachine_facts:
    resource_group: myResourceGroup
    tags:
      - testing
      - foo:bar

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

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

Ключ			Возвращаемое значение	Описание
vms сложный			всегда	Список виртуальных машин.
	admin_username строка		всегда	Имя пользователя администратора. Пример: admin
	data_disks сложный		всегда	Список подключенных дисков данных.
		caching строка		Тип кэширования диска данных. Пример: ReadOnly
		disk_size_gb целое число		Начальный размер диска в ГБ для пустых дисков данных Пример: 64
		lun целое число		Логический номер устройства для диска данных
		managed_disk_type строка		Тип управляемого диска данных Пример: Standard_LRS
	id строка		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm
	image сложный		всегда	Спецификация образа.
		id строка	при создании из пользовательского образа	Идентификатор ресурса пользовательского образа. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage
		offer строка	при создании из образа из Marketplace	Предложение. Пример: RHEL
		publisher строка	при создании из образа из Marketplace	Название издателя. Пример: RedHat
		sku строка	при создании из образа из Marketplace	Название SKU. Пример: 7-RAW
		version строка	при создании из образа из Marketplace	Версия образа. Пример: 7.5.2018050901
	location строка		всегда	Расположение ресурса. Пример: japaneast
	name строка		всегда	Имя ресурса. Пример: myVm
	network_interface_names список			Список подключенных сетевых интерфейсов. Пример: ['myNetworkInterface']
	os_disk_caching строка			Тип кэширования диска ОС. Пример: ReadOnly
	os_type строка			Базовый тип операционной системы. Пример: Linux
	power_state строка			Состояние питания виртуальной машины. Пример: running
	resource_group строка			Группа ресурсов. Пример: myResourceGroup
	state строка			Состояние ресурса. Пример: present
	tags словарь			Теги.
	vm_size строка			Размер виртуальной машины. Пример: Standard_D4

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Gustavo Muniz do Carmo (@gustavomcarmo)
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.8/modules/azure_rm_virtualmachine_facts_module.html