azure_rm_virtualnetwork_facts - Получение фактов о виртуальной сети.
Новая версия 2.1.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Получение фактов о конкретной виртуальной сети или всех виртуальных сетях в группе ресурсов.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательный | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | ||
| client_id | нет | Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом. | ||
| cloud_environment | нет | AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| name | нет | Показать результаты только для определенной группы безопасности. | ||
| password | нет | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | ||
| profile | нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group | нет | Ограничить результаты по группе ресурсов. Требуется при фильтрации по имени. | ||
| secret | нет | Секрет клиента Azure. Используется при аутентификации с сервисным принципалом. | ||
| subscription_id | нет | Ваш идентификатор подписки Azure. | ||
| tags | нет | Ограничить результаты, предоставив список тегов. Формат тегов 'ключ' или 'ключ:значение'. | ||
| tenant | нет | Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом. |
Примеры
- name: Get facts for one virtual network
azure_rm_virtualnetwork_facts:
resource_group: Testing
name: secgroup001
- name: Get facts for all virtual networks
azure_rm_virtualnetwork_facts:
resource_group: Testing
- name: Get facts by tags
azure_rm_virtualnetwork_facts:
tags:
- testing
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие являются полями, уникальными для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| azure_virtualnetworks | Список словарей виртуальных сетей. | всегда | список |
Примечания
Примечание
- Для аутентификации в 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 в среде.
Статус
Этот модуль помечен как бета-версия, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для помощи в разработке модулей, если вам это интересно, пожалуйста, ознакомьтесь с Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_virtualnetwork_facts_module.html
