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 boolean	Варианты: нет да ←	Управляет тем, является ли поле тегов стандартным или добавляет теги к существующим. При стандартном значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source - добавлен в 2.5	Варианты: авто cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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	Варианты: validate ignore	Управляет поведением проверки сертификата для 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 boolean	Варианты: нет ← да	Удалить группу ресурсов и все связанные ресурсы. Используйте со значением 'absent', чтобы удалить группу ресурсов, содержащую ресурсы.
location -		Расположение Azure для группы ресурсов. Требуется при создании новой группы ресурсов. Не может быть изменено после создания группы ресурсов.
name - / обязательно		Имя группы ресурсов.
password -		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile -		Профиль безопасности, найденный в файле ~/.azure/credentials.
secret -		Секрет клиента Azure. Используется при аутентификации с принципалом службы.
state -	Варианты: absent present ←	Утвердить состояние группы ресурсов. Используйте '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 boolean	всегда	Содержит ли группа ресурсов связанные ресурсы. Пример: True
state словарь	всегда	Текущее состояние группы ресурсов. Пример: {'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing', 'location': 'westus', 'name': 'Testing', 'provisioning_state': 'Succeeded', 'tags': {'delete': 'on-exit', 'testing': 'no'}}

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнёром 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.7/modules/azure_rm_resourcegroup_module.html