Модуль azure.azcollection.azure_rm_multiplemanageddisks – Управление несколькими управляемыми дисками Azure
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, подробности см. в разделе Требования.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_multiplemanageddisks.
Новое в azure.azcollection 1.14.0
Описание
- Создание, обновление и удаление одного или нескольких управляемых дисков Azure.
- Этот модуль также может использоваться для подключения/отключения дисков к/от одному или нескольким виртуальным машинам.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, на котором выполняется модуль, должна быть установлена коллекция azure.azcollection через Galaxy
- Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес центра проверки подлинности Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный центр проверки подлинности ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть задано через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Choices:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть задано через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных центра проверки подлинности с https://login.microsoft.com/ для проверки центра проверки подлинности. Установив это значение в **True**, проверка центра проверки подлинности отключается. В результате важно убедиться, что настроенный хост центра проверки подлинности является действительным и заслуживающим доверия. Задается через профиль файла учетных данных или переменную среды Choices:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
managed_by_extended list / elements=dictionary | Список имен и групп ресурсов виртуальных машин для управляемых дисков. Когда state=present, диски будут присоединены к указанному списку виртуальных машин. Когда state=present, используйте [], чтобы отсоединить диски от всех виртуальных машин. Когда state=absent и этот параметр определен, диски будут отсоединены от списка виртуальных машин. Когда state=absent и этот параметр не определен, диски будут удалены. |
|
name string |
Имя присоединенной виртуальной машины. |
|
resource_group string |
Группа ресурсов присоединенной виртуальной машины. |
managed_disks список / элементы=словарь | Список управляемых дисков для создания, обновления или удаления. |
|
attach_caching строка |
Политика кэширования диска, управляемая ВМ. Будет использоваться при подключении к ВМ, определенной в Если этот параметр отличается от текущей политики кэширования, управляемый диск будет отключен и подключен снова с текущим параметром кэширования. Доступные значения:
|
|
create_option строка |
Доступные значения:
|
|
disk_size_gb целое число |
Размер управляемого диска в ГБ, который будет создан. Требуется, когда create_option=empty. Если create_option=copy, значение должно быть больше или равно размеру исходного диска. |
|
location строка |
Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. |
|
lun целое число |
Логический номер устройства для диска данных. Это значение используется для идентификации дисков данных внутри ВМ, и поэтому должно быть уникальным для каждого диска данных, подключенного к ВМ. |
|
целое число |
Максимальное количество ВМ, которые могут подключиться к диску одновременно. Значение больше единицы указывает на диск, который может быть смонтирован на нескольких ВМ одновременно. |
|
name строка / обязательный |
Имя управляемого диска. |
|
os_type строка |
Тип операционной системы. Используется, когда create_option=copy или create_option=import, и исходный диск — системный. Если опущено при создании, значение не устанавливается. Если опущено при обновлении, изменения не вносятся. После установки это значение нельзя очистить. Доступные значения:
|
|
resource_group строка / обязательный |
Имя группы ресурсов, где управляемый диск существует или будет создан. |
|
source_uri алиасы: source_resource_uri строка |
URI файла VHD или идентификатор ресурса управляемого диска для копирования. Требуется, когда create_option=import или create_option=copy. |
|
storage_account_id строка |
Полный путь к учетной записи хранения, откуда необходимо импортировать образ. Требуется, когда create_option=import. |
|
storage_account_type строка |
Тип хранилища для управляемого диска. Если не указан, диск создается как
См. https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types для получения дополнительной информации о типах дисков. Доступные значения:
|
|
zone строка |
Зона управляемого диска Azure. Допустимые значения: Доступные значения:
|
password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципом службы. |
profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. |
secret строка | Секрет клиента Azure. Используется при аутентификации с принципом службы. |
состояние строка | Установите состояние управляемых дисков. Используйте Используйте Варианты:
|
subscription_id строка | Идентификатор вашей подписки Azure. |
метки словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток на ресурсах. |
арендатор строка | Идентификатор аренды Azure. Используется при аутентификации с помощью принципала службы. |
отпечаток строка добавлен в azure.azcollection 1.14.0 | Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Требуется, если определен x509_certificate_path. |
x509_certificate_path путь добавлен в azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью принципала службы. |
Примечания
Примечание
- Для аутентификации в 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход с помощью Azure CLI
-
Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Create managed operating system disks from page blob and attach them to a list of VMs
azure_rm_multiplemanageddisks:
managed_disks:
- name: mymanageddisk1
location: eastus2
resource_group: myResourceGroup
create_option: import
source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
os_type: windows
storage_account_type: Premium_LRS
- name: mymanageddisk2
location: eastus2
resource_group: myResourceGroup
create_option: import
source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
os_type: windows
storage_account_type: Premium_LRS
managed_by_extended:
- resource_group: myResourceGroupTest
name: TestVM
- name: Detach disks from the VMs specified in the list
azure_rm_multiplemanageddisks:
state: absent
managed_disks:
- name: mymanageddisk1
location: eastus2
resource_group: myResourceGroup
create_option: import
source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
os_type: windows
storage_account_type: Premium_LRS
- name: mymanageddisk2
location: eastus2
resource_group: myResourceGroup
create_option: import
source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
os_type: windows
storage_account_type: Premium_LRS
managed_by_extended:
- resource_group: myResourceGroupTest
name: TestVM1
- resource_group: myResourceGroupTest
name: TestVM2
- name: Detach managed disks from all VMs without deletion
azure_rm_multiplemanageddisks:
state: present
managed_disks:
- name: mymanageddisk1
location: eastus2
resource_group: myResourceGroup
- name: mymanageddisk2
location: eastus2
resource_group: myResourceGroup
managed_by_extended: []
- name: Detach managed disks from all VMs and delete them
azure_rm_multiplemanageddisks:
state: absent
managed_disks:
- name: mymanageddisk1
location: eastus2
resource_group: myResourceGroup
- name: mymanageddisk2
location: eastus2
resource_group: myResourceGroup
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
state сложный | Текущее состояние управляемых дисков. Возвращается: всегда |
|
create_option строка |
Параметр создания диска. Возвращается: успех Пример: |
|
disk_size_gb строка |
Размер управляемого диска в ГБ, который будет создан. Возвращается: успех |
|
id строка |
Идентификатор ресурса. Возвращается: успех |
|
location строка |
Допустимое расположение Azure. Возвращается: успех |
|
managed_by строка |
Имя существующей виртуальной машины, с которой диск связан или будет связан. Эта виртуальная машина должна находиться в той же группе ресурсов. Возвращается: успех |
|
managed_by_extended список / элементы=строка |
Идентификатор списка существующей виртуальной машины, с которой диск связан или будет связан. Возвращается: успех Пример: |
|
целое число |
Максимальное количество ВМ, которые могут одновременно подключиться к диску. Значение больше единицы указывает на диск, который может быть смонтирован на нескольких ВМ одновременно. Возвращается: успех Пример: |
|
name строка |
Имя управляемого диска. Возвращается: успех |
|
os_type строка |
Тип операционной системы. Возвращается: успех Пример: |
|
source_uri строка |
URI файла VHD или идентификатор ресурса управляемого диска для копирования. Возвращается: успех |
|
storage_account_id строка |
Полный путь к учетной записи хранилища, из которой необходимо импортировать образ. Возвращается: успех Пример: |
|
storage_account_type строка |
Тип хранилища для управляемого диска. Дополнительную информацию об этом типе см. в https://docs.microsoft.com/ru-ru/azure/virtual-machines/windows/disks-types. Возвращается: успех Пример: |
|
tags словарь |
Теги для назначения управляемому диску. Возвращается: успех Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_multiplemanageddisks_module.html