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

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

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

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user -		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо служебного принципала.
adfs_authority_url - добавлено в 2.6	Значение по умолчанию: null	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	Варианты: validate ignore	Управляет поведением проверки сертификата для 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_virtualmachine_scaleset. В 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 вы можете передать параметры, установить переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью служебного принципала или пользователя 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 в среде.

Примеры

- name: Get facts for a virtual machine scale set
  azure_rm_virtualmachine_scaleset_facts:
    resource_group: Testing
    name: testvmss001
    format: curated

- name: Get facts for all virtual networks
  azure_rm_virtualmachine_scaleset_facts:
    resource_group: Testing

- name: Get facts by tags
  azure_rm_virtualmachine_scaleset_facts:
    resource_group: Testing
    tags:
      - testing

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

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

Ключевые данные			Возвращаемое значение	Описание
vmss сложный			всегда	Список наборов виртуальных машин масштабирования
	admin_username строка		всегда	Имя пользователя администратора, используемого для доступа к хосту после его создания. Пример: adminuser
	capacity целое число		всегда	Ёмкость набора виртуальных машин масштабирования. Пример: 2
	data_disks сложный		всегда	Список подключенных дисков данных.
		caching строка		Тип кэширования диска данных. Пример: ReadOnly
		disk_size_gb целое число		Начальный размер диска в ГБ для пустых дисков данных Пример: 64
		lun целое число		Логический номер устройства (LUN) для диска данных
		managed_disk_type строка		Тип управляемого диска данных Пример: Standard_LRS
	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
	resource_group строка		всегда	Группа ресурсов. Пример: testrg
	ssh_password_enabled булево		всегда	Включена ли аутентификация по паролю SSH. Действительно только для Linux. Пример: True
	subnet_name строка		всегда	Имя подсети. Пример: testsubnet
	tier строка		всегда	Уровень SKU. Пример: Basic
	upgrade_policy строка		всегда	Политика обновления. Пример: Manual
	virtual_network_name строка		всегда	Имя связанной виртуальной сети. Пример: testvn
	vm_size строка		всегда	Размер виртуальной машины. Пример: Standard_D4

Статус

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

Авторы

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.7/modules/azure_rm_virtualmachine_scaleset_facts_module.html