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

Примечание

Этот плагин входит в сборку azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection

Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_resourcegroup

Новое в версии 0.1.2: из azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
adfs_authority_url строка добавлен в 0.0.1 из azure.azcollection		URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и наличии собственного авторизационного центра ADFS.
api_profile строка добавлен в 0.0.1 из azure.azcollection	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево	Варианты: no да ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом режиме любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 из azure.azcollection	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE` При установке в `auto` (значение по умолчанию), приоритет параметров модуля -> `env` -> `credential_file` -> `cli` При установке в `env`, учетные данные будут считаны из переменных среды. При установке в `credential_file`, профиль будет считаться из `~/.azure/credentials` При установке в `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если их несколько, иначе используется по умолчанию az подписка CLI. При установке в `msi`, хост-машина должна быть Azure ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 0.0.1 из azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или при подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом.
cloud_environment строка добавлен в 0.0.1 из azure.azcollection	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа обнаружения метаданных (необходимо для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`
force_delete_nonempty булево	Варианты: нет ← да	Удаляет группу ресурсов и все связанные ресурсы. Используется с state=absent для удаления группы ресурсов, содержащей ресурсы. псевдонимы: force
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, или выполнить вход перед запуском задач или playbook с 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 a resource group
  azure_rm_resourcegroup:
    name: myResourceGroup
    location: westus
    tags:
        testing: testing
        delete: never

- name: Delete a resource group
  azure_rm_resourcegroup:
    name: myResourceGroup
    state: absent

- name: Delete a resource group including resources it contains
  azure_rm_resourcegroup:
    name: myResourceGroup
    force_delete_nonempty: yes
    state: absent

Значения возврата

Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:

Ключ		Возвращаемое значение	Описание
contains_resources boolean		всегда	Признак наличия связанных ресурсов в группе ресурсов. Пример: True
state complex		всегда	Текущее состояние группы ресурсов.
	id string	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup
	location string	всегда	Расположение Azure для группы ресурсов. Пример: westus
	name string	всегда	Название группы ресурсов. Пример: Testing
	provisioning_state string	всегда	Состояние подготовки группы ресурсов. Пример: Succeeded
	tags dictionary	всегда	Теги группы ресурсов. Пример: {'delete': 'on-exit', 'testing': 'no'}

Авторы

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_resourcegroup_module.html