azure_rm_availabilityset — Управление набором доступности Azure.
Новая версия 2.4.
Описание
- Создание, обновление и удаление набора доступности Azure. Набор доступности не может быть обновлён, его необходимо создать заново. Единственное обновление — для тегов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | По умолчанию: None | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags | По умолчанию: yes | Управляет тем, является ли поле тегов стандартным или просто добавляет существующим тегам. При стандартном значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При значении cli, учетные данные будут получены из профиля Azure CLI по умолчанию.Также может быть задано через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлено в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно задать через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id | По умолчанию: None | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. |
| cloud_environment (добавлено в 2.4) | По умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес точки входа в обнаружение метаданных (необходимо для Azure Stack). Также можно задать через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. |
| location | По умолчанию: местоположение ресурсной группы | Действительное местоположение azure. По умолчанию — местоположение ресурсной группы. |
| name обязательно | Имя набора доступности. | |
| password | По умолчанию: None | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. |
| platform_fault_domain_count | По умолчанию: 3 | Домены отказов определяют группу виртуальных машин, которые используют общее электропитание и сетевой коммутатор. Должно быть значение от 1 до 3. По умолчанию 3. |
| platform_update_domain_count | По умолчанию: 5 | Области обновления обозначают группы виртуальных машин и базового физического оборудования, которые можно перезагрузить одновременно. По умолчанию 5. |
| profile | По умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group обязательно | Имя ресурсной группы, где существует или будет создан набор доступности. | |
| secret | По умолчанию: None | Секрет клиента Azure. Используйте при аутентификации с принципалом службы. |
| sku |
| Определяет, поддерживает ли набор доступности управляемые диски. |
| state |
| Утверждает состояние набора доступности. Используйте 'present' для создания или обновления набора доступности и 'absent' для удаления набора доступности. |
| subscription_id | По умолчанию: None | Идентификатор вашей подписки Azure. |
| tags | По умолчанию: None | Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные тегов объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. |
| tenant | По умолчанию: None | Идентификатор 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 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 | всегда | Текущее состояние набора доступности |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- 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.5/modules/azure_rm_availabilityset_module.html
