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 |
| Управление источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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 |
| Управление поведением проверки сертификатов для 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. По умолчанию 3 |
| platform_update_domain_count - | По умолчанию: 5 | Область обновления указывает группы виртуальных машин и базового физического оборудования, которое может быть перезагружено одновременно. По умолчанию 5. |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - / обязательно | Имя группы ресурсов, где существует или будет создан набор доступности. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с сервисным принципалом. | |
| sku - |
| Определение, поддерживает ли набор доступности управляемые диски. |
| 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. Также возможно добавить дополнительные профили. Укажите профиль, передав 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 | всегда | Изменился ли ресурс |
| state словарь | всегда | Текущее состояние набора доступности |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.8/modules/azure_rm_availabilityset_module.html