Модуль azure.azcollection.azure_rm_resourcegroup — Управление группами Azure ресурсов

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные зависимости, см. Требования для получения подробностей.

Для использования в книге задач укажите: azure.azcollection.azure_rm_resourcegroup.

Новая в azure.azcollection 0.1.2

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

Описание

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

Требования

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

python >= 2.7
На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через Galaxy.
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection.
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user string	Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.
adfs_authority_url string added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный узел ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. Default: `"latest"`
append_tags boolean	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices: `false` `true` ← (default)
auth_source string added in azure.azcollection 0.0.1	Управляет источником учетных данных, используемых для аутентификации. Также может быть установлено через переменную среды `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. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Choices: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлено через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Choices: `false` ← (default) `true`
force_delete_nonempty aliases: force boolean	Удалить группу ресурсов и все связанные ресурсы. Используйте с state=absent для удаления группы ресурсов, содержащей ресурсы. Choices: `false` ← (default) `true`
location string	Расположение Azure для группы ресурсов. Требуется при создании новой группы ресурсов. Не может быть изменен после создания группы ресурсов.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / required	Имя группы ресурсов.

пароль строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
профиль строка	Профиль безопасности, находящийся в файле ~/.azure/credentials.
секрет строка	Секрет Azure клиента. Используется при аутентификации с сервисным принципалом.
состояние строка	Утвердить состояние группы ресурсов. Используйте `present` для создания или обновления и `absent` для удаления. При использовании `absent` группы ресурсов, содержащей ресурсы, она не будет удалена, если не используется параметр force. Вызовы: `"absent"` `"present"` ← (по умолчанию)
идентификатор_подписки строка	Ваш идентификатор подписки Azure.
метки словарь	Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные метки объекта будут обновлены всеми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток на ресурсах.
арендатор строка	Идентификатор арендатора Azure. Используется при аутентификации с сервисным принципалом.
отпечаток строка добавлен в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с сервисным принципалом. Требуется, если определен x509_certificate_path.
путь_к_сертификату_x509 путь добавлен в azure.azcollection 1.14.0	Путь к сертификату X509, используемому для создания сервисного принципала в формате PEM. Сертификат должен быть добавлен к частному ключу. Используется при аутентификации с сервисным принципалом.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
Аутентификация также возможна с использованием сервисного принципала или пользователя Active Directory.
Для аутентификации через сервисный принципал передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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: true
    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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_resourcegroup_module.html