Spec-Zone.ru › Ansible 2.7

azure_rm_managed_disk – Управление управляемыми дисками Azure

Новая в версии 2.4.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Создание, обновление и удаление управляемого диска Azure

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
-
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url
-
добавлено в 2.6
По умолчанию:
null
URL-адрес службы Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile
-
добавлено в 2.5
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с сервисами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят работать с Azure Stack.
append_tags
boolean
    Варианты:
  • no
  • да ←
Управляет тем, является ли поле тегов стандартным или оно просто добавляется к существующим тегам. При стандартном значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source
-
добавлено в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, будет использоваться переменная среды 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
    Варианты:
  • validate
  • ignore
Управляет поведением проверки сертификата для конечных точек 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
-
    Варианты:
  • empty
  • import
  • copy
Допустимые значения: empty, import, copy. import из файла VHD в source_uri и copy с предыдущего управляемого диска source_resource_uri.
disk_size_gb
-
Размер управляемого диска в ГБ. Если create_option равен copy, значение должно быть больше или равно размеру источника.
location
-
Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
managed_by
-
добавлено в 2.5
Имя существующей виртуальной машины, с которой связан или будет связан диск, эта ВМ должна находиться в той же группе ресурсов.
Для отсоединения диска от ВМ, оставьте неопределённым.
name
- / обязательно
Имя управляемого диска.
os_type
-
    Варианты:
  • linux
  • windows
Тип операционной системы: linux или windows. Используется, когда create_option равен либо copy, либо import, и источник является диском ОС.
password
-
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
profile
-
Профиль безопасности, находящийся в файле ~/.azure/credentials.
resource_group
- / обязательно
Имя группы ресурсов, где существует или будет создан управляемый диск.
secret
-
Секрет клиента Azure. Используется при аутентификации со служебным принципалом.
source_resource_uri
-
Идентификатор ресурса управляемого диска для копирования, когда create_option равен copy.
source_uri
-
URI действительного файла VHD, используемого при create_option равен import.
state
-
    Варианты:
  • absent
  • present ←
Утвердить состояние управляемого диска. Используйте present для создания или обновления управляемого диска и 'absent' для удаления управляемого диска.
storage_account_type
-
    Варианты:
  • Standard_LRS
  • Premium_LRS
Тип хранилища для управляемого диска: Standard_LRS или Premium_LRS Если не указано, диск создаётся Standard_LRS.
subscription_id
-
Ваш идентификатор подписки Azure.
tags
-
Теги для назначения управляемому диску.
tenant
-
Идентификатор клиента Azure. Используется при аутентификации со служебным принципалом.

Примечания

Примечание

  • Для аутентификации с Azure вы можете передать параметры, установить переменные окружения или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с использованием служебного принципала или пользователя 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 в среде.

Примеры

- name: Create managed disk
  azure_rm_managed_disk:
    name: mymanageddisk
    location: eastus
    resource_group: Testing
    disk_size_gb: 4

- name: Mount the managed disk to VM
  azure_rm_managed_disk:
    name: mymanageddisk
    location: eastus
    resource_group: Testing
    disk_size_gb: 4
    managed_by: testvm001

- name: Unmount the managed disk to VM
  azure_rm_managed_disk:
    name: mymanageddisk
    location: eastus
    resource_group: Testing
    disk_size_gb: 4

- name: Delete managed disk
  azure_rm_manage_disk:
    name: mymanageddisk
    location: eastus
    resource_group: Testing
    state: absent

Значения возврата

Общие значения возврата задокументированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ Возвращаемое значение Описание
changed
boolean
всегда
Изменился ли ресурс или нет

id
словарь
всегда
Идентификатор управляемого диска.

state
словарь
всегда
Текущее состояние управляемого диска



Статус

  • Для этого модуля не гарантируется обратная совместимость интерфейса. [предварительная версия]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • 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.7/modules/azure_rm_managed_disk_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API