azure_rm_availabilityset - Управление набором доступности Azure.
Новое в версии 2.4.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создание, обновление и удаление набора доступности Azure. Обновление набора доступности невозможно; вместо этого необходимо создать новый. Единственное обновление — для тегов.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательно | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | ||
| append_tags | нет | True | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| client_id | нет | Идентификатор клиента Azure. Используется при аутентификации со служебным принципалом. | ||
| cloud_environment | нет | 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. По умолчанию 3 | |
| platform_update_domain_count | нет | 5 | Области обновления указывают группы виртуальных машин и базового физического оборудования, которые могут быть перезагружены одновременно. По умолчанию 5. | |
| profile | нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group | да | Имя группы ресурсов, в которой существует или будет создан набор доступности. | ||
| secret | нет | Секрет клиента Azure. Используется при аутентификации со служебным принципалом. | ||
| sku | нет | Классический |
| Определяет, поддерживает ли набор доступности управляемые диски. |
| state | нет | present |
| Утверждение состояния набора доступности. Используйте 'present' для создания или обновления набора доступности и 'absent' для удаления набора доступности. |
| subscription_id | нет | Ваш идентификатор подписки Azure. | ||
| tags | нет | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные-теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | ||
| tenant | нет | Идентификатор клиента Azure. Используется при аутентификации со служебным принципалом. |
Примеры
- name: Create an availability set with default options
azure_rm_availabilityset:
name: myavailabilityset
location: eastus
resource_group: Testing
- name: Create an availability set with advanced options
azure_rm_availabilityset:
name: myavailabilityset
location: eastus
resource_group: Testing
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: Testing
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие являются полями, уникальными для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| changed | Изменилось ли ресурс | всегда | bool | |
| state | Текущее состояние набора доступности | всегда | dict |
Примечания
Примечание
- Для аутентификации в 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 в среде.
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если вам это интересно, прочитайте Справочную информацию по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_availabilityset_module.html
