azure_rm_managed_disk - Управление управляемыми дисками Azure
Новое в версии 2.4.
Описание
- Создание, обновление и удаление управляемого диска Azure
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. |
| 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 | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group обязательно | Имя группы ресурсов, где управляемый диск существует или будет создан. | |
| secret | Секрет клиента 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 | Ваш идентификатор подписки Azure. | |
| tags | Теги для назначения управляемому диску. | |
| 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 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 | всегда | Текущее состояние управляемого диска |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Обслуживание
Этот модуль помечен как сообщество, что означает, что его обслуживает сообщество Ansible. Смотрите Поддержка и обслуживание модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- Бруно Медина (@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.6/modules/azure_rm_managed_disk_module.html