azure.azcollection.azure_rm_devtestlabvirtualmachine – Управление экземпляром виртуальной машины Azure DevTest Lab
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_devtestlabvirtualmachine.
Новое в версии 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. | |||
| allow_claim строка | Указывает, может ли другой пользователь принять на себя владение виртуальной машиной. | |||
| api_profile строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | ||
| append_tags булево |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. | ||
| artifacts список / элементы=строка | Артефакты, которые должны быть установлены на виртуальной машине. | |||
| parameters список / элементы=строка | Параметры артефакта. | |||
| name строка | Имя параметра артефакта. | |||
| value строка | Значение параметра артефакта. | |||
| source_name строка | Имя источника артефакта. | |||
| source_path строка | Путь артефакта в репозитории источника. | |||
| 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. | ||
| disallow_public_ip_address строка | Указывает, должна ли виртуальная машина создаваться без общедоступного IP-адреса. | |||
| expiration_date строка | Дата истечения срока действия виртуальной машины. | |||
| image строка | Ссылка на образы Microsoft Azure Marketplace виртуальной машины. | |||
| offer строка | Предложение галереи образов. | |||
| os_type строка | Тип ОС галереи образов. | |||
| publisher строка | Издатель галереи образов. | |||
| sku строка | SKU галереи образов. | |||
| version строка | Версия галереи образов. | |||
| lab_name строка / обязательно | Имя лаборатории. | |||
| lab_subnet строка | Существующий подсеть в виртуальной сети лаборатории. Он может быть идентификатором ресурса подсети. Он может быть словарем, который содержит virtual_network_name и name. | |||
| name строка / обязательно | Имя виртуальной машины. | |||
| notes строка | Примечания к виртуальной машине. | |||
| os_type строка |
| Базовый тип операционной системы. | ||
| password строка | Пароль администратора виртуальной машины. | |||
| profile строка | Профиль безопасности в файле ~/.azure/credentials. | |||
| resource_group строка / обязательно | Имя группы ресурсов. | |||
| secret строка | Секрет клиента Azure. Используется при аутентификации с главным принципом службы. | |||
| ssh_key строка | Ключ SSH администратора виртуальной машины. | |||
| state строка |
| Утверждение состояния виртуальной машины. Используйте present, чтобы создать или обновить виртуальную машину, и absent, чтобы её удалить. | ||
| storage_type строка |
| Тип хранилища для виртуальной машины. | ||
| subscription_id строка | Идентификатор вашей Azure-подписки. | |||
| tags словарь | Словарь пар строка:строка, которые будут назначены в качестве метаданных объекту. Теги метаданных объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false. | |||
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с главным принципом службы. | |||
| user_name строка | Имя пользователя виртуальной машины. | |||
| vm_size строка | Допустимое значение размера Azure VM. Например, Standard_D4. Список вариантов зависит от подписки и расположения. Проверьте доступные варианты для вашей подписки. Доступные значения можно найти на этом веб-сайте: https://docs.microsoft.com/ru-ru/azure/virtual-machines/windows/sizes-general. Требуется при state=present. | |||
Примечания
Примечание
- Для аутентификации с 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: no
image:
offer: UbuntuServer
publisher: Canonical
sku: 16.04-LTS
os_type: Linux
version: latest
artifacts:
- source_name: myartifact
source_path: "/Artifacts/linux-install-mongodb"
allow_claim: no
expiration_date: "2019-02-22T01:49:12.117974Z"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| compute_id строка | всегда | Идентификатор базового ресурса виртуальной машины Compute. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm |
| fqdn строка | всегда | Полное доменное имя или IP-адрес виртуальной машины. Пример: myvm.eastus.cloudapp.azure.com |
| id строка | всегда | Идентификатор ресурса виртуальной машины DTL. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm |
Авторы
- 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_module.html
