azure_rm_resourcegroup_facts - Получение фактов о группе ресурсов.
Новая версия 2.1.
Обзор
- Получение фактов о конкретной группе ресурсов или всех группах ресурсов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью службы-принципала. |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать умолчанию: параметры модуля -> переменные среды -> профиль по умолчанию в файле credential ~/.azure/credentials. При установке в cli, учетные данные берутся из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлено в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | ID клиента Azure. Используется при аутентификации с помощью службы-принципала. |
| cloud_environment (добавлено в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment ), или URL-адрес точки конечного доступа к метаданным (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| name | Значение по умолчанию: None | Ограничить результаты конкретной группой ресурсов. |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью службы-принципала. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. |
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. |
| tags | Значение по умолчанию: None | Ограничить результаты, указав список тегов. Формат тегов: 'ключ' или 'ключ:значение'. |
| 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: Get facts for one resource group
azure_rm_resourcegroup_facts:
name: Testing
- name: Get facts for all resource groups
azure_rm_resourcegroup_facts:
- name: Get facts by tags
azure_rm_resourcegroup_facts:
tags:
- testing
- foo:bar
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| azure_resourcegroups список | всегда | Список словарей групп ресурсов. |
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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_facts_module.html