azure_rm_managed_disk - Управление управляемыми дисками Azure
Новая версия с 2.4.
Обзор
- Создание, обновление и удаление управляемого диска Azure.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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 | По умолчанию: да | Управляет тем, является ли поле тегов стандартным или оно просто добавляется к существующим тегам. Когда теги являются стандартными, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. |
| 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. |
| create_option |
| Допустимые значения: empty, import, copy. import из файла VHD в source_uri и copy с предыдущего управляемого диска source_resource_uri. |
| disk_size_gb | Размер управляемого диска в ГБ, подлежащего созданию. Если create_option равен copy, то значение должно быть больше или равно размеру источника. | |
| location | По умолчанию: местоположение группы ресурсов | Действительное расположение Azure. По умолчанию используется расположение группы ресурсов. |
| managed_by (добавлено в 2.5) | Имя существующей виртуальной машины, с которой диск связан или будет связан, эта ВМ должна находиться в той же группе ресурсов. Чтобы отсоединить диск от ВМ, оставьте неопределенным. | |
| name обязательно | Имя управляемого диска. | |
| os_type |
| Тип операционной системы: linux или windows. Используется, когда create_option равен copy или import, а источник — диск ОС. |
| password | По умолчанию: None | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала. |
| profile | По умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group обязательно | Имя группы ресурсов, в которой существует или будет создан управляемый диск. | |
| secret | По умолчанию: None | Секрет клиента Azure. Используйте при аутентификации со служебным принципалом. |
| source_resource_uri | Идентификатор ресурса управляемого диска для копирования, когда create_option равен copy. | |
| source_uri | URI до файла VHD, который будет использован, когда create_option равен import. | |
| state |
| Утвердите состояние управляемого диска. Используйте present для создания или обновления управляемого диска и 'absent' для удаления управляемого диска. |
| storage_account_type |
| Тип хранилища для управляемого диска: Standard_LRS или Premium_LRS. Если не указано, диск создается Standard_LRS. |
| subscription_id | По умолчанию: None | Ваш идентификатор подписки Azure. |
| tags | По умолчанию: None | Теги для назначения управляемому диску. |
| 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 managed disk
azure_rm_managed_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
disk_size_gb: 4
- name: Mount the managed disk to VM
azure_rm_managed_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
disk_size_gb: 4
managed_by: testvm001
- name: Unmount the managed disk to VM
azure_rm_managed_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
disk_size_gb: 4
- name: Delete managed disk
azure_rm_manage_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed bool | всегда | Изменился ли ресурс |
| id dict | всегда | Идентификатор ресурса управляемого диска. |
| state dict | всегда | Текущее состояние управляемого диска |
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Bruno Medina (@brusMX)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_managed_disk_module.html
