Модуль azure.azcollection.azure_rm_virtualnetwork_info — получение сведений о виртуальных сетях
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используйте при аутентификации с именем пользователя и паролем, если у вас собственный центр ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с субъектом-службой или управляемым удостоверением (msi). Также можно задать с помощью переменной окружения |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (в соответствии с Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в 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 | Выводить результаты только для указанной виртуальной сети. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый непосредственно для аутентификации с удостоверением рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Подходит для систем CI (например, GitHub Actions, Azure DevOps), в которых платформа предоставляет токен OIDC напрямую. Также можно задать с помощью переменной окружения |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ обычно используется на платформах, которые предоставляют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с учетной записью пользователя Active Directory, а не с субъектом-службой. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string | Ограничить результаты указанной группой ресурсов. Обязательно при фильтрации по имени. |
secret string | Секрет клиента Azure. Используйте при аутентификации с субъектом-службой. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags list / элементы=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.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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.
См. также
См. также
- Вход с помощью 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 list / elements=string | Список словарей виртуальных сетей. Возвращается: всегда Пример: |
virtualnetworks complex | Список словарей виртуальных сетей в том же формате, что и параметры модуля azure.azcollection.azure_rm_virtualnetwork. Возвращается: всегда |
|
address_prefixes list / elements=string |
Список диапазонов IPv4-адресов, каждый из которых представлен в нотации CIDR. Возвращается: всегда Пример: |
|
dns_servers list / elements=string |
Пользовательский список DNS-серверов. Возвращается: всегда Пример: |
|
flow_timeout_in_minutes integer |
Значение FlowTimeout (в минутах) для виртуальной сети. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса виртуальной сети. Возвращается: всегда Пример: |
|
location string |
Допустимое расположение Azure. Возвращается: всегда Пример: |
|
name string |
Имя виртуальной сети. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки ресурса. Возвращается: всегда Пример: |
|
subnets list / elements=string |
Подсети, связанные с виртуальной сетью. Возвращается: всегда |
|
address_prefix string |
Префикс адреса подсети. Возвращается: всегда Пример: |
|
address_prefixes list / elements=string |
Префиксы адресов IPv4 и IPv6 для подсети; если задан только набор IPv4-адресов, будет возвращено значение null. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса подсети. Возвращается: всегда Пример: |
|
name string |
Имя подсети. Возвращается: всегда Пример: |
|
network_security_group string |
Идентификатор существующей группы безопасности, с которой нужно связать подсеть. Возвращается: всегда |
|
provisioning_state string |
Состояние подготовки подсети. Возвращается: всегда Пример: |
|
route_table string |
Ссылка на ресурс RouteTable. Возвращается: всегда |
|
service_endpoints list / elements=string |
Массив конечных точек служб. Возвращается: всегда Пример: |
|
usages list / elements=string |
Список статистики использования. Возвращается: всегда Пример: |
|
tags dictionary |
Теги, назначенные ресурсу. Словарь пар строка:строка. Возвращается: всегда Пример: |
Ссылки коллекции
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_virtualnetwork_info_module.html