azure_rm_devtestlabvirtualmachine_info – Получение фактов о виртуальных машинах Azure DevTest Lab
Новое в версии 2.9.
Описание
- Получение фактов о виртуальной машине Azure DevTest Lab.
Псевдонимы: azure_rm_devtestlabvirtualmachine_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 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды 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 |
| Управляет поведением проверки сертификатов для 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. |
| lab_name строка / обязательно | Имя лаборатории. | |
| name строка | Имя виртуальной машины. | |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка / обязательно | Имя группы ресурсов. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags список | Ограничить результаты, предоставив список тегов. Форматировать теги как 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с 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: Get instance of DTL Virtual Machine
azure_rm_devtestlabvirtualmachine_info:
resource_group: myResourceGroup
lab_name: myLab
name: myVm
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| virtualmachines сложный | всегда | Список словарей, содержащих данные о виртуальных машинах DevTest Lab. | ||
| compute_vm_id строка | всегда | Идентификатор ресурса виртуальной машины вычислений. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myLab-myVm-097933/providers/Microsoft.Compute/virtualMachines/myVm | ||
| compute_vm_name строка | всегда | Имя виртуальной машины вычислений. Пример: myVm | ||
| compute_vm_resource_group строка | всегда | Группа ресурсов, в которой создана виртуальная машина вычислений. Пример: myLab-myVm-097933 | ||
| disallow_public_ip_address логическое | всегда | Разрешить ли использование публичного IP-адреса. | ||
| expiration_date строка | всегда | Дата истечения срока действия виртуальной машины. Пример: 2029-02-22T01:49:12.117974Z | ||
| fqdn строка | всегда | Полное доменное имя. Пример: myvm.eastus.cloudapp.azure.com | ||
| id строка | всегда | Идентификатор виртуальной машины. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/virt ualmachines/myVm | ||
| image сложный | всегда | Ссылка на галерейный образ. | ||
| offer строка | при создании из галерейного образа | Предложение галерейного образа. Пример: UbuntuServer | ||
| os_type строка | при создании из галерейного образа | Тип операционной системы. Пример: Linux | ||
| publisher строка | при создании из галерейного образа | Издатель галерейного образа. Пример: Canonical | ||
| sku строка | при создании из галерейного образа | SKU галерейного образа. Пример: 16.04-LTS | ||
| version строка | при создании из галерейного образа | Версия галерейного образа. Пример: latest | ||
| lab_name строка | всегда | Имя лаборатории. Пример: myLab | ||
| name строка | всегда | Имя виртуальной машины. Пример: myVm | ||
| notes строка | всегда | Примечания к виртуальной машине. Пример: Мои заметки о VM | ||
| os_type строка | всегда | Тип операционной системы. Пример: linux | ||
| provisioning_state строка | всегда | Состояние подготовки виртуальной сети. Пример: Успешно | ||
| resource_group строка | всегда | Имя группы ресурсов. Пример: myResourceGroup | ||
| storage_type строка | всегда | Тип хранилища для использования виртуальной машины. Пример: стандартный | ||
| tags сложный | всегда | Теги ресурса. Пример: { 'foo': 'bar' } | ||
| user_name строка | всегда | Имя административного пользователя. Пример: dtl_admin | ||
| vm_size строка | всегда | Размер виртуальной машины. Пример: Standard_A2_v2 | ||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_devtestlabvirtualmachine_info_module.html
