Модуль azure.azcollection.azure_rm_devtestlabvirtualmachine_info – Получение фактов о виртуальных машинах Azure DevTest Lab
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для ее установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: azure.azcollection.azure_rm_devtestlabvirtualmachine_info.
Введено в azure.azcollection 0.1.2
Обзор
- Получение фактов о виртуальной машине Azure DevTest Lab.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- Хост, на котором выполняется этот модуль, должен иметь установленную коллекцию azure.azcollection через Galaxy.
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection.
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Может также быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Может также быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
lab_name string / required | Имя лаборатории. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя виртуальной машины. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / required | Имя группы ресурсов. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags list / elements=string | Ограничить результаты, предоставив список тегов. Формат тегов «ключ» или «ключ:значение». |
tenant string | Идентификатор Azure-аренды. Используется при аутентификации с помощью Сервисного принципала. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Сервисного принципала. Требуется, если определено x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания сервисного принципала в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью Сервисного принципала. |
Примечания
Примечание
- Для аутентификации с 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 instance of DTL Virtual Machine
azure_rm_devtestlabvirtualmachine_info:
resource_group: myResourceGroup
lab_name: myLab
name: myVm
tags:
- key:value
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
virtualmachines complex | Список словарей, содержащих факты для виртуальной машины DevTest Lab. Возвращается: всегда |
|
compute_vm_id string |
Идентификатор ресурса вычислительной виртуальной машины. Возвращается: всегда Пример: |
|
compute_vm_name string |
Имя вычислительной виртуальной машины. Возвращается: всегда Пример: |
|
compute_vm_resource_group string |
Группа ресурсов, в которой создана вычислительная виртуальная машина. Возвращается: всегда Пример: |
|
disallow_public_ip_address boolean |
Следует ли запретить публичный IP-адрес. Возвращается: всегда Пример: |
|
expiration_date string |
Дата истечения срока действия виртуальной машины. Возвращается: всегда Пример: |
|
fqdn string |
Полностью квалифицированное доменное имя. Возвращается: всегда Пример: |
|
id string |
Идентификатор виртуальной машины. Возвращается: всегда Пример: |
|
image complex |
Ссылка на образ из галереи. Возвращается: всегда |
|
offer string |
Предложение образа из галереи. Возвращается: при создании из образа галереи Пример: |
|
os_type string |
Тип операционной системы. Возвращается: при создании из образа галереи Пример: |
|
publisher string |
Издатель образа из галереи. Возвращается: при создании из образа галереи Пример: |
|
sku string |
SKU образа из галереи. Возвращается: при создании из образа галереи Пример: |
|
version string |
Версия образа из галереи. Возвращается: при создании из образа галереи Пример: |
|
lab_name string |
Имя лаборатории. Возвращается: всегда Пример: |
|
name string |
Имя виртуальной машины. Возвращается: всегда Пример: |
|
notes string |
Примечания к виртуальной машине. Возвращается: всегда Пример: |
|
os_type string |
Тип операционной системы. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки виртуальной сети. Возвращается: всегда Пример: |
|
resource_group string |
Имя группы ресурсов. Возвращается: всегда Пример: |
|
storage_type string |
Тип хранилища для использования виртуальной машины. Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: всегда Пример: |
|
user_name string |
Имя администратора. Возвращается: всегда Пример: |
|
vm_size string |
Размер виртуальной машины. Возвращается: всегда Пример: |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_devtestlabvirtualmachine_info_module.html