community.azure.azure_rm_managed_disk – Управление дисками Azure
Примечание
Этот плагин является частью коллекции community.azure (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.azure.
Для использования в плейбуке укажите: community.azure.azure_rm_managed_disk.
Обзор
- Создание, обновление и удаление управляемого диска 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=copy, значение должно быть больше или равно размеру источника. | |
| location строка | Действительное расположение Azure. По умолчанию — расположение группы ресурсов. | |
| lun целое число | Логический номер устройства для диска данных. Это значение используется для идентификации дисков данных внутри ВМ, поэтому оно должно быть уникальным для каждого диска данных, подключённого к ВМ. | |
| managed_by строка | Имя существующей виртуальной машины, с которой связан или будет связан диск; эта ВМ должна находиться в той же группе ресурсов. Для отключения диска от ВМ явно установите значение ''. Если этот параметр не задан, значение не будет изменено. | |
| name строка / обязательно | Имя управляемого диска. | |
| os_type строка |
| Тип операционной системы. Используется при create_option=copy или create_option=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/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 словарь | всегда | Идентификатор ресурса управляемого диска. |
| state словарь | всегда | Текущее состояние управляемого диска. |
Авторы
- 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_managed_disk_module.html
