Модуль azure.azcollection.azure_rm_virtualnetwork_info – Получение фактов о виртуальной сети
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в книге задач укажите: azure.azcollection.azure_rm_virtualnetwork_info.
Новая версия в azure.azcollection 0.0.1
Обзор
- Получение фактов о конкретной виртуальной сети или всех виртуальных сетях в группе ресурсов.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- 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. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
list_usage boolean | Показывать ли статистику использования. list_usage=true для показа статистики использования. Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Показать результаты только для определённой виртуальной сети. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Ограничить результаты по группе ресурсов. Требуется при фильтрации по имени. |
secret string | Секретный ключ клиента Azure. Используется при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags list / elements=string | Ограничьте результаты, указав список тегов. Формат тегов — 'ключ' или 'ключ:значение'. |
tenant string | Идентификатор Azure-аренды. Используется при аутентификации с помощью Служебного принципала. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципала. Требуется, если определен параметр x509_certificate_path. |
x509_certificate_path path добавлено в 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 и password или установите 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: Get facts for one virtual network
azure_rm_virtualnetwork_info:
resource_group: myResourceGroup
name: secgroup001
- name: Get facts for all virtual networks
azure_rm_virtualnetwork_info:
resource_group: myResourceGroup
- name: Get facts by tags
azure_rm_virtualnetwork_info:
tags:
- testing
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
azure_virtualnetworks список / элементы=строка | Список словарей виртуальных сетей. Возвращается: всегда Пример: |
virtualnetworks сложный | Список словарей виртуальных сетей с тем же форматом, что и параметры модуля azure.azcollection.azure_rm_virtualnetwork. Возвращается: всегда |
|
address_prefixes список / элементы=строка |
Список диапазонов адресов IPv4, каждый из которых отформатирован с использованием нотации CIDR. Возвращается: всегда Пример: |
|
dns_servers список / элементы=строка |
Пользовательский список DNS-серверов. Возвращается: всегда Пример: |
|
flow_timeout_in_minutes целое число |
Значение FlowTimeout (в минутах) для виртуальной сети. Возвращается: всегда Пример: |
|
id строка |
Идентификатор ресурса виртуальной сети. Возвращается: всегда Пример: |
|
location строка |
Действительное расположение Azure. Возвращается: всегда Пример: |
|
name строка |
Имя виртуальной сети. Возвращается: всегда Пример: |
|
provisioning_state строка |
Состояние подготовки ресурса. Возвращается: всегда Пример: |
|
subnets список / элементы=строка |
Подсети, связанные с виртуальной сетью. Возвращается: всегда |
|
address_prefix строка |
Префикс адреса подсети. Возвращается: всегда Пример: |
|
address_prefixes список / элементы=строка |
Префиксы адресов IPv4 и IPv6 для подсети, вернёт null если только IPv4. Возвращается: всегда Пример: |
|
id строка |
Идентификатор ресурса подсети. Возвращается: всегда Пример: |
|
name строка |
Имя подсети. Возвращается: всегда Пример: |
|
network_security_group строка |
Существующий ID группы безопасности, с которым нужно связать подсеть. Возвращается: всегда |
|
provisioning_state строка |
Состояние подготовки подсети. Возвращается: всегда Пример: |
|
route_table строка |
Ссылка на ресурс RouteTable. Возвращается: всегда |
|
service_endpoints список / элементы=строка |
Массив служб конечных точек. Возвращается: всегда Пример: |
|
usages список / элементы=строка |
Список статистических данных использования. Возвращается: всегда Пример: |
|
tags словарь |
Теги, назначенные ресурсу. Словарь пар строка:строка. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_virtualnetwork_info_module.html