azure_rm_manageddisk – Управление управляемыми дисками Azure
Новая в версии 2.4.
Обзор
- Создание, обновление и удаление управляемого диска Azure
Псевдонимы: azure_rm_managed_disk
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным объектом службы. | |
| adfs_authority_url строка добавлено в 2.6 | URL-адрес источника Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственном источнике ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags логическое значение |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| attach_caching - добавлено в 2.8 |
| Политика кэширования диска, управляемая ВМ. Будет использоваться при подключении к ВМ, определенной managed_by. Если этот параметр отличается от текущей политики кэширования, управляемый диск будет отключен от ВМ и подключен снова с текущими настройками кэширования. Допустимые значения: '', только чтение, чтение/запись. |
| 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 - |
| Допустимые значения: пусто, импорт, копия. - import из файла VHD в source_uri и copy с предыдущего управляемого диска source_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_uri - | URI файла VHD для использования или идентификатор ресурса управляемого диска для копирования. псевдонимы: source_resource_uri | |
| state - |
| Утверждение состояния управляемого диска. Используйте present для создания или обновления управляемого диска и absent для удаления управляемого диска. |
| storage_account_type - |
| Тип хранилища для управляемого диска. Если не указано, диск создаётся как Standard_LRS. Standard_LRS предназначен для стандартных жёстких дисков.StandardSSD_LRS (добавлено в 2.8) предназначен для стандартных твердотельных дисков.Premium_LRS предназначен для премиальных твердотельных дисков.UltraSSD_LRS (добавлено в 2.8) предназначен для ультра-твердотельных дисков, которые находятся в режиме предварительной версии и доступны только на определённых типах экземпляров.Для получения дополнительной информации о типах дисков см. https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types. |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags словарь | Теги для назначения управляемому диску. | |
| tenant строка | Идентификатор арендатора Azure. Используется при аутентификации с главным объектом службы. | |
| zone - добавлено в 2.8 |
| Допустимые значения: 1, 2, 3, ''. |
Примечания
Примечание
- Этот модуль назывался
azure_rm_managed_diskдо Ansible 2.8. Использование не изменилось. - Для аутентификации с Azure можно передать параметры, установить переменные окружения, использовать профиль, сохранённый в ~/.azure/credentials, или войти перед выполнением задач или плейбука с
az login. - Аутентификация также возможна с использованием сервисного принципала или пользователя 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 в окружении.
См. также
См. также
- Вход с помощью Azure CLI
- Как выполнить аутентификацию, используя команду
az login.
Примеры
- name: Create managed disk
azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
disk_size_gb: 4
- name: Create managed operating system disk from page blob
azure_rm_manageddisk:
name: mymanageddisk
location: eastus2
resource_group: myResourceGroup
create_option: import
source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
os_type: windows
storage_account_type: Premium_LRS
- name: Mount the managed disk to VM
azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
disk_size_gb: 4
managed_by: testvm001
attach_caching: read_only
- name: Unmount the managed disk to VM
azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
disk_size_gb: 4
- name: Delete managed disk
azure_rm_manage_disk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
state: absent
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | всегда | Изменился ли ресурс |
| id словарь | всегда | Идентификатор управляемого диска. |
| state словарь | всегда | Текущее состояние управляемого диска |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/azure_rm_manageddisk_module.html
