community.azure.azure_rm_manageddisk – Управление управляемыми дисками Azure
Примечание
Этот плагин является частью коллекции community.azure (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.azure.
Для использования в плейбуке укажите: community.azure.azure_rm_manageddisk.
Обзор
- Создание, обновление и удаление управляемого диска Azure.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала. | |
| adfs_authority_url строка добавлено в 0.0.1 azure.azcollection | URL-адрес службы Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS. | |
| api_profile строка добавлено в 0.0.1 azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для публичных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags булево |
| Управляет тем, будет ли поле тегов каноничным или добавляться к существующим тегам. При каноническом формате все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| attach_caching строка |
| Политика кэширования диска, управляемая виртуальной машиной. Будет использоваться при подключении к виртуальной машине, определённой в managed_by. Если этот параметр отличается от текущей политики кэширования, управляемый диск будет отключён и подключён снова с текущими параметрами кэширования. |
| auth_source строка добавлено в 0.0.1 azure.azcollection |
| Управляет источником используемых учетных данных для аутентификации. Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При значении auto (по умолчанию) приоритет имеет: параметры модуля -> env -> credential_file -> cli. При значении env, учетные данные будут считываться из переменных средыПри значении credential_file, профиль будет считан из ~/.azure/credentials.При значении cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для указания идентификатора подписки, если их несколько, в противном случае используется по умолчанию подписка az cli.При значении msi, хост-машина должна быть ресурсом Azure с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка.Параметр msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлено в 0.0.1 azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла с учетными данными или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала. | |
| cloud_environment строка добавлено в 0.0.1 azure.azcollection | По умолчанию: "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=копия, значение должно быть больше или равно размеру источника. | |
| location строка | Действительное расположение Azure. По умолчанию — расположение группы ресурсов. | |
| lun целое число | Логический номер устройства для диска данных. Это значение используется для идентификации дисков данных внутри виртуальной машины, и поэтому должно быть уникальным для каждого диска данных, подключённого к виртуальной машине. | |
| managed_by строка | Имя существующей виртуальной машины, с которой связан или будет связан диск. Эта виртуальная машина должна находиться в той же группе ресурсов. Для отсоединения диска от виртуальной машины явно задайте значение ''. Если этот параметр не задан, значение не изменится. | |
| name строка / обязательно | Имя управляемого диска. | |
| os_type строка |
| Тип операционной системы. Используется при create_option=копия или create_option=импорт, если источник — системный диск. Если при создании опущен, значение не задаётся. Если опущен при обновлении, изменение не происходит. После установки это значение нельзя очистить. |
| 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) — для стандартных SSD.Premium_LRS — для премиум SSD.UltraSSD_LRS (добавлен в 2.8) — для ультра SSD (превью-режим, доступен только на некоторых типах экземпляров).См. https://docs.microsoft.com/ru-ru/azure/virtual-machines/windows/disks-types для получения дополнительной информации о типах дисков. |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags словарь | Теги для назначения управляемому диску. Форматируйте теги как 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор Azure-тенанта. Используйте при аутентификации с помощью службы-принципала. | |
| zone строка |
| Зона управляемого диска Azure. Допустимые значения — 1, 2, 3 и ' '. |
Примечания
Примечание
- Этот модуль назывался community.azure.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
community.azure.azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
disk_size_gb: 4
- name: Create managed operating system disk from page blob
community.azure.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
community.azure.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
community.azure.azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
disk_size_gb: 4
- name: Delete managed disk
community.azure.azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | всегда | Изменился ли ресурс. |
| id dictionary | всегда | Идентификатор управляемого диска. |
| state dictionary | всегда | Текущее состояние управляемого диска. |
Авторы
- 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.10/collections/community/azure/azure_rm_manageddisk_module.html
