azure_rm_resourcegroup — Управление группами ресурсов Azure.
Новая версия с 2.1.
Обзор
- Создание, обновление и удаление группы ресурсов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. | |
| adfs_authority_url (добавлено в 2.6) | Значение по умолчанию: null | URL-адрес центра авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном центре авторизации ADFS. |
| api_profile (добавлено в 2.5) | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags bool |
| Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом поле любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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. |
| force bool |
| Удаление группы ресурсов и всех связанных ресурсов. Используется со значением 'absent' для удаления группы ресурсов, содержащей ресурсы. |
| location | Расположение Azure для группы ресурсов. Требуется при создании новой группы ресурсов. Не может быть изменено после создания группы ресурсов. | |
| name обязательно | Имя группы ресурсов. | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| secret | Секрет клиента Azure. Используется при аутентификации со службой-принципалом. | |
| state |
| Утверждает состояние группы ресурсов. Используется 'present' для создания или обновления и 'absent' для удаления. При 'absent' группа ресурсов, содержащая ресурсы, не будет удалена, если не используется параметр force. |
| subscription_id | Ваш идентификатор подписки Azure. | |
| tags | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | |
| tenant | Идентификатор клиента 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 a resource group
azure_rm_resourcegroup:
name: Testing
location: westus
tags:
testing: testing
delete: never
- name: Delete a resource group
azure_rm_resourcegroup:
name: Testing
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| contains_resources bool | всегда | Содержит ли группа ресурсов связанные ресурсы. Пример: True |
| state dict | всегда | Текущее состояние группы ресурсов. Пример: {'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing', 'location': 'westus', 'name': 'Testing', 'provisioning_state': 'Succeeded', 'tags': {'delete': 'on-exit', 'testing': 'no'}} |
Статус
Этот модуль помечен как предварительный, что означает, что интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сертифицированный, что означает, что его поддерживает партнер Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых партнером Ansible, см. здесь.
Автор
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
Подсказка
Если вы заметите проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/azure_rm_resourcegroup_module.html
