azure.azcollection.azure_rm_devtestlabvirtualmachine_info module – Получение сведений о виртуальной машине Azure DevTest Lab

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 добавлено в azure.azcollection 0.0.1	URL-адрес центра Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS.
api_profile string добавлено в azure.azcollection 0.0.1	Выбирает профиль API для обмена данными со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
auth_source string добавлено в azure.azcollection 0.0.1	Определяет источник учетных данных, используемых для аутентификации. Также можно задать с помощью переменной окружения `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. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string добавлено в azure.azcollection 0.0.1	Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав значение `ignore`. Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с субъектом-службой или управляемым удостоверением (msi). Также можно задать с помощью переменной окружения `AZURE_CLIENT_ID`.
cloud_environment string добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Значение true полностью отключает обнаружение экземпляров и проверку центра. Эта функция предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Обнаружение экземпляров предполагает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если установить значение True, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной окружения `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
lab_name string / обязательный	Имя лаборатории.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string	Имя виртуальной машины.
oidc_token string добавлено в azure.azcollection 3.17.0	Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной окружения `AZURE_FEDERATED_TOKEN`.
oidc_token_file_path path добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения `AZURE_FEDERATED_TOKEN_FILE`.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с учетной записью пользователя Active Directory, а не с субъектом-службой.
profile string	Профиль безопасности из файла ~/.azure/credentials.
resource_group string / обязательный	Имя группы ресурсов.
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.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации через субъект-службу передайте 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	Идентификатор ресурса вычислительной виртуальной машины. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myLab-myVm-097933/providers/Microsoft.Compute/virtualMachines/myVm"`
compute_vm_name string	Имя вычислительной виртуальной машины. Возвращается: всегда Пример: `"myVm"`
compute_vm_resource_group string	Группа ресурсов, в которой создана вычислительная виртуальная машина. Возвращается: всегда Пример: `"myLab-myVm-097933"`
disallow_public_ip_address boolean	Указывает, запрещено ли использование общедоступного IP-адреса. Возвращается: всегда Пример: `false`
expiration_date string	Дата истечения срока действия виртуальной машины. Возвращается: всегда Пример: `"2029-02-22T01:49:12.117974Z"`
fqdn string	Полное доменное имя. Возвращается: всегда Пример: `"myvm.eastus.cloudapp.azure.com"`
id string	Идентификатор виртуальной машины. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/virt ualmachines/myVm"`
image complex	Ссылка на образ из галереи. Возвращается: всегда
offer string	Предложение образа из галереи. Возвращается: если создано на основе образа из галереи Пример: `"UbuntuServer"`
os_type string	Тип операционной системы. Возвращается: если создано на основе образа из галереи Пример: `"Linux"`
publisher string	Издатель образа из галереи. Возвращается: если создано на основе образа из галереи Пример: `"Canonical"`
sku string	SKU образа из галереи. Возвращается: если создано на основе образа из галереи Пример: `"20_04-lts"`
version string	Версия образа из галереи. Возвращается: если создано на основе образа из галереи Пример: `"latest"`
is_authentication_with_ssh_key boolean	Указывает, использует ли эта виртуальная машина ключ SSH для аутентификации. Возвращается: всегда Пример: `false`
lab_name string	Имя лаборатории. Возвращается: всегда Пример: `"myLab"`
name string	Имя виртуальной машины. Возвращается: всегда Пример: `"myVm"`
notes string	Примечания к виртуальной машине. Возвращается: всегда Пример: `"My VM notes"`
os_type string	Тип операционной системы. Возвращается: всегда Пример: `"linux"`
provisioning_state string	Состояние подготовки виртуальной сети. Возвращается: всегда Пример: `"Succeeded"`
resource_group string	Имя группы ресурсов. Возвращается: всегда Пример: `"myResourceGroup"`
storage_type string	Тип хранилища для виртуальной машины. Возвращается: всегда Пример: `"standard"`
tags dictionary	Теги ресурса. Возвращается: всегда Пример: `{"foo": "bar"}`
user_name string	Имя администратора. Возвращается: всегда Пример: `"dtl_admin"`
vm_size string	Размер виртуальной машины. Возвращается: всегда Пример: `"Standard_A2_v2"`

Авторы

Zim Kalinowski (@zikalino)

Ссылки на коллекцию

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