azure.azcollection.azure_rm_devtestlabvirtualmachine_info – Получение фактов о виртуальной машине Azure DevTest Lab
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_devtestlabvirtualmachine_info.
Новое в версии 0.1.2: коллекции azure.azcollection
Краткое описание
- Получение фактов о виртуальной машине Azure DevTest Lab.
Требования
Ниже перечислены требования, необходимые на хосте, выполняющем этот модуль.
- 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 |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. При значении auto (по умолчанию) приоритет параметров модуля -> env -> credential_file -> cli. При значении env, учетные данные будут считываться из переменных среды.При значении credential_file, профиль будет считываться из ~/.azure/credentials. При значении cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для указания идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az cli.При значении msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.Параметр msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлено в 0.0.1 коллекции azure.azcollection |
| Управляет поведением проверки сертификатов для 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. |
| lab_name строка / обязательно | Имя лаборатории. | |
| name строка | Имя виртуальной машины. | |
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка / обязательно | Имя группы ресурсов. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с помощью сервисного принципала. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags список / элементы=строка | Ограничьте результаты, указав список тегов. Формат тегов 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор Azure-арендатора. Используйте при аутентификации с помощью сервисного принципала. |
Примечания
Примечание
- Для аутентификации в 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| 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 строка | всегда | Примечания к виртуальной машине. Пример: Примечания к моей ВМ | ||
| os_type строка | всегда | Тип операционной системы. Пример: linux | ||
| provisioning_state строка | всегда | Состояние подготовки виртуальной сети. Пример: Выполнено | ||
| resource_group строка | всегда | Имя группы ресурсов. Пример: myResourceGroup | ||
| storage_type строка | всегда | Тип хранилища для использования с виртуальной машиной. Пример: стандартный | ||
| tags сложный | всегда | Теги ресурса. Пример: { 'foo': 'bar' } | ||
| user_name строка | всегда | Имя администраторского пользователя. Пример: dtl_admin | ||
| vm_size строка | всегда | Размер виртуальной машины. Пример: Standard_A2_v2 | ||
Авторы
- Zim Kalinowski (@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_devtestlabvirtualmachine_info_module.html
