azure_rm_image — Управление изображениями Azure.
Новое в версии 2.5.
Обзор
- Создание и удаление изображений из виртуальных машин, URI блобов, управляемых дисков или снимков.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала. | |
| adfs_authority_url (добавлено в 2.6) | По умолчанию: null | URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственными полномочиями ADFS. |
| api_profile (добавлено в 2.5) | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags bool |
| Управление тем, является ли поле тегов каноническим или оно только добавляет метки к существующим. При каноническом режиме любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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. |
| data_disk_sources | Список источников данных диска, включая URI блоба неуправляемого типа, идентификатор или имя управляемого диска или идентификатор или имя снимка. | |
| location | Расположение изображения. Выводится из resource_group, если не указано. | |
| name обязательно | Имя изображения. | |
| os_type |
| Тип ОС изображения. |
| password | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group обязательно | Имя группы ресурсов. | |
| secret | Секрет клиента Azure. Используйте при аутентификации с помощью службы-принципала. | |
| source обязательно | Источник диска ОС из того же региона, включая идентификатор или имя виртуальной машины, URI блоба диска ОС, идентификатор или имя управляемого диска ОС или идентификатор или имя снимка ОС. | |
| state |
| Утвердить состояние изображения. Используйте present для создания или обновления изображения и absent для удаления изображения. |
| subscription_id | Идентификатор вашей подписки Azure. | |
| tags | Словарь пар строка:строка, назначаемый в качестве метаданных объекту. Метки метаданных объекта будут обновлены с предоставленными значениями. Для удаления меток установите параметр append_tags в false. | |
| tenant | Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала. |
Примечания
Примечание
- Для аутентификации с Azure можно передать параметры, установить переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью службы-принципала или пользователя 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 в среде.
Примеры
- name: Create an image from a virtual machine
azure_rm_image:
resource_group: Testing
name: foobar
source: testvm001
- name: Create an image from os disk
azure_rm_image:
resource_group: Testing
name: foobar
source: /subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Compute/disks/disk001
data_disk_sources:
- datadisk001
- datadisk002
os_type: Linux
- name: Delete an image
azure_rm_image:
state: absent
resource_group: Testing
name: foobar
source: testvm001
Возвращаемые значения
Общие значения, возвращаемые модулями, описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id str | успех | Путь к ресурсу изображения. |
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантируется обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Yuwei Zhou (@yuwzho)
Подсказка
Если вы обнаружите проблемы в этом документе, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/azure_rm_image_module.html
