azure.azcollection.azure_rm_virtualmachinescalesetinstance_info – Получение фактов экземпляра группы масштабирования виртуальных машин Azure

Примечание

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

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

Для использования в playbook укажите: azure.azcollection.azure_rm_virtualmachinescalesetinstance_info.

Новое в версии 0.1.2: из azure.azcollection

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

Описание

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

Требования

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

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` могут использоваться для указания идентификатора подписки, если их несколько, в противном случае используется стандартная подписка Azure 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`.
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, или выполнить вход перед запуском задач или playbook с 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: 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
	image_reference словарь	всегда	Ссылка на образ Пример: {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myGroup/providers/Microsoft.Compute/galleries/ myGallery/images/myImage/versions/10.1.3'}
	instance_id строка	всегда	Идентификатор экземпляра виртуальной машины.
	latest_model логическое	всегда	Применена ли последняя модель. Пример: True
	name строка	всегда	Имя виртуальной машины. Пример: myVMSS_2
	power_state строка	всегда	Состояние электропитания виртуальной машины. Пример: running
	provisioning_state строка	всегда	Состояние подготовки виртуальной машины. Пример: Succeeded
	tags словарь	всегда	Теги ресурса. Пример: {'tag1': 'abc'}
	vm_id строка	всегда	Идентификатор виртуальной машины Пример: 94a141a9-4530-46ac-b151-2c7ff09aa823

Авторы

Зим Калиновский (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_virtualmachinescalesetinstance_info_module.html