azure_rm_image - Управление образами Azure.
Новое в версии 2.5.
Обзор
- Создание, удаление образа из виртуальной машины, URI BLOB, управляемого диска или снимка.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | По умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags | По умолчанию: yes | Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом режиме любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут получены из профиля Azure CLI по умолчанию.Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точке. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или взаимодействии с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | По умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. |
| cloud_environment (добавлен в 2.4) | По умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| data_disk_sources | Список источников данных диска, включая URI BLOB без управления, идентификатор или имя управляемого диска или идентификатор или имя снимка. | |
| location | Расположение образа. Определяется из resource_group, если не указано. | |
| name обязательно | Имя образа. | |
| os_type |
| Тип ОС образа. |
| password | По умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. |
| profile | По умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group обязательно | Имя группы ресурсов. | |
| secret | По умолчанию: None | Секрет клиента Azure. Используется при аутентификации с принципалом службы. |
| source обязательно | Источник диска ОС из той же области, включая идентификатор или имя виртуальной машины, URI BLOB диска ОС, идентификатор или имя управляемого диска ОС или идентификатор или имя снимка ОС. | |
| state |
| Утверждение состояния образа. Используйте present для создания или обновления образа и absent для удаления образа. |
| subscription_id | По умолчанию: None | Идентификатор вашей подписки Azure. |
| tags | По умолчанию: None | Словарь пар строка:строка, которые нужно назначить в качестве метаданных объекту. Теги метаданных объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в false. |
| tenant | По умолчанию: None | Идентификатор клиента 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 | успешно | Путь к ресурсу образа. |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/azure_rm_image_module.html
