azure.azcollection.azure_rm_manageddisk – Управление дисками Azure
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_manageddisk.
Новое в версии 0.1.2: of azure.azcollection
Описание
- Создание, обновление и удаление управляемого диска Azure.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| adfs_authority_url строка добавлено в 0.0.1 of azure.azcollection | URL-адрес источника авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственном источнике авторизации ADFS. | |
| api_profile строка добавлено в 0.0.1 of azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags логическое |
| Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. Когда каноническое, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| attach_caching строка |
| Политика кэширования диска, управляемая ВМ. Будет использоваться при подключении к ВМ, определенной в managed_by.Если этот параметр отличается от текущей политики кэширования, управляемый диск будет отключен и подключен с текущим параметром кэширования снова. |
| auth_source строка добавлено в 0.0.1 of 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 of azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси-сервера HTTPS или Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано в профиле файла учетных данных или переменной среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. | |
| cloud_environment строка добавлено в 0.0.1 of 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) — для стандартного твердотельного диска.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 строка |
| Зона управляемого диска Azure. Допустимые значения — 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_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/azure/azcollection/azure_rm_manageddisk_module.html
