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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user	Значение по умолчанию: None	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы.
api_profile (добавлено в 2.5)	Варианты: latest ←	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags	Значение по умолчанию: yes	Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source (добавлено в 2.5)	Варианты: auto ← cli credential_file env	Управление источником учетных данных для аутентификации. `auto` будет следовать по умолчанию приоритетам параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть установлено через переменную окружения `ANSIBLE_AZURE_AUTH_SOURCE`.
cert_validation_mode (добавлено в 2.5)	Варианты: validate ignore Значение по умолчанию: 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`.
force	Значение по умолчанию: no	Удаляет группу ресурсов и все связанные ресурсы. Используется со значением 'absent' для удаления группы ресурсов, содержащей ресурсы.
location	Значение по умолчанию: None	Расположение Azure для группы ресурсов. Требуется при создании новой группы ресурсов. Не может быть изменено после создания группы ресурсов.
name обязательно		Имя группы ресурсов.
password	Значение по умолчанию: None	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы.
profile	Значение по умолчанию: None	Профиль безопасности, найденный в файле ~/.azure/credentials.
secret	Значение по умолчанию: None	Секрет клиента Azure. Используется при аутентификации с главным принципом службы.
state	Варианты: absent present ←	Утверждение состояния группы ресурсов. Используйте 'present' для создания или обновления и 'absent' для удаления. При 'absent' группа ресурсов, содержащая ресурсы, не будет удалена, если не используется параметр force.
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 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'}}

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.

Автор

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.5/modules/azure_rm_resourcegroup_module.html