azure_rm_resourcegroup - Управление группами ресурсов Azure.

Новая версия с 2.1.

Обзор
Требования (для хоста, на котором выполняется модуль)
Параметры
Примеры
Значения возврата
Примечания
- Статус

Обзор

Создание, обновление и удаление группы ресурсов.

Требования (для хоста, на котором выполняется модуль)

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`.
force	нет			Удаляет группу ресурсов и все связанные с ней ресурсы. Используется со значением 'absent' для удаления группы ресурсов, содержащей ресурсы.
location	нет			Расположение Azure для группы ресурсов. Требуется при создании новой группы ресурсов. Не может быть изменено после создания группы ресурсов.
name	да			Имя группы ресурсов.
password	нет			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile	нет			Профиль безопасности, найденный в файле ~/.azure/credentials.
secret	нет			Секрет клиента Azure. Используется при аутентификации с сервисным принципалом.
state	нет	present	absent present	Утверждает состояние группы ресурсов. Используйте 'present' для создания или обновления и 'absent' для удаления. Когда 'absent', группа ресурсов, содержащая ресурсы, не будет удалена, если не используется параметр force.
subscription_id	нет			Ваш идентификатор подписки Azure.
tags	нет			Словарь пар строка:строка для назначения метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant	нет			Идентификатор Azure-тенанта. Используется при аутентификации с сервисным принципалом.

Примеры

- 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	{'location': 'westus', 'provisioning_state': 'Succeeded', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing', 'name': 'Testing', 'tags': {'testing': 'no', 'delete': 'on-exit'}}

Примечания

Примечание

Для аутентификации с 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_resourcegroup_module.html