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

Новая версия 2.4.

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

Описание

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

Псевдонимы: azure_rm_virtualmachine_scaleset_facts

Требования

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

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`.
format - добавлен в 2.6	Варианты: curated raw ←	Формат возвращаемых данных. Если выбран `raw`, информация будет возвращена в формате raw из Azure Python SDK. Если выбран `curated`, структура будет идентична входным параметрам модуля azure_rm_virtualmachinescaleset. В Ansible 2.5 и ниже факты всегда возвращаются в формате raw. Обратите внимание, что этот параметр будет устаревать в версии 2.10, когда формат curated станет единственным поддерживаемым форматом.
name -		Ограничить результаты определённой группой виртуальных машин.
password -		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
profile строка		Профиль безопасности в файле ~/.azure/credentials.
resource_group -		Группа ресурсов для поиска необходимой группы виртуальных машин.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала.
subscription_id строка		Идентификатор вашей Azure-подписки.
tags -		Список тегов для соответствия.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью службы-принципала.

Примечания

Примечание

Этот модуль назывался azure_rm_virtualmachine_scaleset_facts до Ansible 2.8. Способ использования не изменился.
Для аутентификации с 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 a virtual machine scale set
  azure_rm_virtualmachinescaleset_facts:
    resource_group: myResourceGroup
    name: testvmss001
    format: curated

- name: Get facts for all virtual networks
  azure_rm_virtualmachinescaleset_facts:
    resource_group: myResourceGroup

- name: Get facts by tags
  azure_rm_virtualmachinescaleset_facts:
    resource_group: myResourceGroup
    tags:
      - testing

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

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

Ключ			Возвращаемое значение	Описание
vmss сложный			всегда	Список наборов виртуальных машин масштабирования
	admin_username строка		всегда	Имя пользователя администратора, используемое для доступа к хосту после его создания. Пример: adminuser
	capacity целое число		всегда	Емкость набора виртуальных машин масштабирования. Пример: 2
	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/scalesets/myscaleset
	image сложный		всегда	Спецификация образа
		offer строка		Предложение. Пример: RHEL
		publisher строка		Имя издателя. Пример: RedHat
		sku строка		Имя SKU. Пример: 7-RAW
		version строка		Версия образа. Пример: 7.5.2018050901
	load_balancer строка		всегда	Имя балансировщика нагрузки. Пример: testlb
	location строка		всегда	Расположение ресурса. Пример: japaneast
	managed_disk_type строка		всегда	Тип управляемого диска данных Пример: Standard_LRS
	name строка		всегда	Имя ресурса. Пример: myvmss
	os_disk_caching строка		всегда	Тип кэширования диска ОС. Пример: ReadOnly
	os_type строка		всегда	Базовый тип операционной системы. Пример: Linux
	overprovision булево			Указывает, следует ли избыточно выделять ресурсы для набора виртуальных машин масштабирования. Пример: True
	resource_group строка		всегда	Группа ресурсов. Пример: myResourceGroup
	ssh_password_enabled булево		всегда	Включена ли аутентификация по паролю SSH. Действительно только для Linux. Пример: True
	subnet_name строка		всегда	Имя подсети. Пример: testsubnet
	tags словарь			Теги, назначенные ресурсу. Словарь пар строка:строка. Пример: {'tag1': 'abc'}
	tier строка		всегда	Уровень SKU. Пример: Basic
	upgrade_policy строка		всегда	Политика обновления. Пример: Manual
	virtual_network_name строка		всегда	Имя связанной виртуальной сети. Пример: testvn
	vm_size строка		всегда	Размер виртуальной машины. Пример: Standard_D4

Статус

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

Авторы

Sertac Ozercan (@sozercan)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

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