Модуль azure.azcollection.azure_rm_virtualhub_info – Получение информации о VirtualHub
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробной информации.
Для использования в playbook укажите: azure.azcollection.azure_rm_virtualhub_info.
Новое в azure.azcollection 1.10.0
Описание
- Получение информации о VirtualHub.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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**, проверка узла отключается. В результате важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя VirtualHub. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Имя группы ресурсов VirtualHub. |
secret string | Секретный ключ клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
subscription_id string | Ваш идентификатор подписки Azure. |
tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
thumbprint string added in azure.azcollection 1.14.0 | Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципала. Требуется, если определено x509_certificate_path. |
x509_certificate_path path added in azure.azcollection 1.14.0 | Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью Служебного принципала. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с помощью
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. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход с помощью Azure CLI
-
Как выполнить аутентификацию, используя команду
az login.
Примеры
- name: Get virtual hub info by name
azure_rm_virtualhub_info:
resource_group: myResourceGroup
name: virtualHub
- name: Get virtual hub info by resource group
azure_rm_virtualhub_info:
resource_group: myResourceGroup
- name: Get birtual hub info by sub
azure_rm_virtualhub_info:
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
virtual_hubs complex | Список результатов в формате словаря, где ключ — имя VirtualHub, а значения — данные для этого VirtualHub. Возвращается: всегда |
|
address_prefix string |
Префикс адреса для данного VirtualHub. Возвращается: всегда Пример: |
|
azure_firewall complex |
AzureFirewall, связанный с данным VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
bgp_connections list / elements=string |
Список ссылок на Bgp Connections. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
enable_virtual_router_route_propogation boolean |
Флаг для управления распространением маршрутов для VirtualRouter. Возвращается: всегда |
|
etag string |
Уникальная неизменяемая строка, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: |
|
express_route_gateway complex |
ExpressRouteGateway, связанный с данным VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
ip_configurations list / elements=string |
Список ссылок на IpConfigurations. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя ресурса. Возвращается: всегда Пример: |
|
next_link string |
URL для получения следующего набора результатов списка операций, если таковые имеются. Возвращается: всегда |
|
p2_s_vpn_gateway complex |
P2SVpnGateway, связанный с данным VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
provisioning_state string |
Состояние подготовки ресурса виртуального шлюза. Возвращается: всегда Пример: |
|
route_table complex |
routeTable, связанный с этим виртуальным шлюзом. Возвращается: всегда |
|
маршруты список / элементы=строка |
Список всех маршрутов. Возвращается: всегда |
|
адресные_префиксы список / элементы=строка |
Список всех адресных префиксов. Возвращается: всегда |
|
следующий_узел_ip_адрес строка |
Адрес следующего узла (NextHop). Возвращается: всегда |
|
состояние_маршрутизации строка |
Состояние маршрутизации. Возвращается: всегда |
|
поставщик_безопасного_партнера сложный_тип |
Поставщик безопасного партнера, связанный с этим VirtualHub. Возвращается: всегда |
|
id строка |
Идентификатор ресурса. Возвращается: всегда |
|
имя_поставщика_безопасности строка |
Имя поставщика безопасности. Возвращается: всегда |
|
sku строка |
SKU этого VirtualHub. Возвращается: всегда Пример: |
|
метки словарь |
Метки ресурса. Возвращается: всегда Пример: |
|
тип строка |
Тип ресурса. Возвращается: всегда Пример: |
|
значение сложный_тип |
Список VirtualHub. Возвращается: всегда |
|
адресной_префикс строка |
Префикс адреса для этого VirtualHub. Возвращается: всегда |
|
брандмауэр_azure сложный_тип |
Брандмауэр Azure, связанный с этим VirtualHub. Возвращается: всегда |
|
id строка |
Идентификатор ресурса. Возвращается: всегда |
|
bgp_соединения список / элементы=строка |
Список ссылок на BGP-соединения. Возвращается: всегда |
|
id строка |
Идентификатор ресурса. Возвращается: всегда |
|
включить_распространение_маршрутов_виртуального_маршрутизатора булево |
Флаг для управления распространением маршрутов для VirtualRouter. Возвращается: всегда |
|
шлюз_express_route сложный_тип |
Шлюз ExpressRoute, связанный с этим VirtualHub. Возвращается: всегда |
|
id строка |
Идентификатор ресурса. Возвращается: всегда |
|
ip_конфигурации список / элементы=строка |
Список ссылок на конфигурации IP. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
p2_s_vpn_gateway complex |
Шлюз P2SVpnGateway, связанный с этим VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
route_table complex |
Таблица маршрутизации, связанная с этим виртуальным концентратором. Возвращается: всегда |
|
routes list / elements=string |
Список всех маршрутов. Возвращается: всегда |
|
address_prefixes list / elements=string |
Список всех addressPrefixes. Возвращается: всегда |
|
next_hop_ip_address string |
IP-адрес NextHop. Возвращается: всегда |
|
security_partner_provider complex |
Провайдер securityPartnerProvider, связанный с этим VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
security_provider_name string |
Имя поставщика безопасности. Возвращается: всегда |
|
sku string |
SKU этого VirtualHub. Возвращается: всегда |
|
virtual_hub_route_table_v2_s complex |
Список всех таблиц маршрутов виртуального концентратора v2, связанных с этим VirtualHub. Возвращается: всегда |
|
attached_connections list / elements=string |
Список всех подключений, подключенных к этой таблице маршрутов v2. Возвращается: всегда |
|
name string |
Имя ресурса, которое является уникальным в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. Возвращается: всегда |
|
routes list / elements=string |
Список всех маршрутов. Возвращается: всегда |
|
destination_type string |
Тип пунктов назначения. Возвращается: всегда |
|
destinations list / elements=string |
Список всех пунктов назначения. Возвращается: всегда |
|
next_hop_type string |
Тип следующих переходов. Возвращается: всегда |
|
next_hops list / elements=string |
IP-адреса NextHops. Возвращается: всегда |
|
virtual_router_asn integer |
ASN виртуального маршрутизатора. Возвращается: всегда |
|
virtual_router_ips list / elements=string |
IP-адреса VirtualRouter. Возвращается: всегда |
|
virtual_wan complex |
VirtualWAN, к которому принадлежит VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
vpn_gateway complex |
VpnGateway, связанный с этим VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
|
virtual_hub_route_table_v2_s complex |
Список всех таблиц маршрутов виртуального концентратора v2, связанных с этим VirtualHub. Возвращается: всегда |
|
attached_connections list / elements=string |
Список всех подключений, подключенных к этой таблице маршрутов v2. Возвращается: всегда |
|
name string |
Имя ресурса, которое является уникальным в группе ресурсов. Это имя можно использовать для доступа к ресурсу. Возвращается: всегда |
|
routes complex |
Список всех маршрутов. Возвращается: всегда |
|
destination_type string |
Тип пунктов назначения. Возвращается: всегда |
|
destinations list / elements=string |
Список всех пунктов назначения. Возвращается: всегда |
|
next_hop_type string |
Тип следующих переходов. Возвращается: всегда |
|
next_hops list / elements=string |
IP-адрес NextHops. Возвращается: всегда |
|
virtual_router_asn integer |
ASN VirtualRouter. Возвращается: всегда |
|
virtual_router_ips list / elements=string |
IP-адреса VirtualRouter. Возвращается: всегда |
|
virtual_wan complex |
VirtualWAN, к которому принадлежит VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
vpn_gateway complex |
The VpnGateway associated with this VirtualHub. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда |
Ссылки на коллекцию
© 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_virtualhub_info_module.html