Модуль azure.azcollection.azure_rm_devtestlabvirtualmachine — Управление экземпляром виртуальной машины 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.
Добавлен в 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 строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
adfs_authority_url строка добавлен в azure.azcollection 0.0.1 | URL-адрес авторитета Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном авторитете ADFS. |
allow_claim строка | Указывает, может ли другой пользователь стать владельцем виртуальной машины. |
api_profile строка добавлен в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию По умолчанию: |
append_tags булево | Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты:
|
artifacts список / элементы=словарь | Артефакты, которые необходимо установить на виртуальную машину. |
|
parameters список / элементы=словарь |
Параметры артефакта. |
|
name строка |
Имя параметра артефакта. |
|
value строка |
Значение параметра артефакта. |
|
source_name строка |
Имя источника артефакта. |
|
source_path строка |
Путь к артефакту в источнике репозитория. |
auth_source строка добавлен в azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть задан через переменную окружения При значении При значении При значении При значении При значении
Варианты:
|
cert_validation_mode строка добавлен в azure.azcollection 0.0.1 | Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack может потребоваться отключение этого поведения, передав Варианты:
|
client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала или управляемой учетной записи (msi). Также может быть задан через переменную среды |
cloud_environment строка добавлен в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполнено обнаружение экземпляра при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляра, так и проверку подлинности авторизации. Эта функция предназначена для использования в сценариях, где метаданные конечная точка недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра подразумевает извлечение метаданных авторизации из https://login.microsoft.com/ для проверки подлинности авторизации. Установив это значение в **True**, отключается проверка подлинности авторизации. Поэтому крайне важно убедиться, что настроенный хост авторизации является действительным и надежным. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
disallow_public_ip_address string | Указывает, должно ли виртуальная машина создаваться без общедоступного IP-адреса. |
expiration_date string | Дата истечения срока действия виртуальной машины. |
image dictionary | Ссылка на образ виртуальной машины из Microsoft Azure Marketplace. |
|
offer string |
Предложение галерейного образа. |
|
os_type string |
Тип ОС галерейного образа. |
|
publisher string |
Издатель галерейного образа. |
|
sku string |
SKU галерейного образа. |
|
version string |
Версия галерейного образа. |
lab_name string / обязательно | Название лаборатории. |
lab_subnet any | Существующая подсеть в виртуальной сети лаборатории. Может быть идентификатором ресурса подсети. Может быть словарем, который содержит |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательно | Имя виртуальной машины. |
notes string | Примечания к виртуальной машине. |
os_type string | Базовый тип операционной системы. Варианты:
|
password string | Пароль администратора виртуальной машины. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секретный ключ Azure. Используется при аутентификации с помощью принципала службы. |
ssh_key string | Ключ SSH администратора виртуальной машины. |
state string | Утверждение состояния виртуальной машины. Используйте Варианты:
|
storage_type string | Тип хранилища для использования для виртуальной машины. Варианты:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tags dictionary | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов. |
tenant string | Идентификатор клиента Azure. Используйте при аутентификации с помощью сервисного принципала. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток цифрового сертификата частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью сервисного принципала. Требуется, если определён x509_certificate_path. |
user_name string | Имя пользователя виртуальной машины. |
vm_size string | Действительное значение размера виртуальной машины Azure. Например, Список вариантов зависит от подписки и расположения. Проверьте доступные варианты для вашей подписки. Доступные значения можно найти на этом сайте, ссылка https://docs.microsoft.com/ru-ru/azure/virtual-machines/windows/sizes-general. Требуется, когда state=present. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к X509 сертификату, используемому для создания сервисного принципала в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью сервисного принципала. |
Примечания
Примечание
- Для аутентификации с 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: Create (or update) Virtual Machine
azure_rm_devtestlabvirtualmachine:
resource_group: myrg
lab_name: mylab
name: myvm
notes: Virtual machine notes....
os_type: linux
vm_size: Standard_A2_v2
user_name: vmadmin
password: ZSuppas$$21!
lab_subnet:
name: myvnSubnet
virtual_network_name: myvn
disallow_public_ip_address: false
image:
offer: 0001-com-ubuntu-server-focal
publisher: Canonical
sku: 20_04-lts
os_type: Linux
version: latest
artifacts:
- source_name: myartifact
source_path: "/Artifacts/linux-install-mongodb"
allow_claim: false
expiration_date: "2019-02-22T01:49:12.117974Z"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
compute_id string | Идентификатор базового ресурса виртуальной машины Compute. Возвращается: всегда Пример: |
fqdn string | Полное доменное имя или IP-адрес виртуальной машины. Возвращается: всегда Пример: |
id string | Идентификатор ресурса виртуальной машины DTL. Возвращается: всегда Пример: |
Ссылки на сборку
© 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_module.html