Spec-Zone.ru › Ansible 2.10

azure.azcollection.azure_rm_availabilityset – Управление набором доступности Azure

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в книге задач укажите: azure.azcollection.azure_rm_availabilityset.

Новое в версии 0.1.2: из azure.azcollection

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Описание

  • Создание, обновление и удаление набора доступности 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
логическое
    Варианты:
  • нет
  • да ←
Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.
При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source
строка
добавлено в 0.0.1 из azure.azcollection
    Варианты:
  • авто ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задано через переменную среды 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
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификата для 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.
location
строка
Допустимое расположение Azure. По умолчанию — расположение группы ресурсов.
name
строка / обязательно
Имя набора доступности.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
platform_fault_domain_count
целое число
По умолчанию:
3
Домены отказов определяют группу виртуальных машин, которые используют общий источник питания и сетевой коммутатор.
Должно быть между 1 и 3.
platform_update_domain_count
целое число
 По умолчанию:
5
Область обновления обозначает группы виртуальных машин и базового физического оборудования, которые можно перезагружать одновременно.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка / обязательно
Имя группы ресурсов, где существует или будет создан набор доступности.
secret
строка
Секрет клиента Azure. Используется при аутентификации с принципалом службы.
sku
строка
    Варианты:
  • Classic ←
  • Aligned
Определяет, поддерживает ли набор доступности управляемые диски.
state
строка
    Варианты:
  • absent
  • present ←
Утвердить состояние набора доступности.
Используйте present для создания или обновления набора доступности и absent для удаления набора доступности.
subscription_id
строка
Идентификатор вашей Azure-подписки.
tags
словарь
Словарь пар строка:строка для назначения метаданных объекту.
Метаданные теги объекта будут обновлены любыми предоставленными значениями.
Чтобы удалить теги, установите параметр append_tags в значение false.
tenant
строка
Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации с 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 an availability set with default options
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup

- name: Create an availability set with advanced options
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup
    platform_update_domain_count: 5
    platform_fault_domain_count: 3
    sku: Aligned

- name: Delete an availability set
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup
    state: absent

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

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

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

Пример:
True
state
complex
всегда
Текущее состояние набора доступности.
id
string
успех
Идентификатор ресурса.

Пример:
/subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/availabilitySets/myavailabilityset2
location
string
успех
Расположение ресурса.

Пример:
eastus
name
string
успех
Имя ресурса.

Пример:
myavailabilityset2
platform_fault_domain_count
integer
успех
Значения областей отказа.

Пример:
2
platform_update_domain_count
integer
успех
Значения областей обновления.

Пример:
5
sku
string
успех
Набор доступности поддерживает управляемые диски.

Пример:
Aligned
tags
dictionary
успех
Теги ресурса.

Пример:
{'env': 'sandbox'}


Авторы

  • Julien Stroheker (@julienstroheker)

© 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_availabilityset_module.html

Spec-Zone.ru

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