azure_rm_virtualmachinescalesetinstance_info – Получение фактов экземпляров группы виртуальных машин Azure Scale Set

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

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

Обзор

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

Псевдонимы: azure_rm_virtualmachinescalesetinstance_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`.
instance_id -		Идентификатор экземпляра виртуальной машины.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо сервисного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов.
secret строка		Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала.
subscription_id строка		Ваш идентификатор подписки Azure.
tags -		Ограничить результаты, предоставив список тегов. Формат тегов: 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала.
vmss_name - / обязательно		Имя группы виртуальных машин.

Примечания

Примечание

Для аутентификации в 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход в Azure CLI: Как войти в систему с помощью команды az login.

Примеры

- name: List VM instances in Virtual Machine ScaleSet
  azure_rm_virtualmachinescalesetinstance_info:
    resource_group: myResourceGroup
    vmss_name: myVMSS

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

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

Ключ		Возвращаемое значение	Описание
instances сложный		всегда	Список словарей, содержащих сведения о виртуальной машине масштабирования.
	id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/my VMSS/virtualMachines/2
	instance_id строка	всегда	Идентификатор экземпляра виртуальной машины.
	latest_model логическое значение	всегда	Применена ли последняя модель. Пример: True
	name строка	всегда	Имя виртуальной машины. Пример: myVMSS_2
	power_state строка	всегда	Состояние подготовки питания виртуальной машины. Пример: running
	provisioning_state строка	всегда	Состояние подготовки виртуальной машины. Пример: Succeeded
	tags словарь	всегда	Теги ресурса. Пример: {'tag1': 'abc'}
	vm_id строка	всегда	Идентификатор виртуальной машины Пример: 94a141a9-4530-46ac-b151-2c7ff09aa823

Статус

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

Авторы

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