azure_rm_virtualnetwork_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 будет следовать по умолчанию приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.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 | Идентификатор клиента 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. |
| resource_group | Значение по умолчанию: None | Ограничить результаты по группе ресурсов. Необходимо при фильтрации по имени. |
| 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 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 список | всегда | Список словарей виртуальных сетей. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- Chris Houseknecht house@redhat.com
- Matt Davis mdavis@redhat.com
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для его улучшения.
© 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_virtualnetwork_facts_module.html