azure_rm_image – Управление изображениями Azure.
Новая версия с 2.5.
Обзор
- Создание, удаление изображения из виртуальной машины, URI BLOB, управляемого диска или моментального снимка.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 boolean |
| Управление тем, является ли поле тегов каноническим или оно просто добавляет к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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 BLOB без управления, идентификатор или имя управляемого диска или идентификатор или имя моментального снимка. | |
| location - | Расположение изображения. Выводится из resource_group, если не указано. | |
| name - / обязательно | Имя изображения. | |
| os_type - |
| Тип операционной системы изображения. |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile - | Профиль безопасности в файле ~/.azure/credentials. | |
| resource_group - / обязательно | Имя группы ресурсов. | |
| secret - | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | |
| source - / обязательно | Источник диска ОС из того же региона, включая идентификатор или имя виртуальной машины, URI BLOB диска ОС, идентификатор или имя управляемого диска ОС или идентификатор или имя моментального снимка ОС. | |
| 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 строка | успех | Путь к ресурсу изображения. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/azure_rm_image_module.html
