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

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

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

Обзор

Создание, обновление и удаление набора доступности Azure.
Набор доступности не может быть обновлен, необходимо создать новый вместо него.
Единственная операция обновления будет для тегов.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
adfs_authority_url строка добавлен в 2.6		URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой ADFS.
api_profile строка добавлен в 2.5	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логический тип	Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или просто добавляет теги к существующим. Когда канонический, любые теги, которых нет в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 2.5	Варианты: авто 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	Варианты: ignore validate	Управляет поведением проверки сертификата для 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`.
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 -	Варианты: отсутствует наличие ←	Утверждение состояния набора доступности. Используйте `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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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'}

Статус

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

Авторы

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.9/modules/azure_rm_availabilityset_module.html