Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_virtualhub_info – получение сведений о VirtualHub

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: 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

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной среды ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), приоритет источников следующий: параметры модуля -> env -> credential_file -> cli.

Если задано значение env, учетные данные считываются из переменных среды.

Если задано значение credential_file, профиль считывается из ~/.azure/credentials.

Если задано значение cli, учетные данные извлекаются из профиля Azure CLI. Для указания идентификатора подписки, если их несколько, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае используется подписка az cli по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае выбирается первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (определенное в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра авторизации будут полностью отключены. Эта возможность предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. При обнаружении экземпляров метаданные центра авторизации извлекаются с https://login.microsoft.com/ для проверки центра авторизации. Если задать значение **True**, проверка центра авторизации отключается. Поэтому крайне важно убедиться, что настроенный узел центра авторизации действителен и заслуживает доверия.

Значение задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Имя VirtualHub.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки.

Этот токен обменивается на токен Azure AD с помощью федеративного удостоверения OIDC.

Подходит для систем CI (например, GitHub Actions и Azure DevOps), в которых платформа предоставляет токен OIDC напрямую.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые предоставляют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

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

добавлено в 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 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.

Возвращается: всегда

Пример: "10.0.0.0/24"

azure_firewall

complex

AzureFirewall, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

bgp_connections

list / elements=string

Список ссылок на подключения BGP.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

enable_virtual_router_route_propogation

boolean

Флаг управления распространением маршрутов для концентратора VirtualRouter.

Возвращается: всегда

etag

string

Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса.

Возвращается: всегда

Пример: "4462b9db-6569-49be-8d00-000178b29e90"

express_route_gateway

complex

ExpressRouteGateway, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/fredhub"

ip_configurations

list / elements=string

Список ссылок на конфигурации IP.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

location

string

Расположение ресурса.

Возвращается: всегда

Пример: "eastus"

name

string

Имя ресурса.

Возвращается: всегда

Пример: "fredhub"

next_link

string

URL для получения следующего набора результатов списка операций, если он существует.

Возвращается: всегда

p2_s_vpn_gateway

complex

P2SVpnGateway, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

provisioning_state

string

Состояние подготовки ресурса виртуального концентратора.

Возвращается: всегда

Пример: "Succeeded"

route_table

complex

Таблица маршрутизации, связанная с этим виртуальным концентратором.

Возвращается: всегда

routes

list / elements=string

Список всех маршрутов.

Возвращается: всегда

address_prefixes

list / elements=string

Список всех префиксов адресов.

Возвращается: всегда

next_hop_ip_address

string

IP-адрес следующего перехода.

Возвращается: всегда

routing_state

string

Состояние маршрутизации.

Возвращается: всегда

security_partner_provider

complex

Поставщик Security Partner, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

security_provider_name

string

Имя поставщика безопасности.

Возвращается: всегда

sku

string

Номер SKU этого VirtualHub.

Возвращается: всегда

Пример: "Standard"

tags

dictionary

Теги ресурса.

Возвращается: всегда

Пример: {"key1": "value1"}

type

string

Тип ресурса.

Возвращается: всегда

Пример: "Microsoft.Network/virtualHubs"

value

complex

Список VirtualHub.

Возвращается: всегда

address_prefix

string

Префикс адреса для этого VirtualHub.

Возвращается: всегда

azure_firewall

complex

AzureFirewall, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

bgp_connections

list / elements=string

Список ссылок на подключения BGP.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

enable_virtual_router_route_propogation

boolean

Флаг управления распространением маршрутов для концентратора VirtualRouter.

Возвращается: всегда

express_route_gateway

complex

ExpressRouteGateway, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

ip_configurations

list / elements=string

Список ссылок на конфигурации IP.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

p2_s_vpn_gateway

complex

P2SVpnGateway, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

route_table

complex

Таблица маршрутизации, связанная с этим виртуальным концентратором.

Возвращается: всегда

routes

list / elements=string

Список всех маршрутов.

Возвращается: всегда

address_prefixes

list / elements=string

Список всех префиксов адресов.

Возвращается: всегда

next_hop_ip_address

string

IP-адрес следующего перехода.

Возвращается: всегда

security_partner_provider

complex

Поставщик Security Partner, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

security_provider_name

string

Имя поставщика безопасности.

Возвращается: всегда

sku

string

Номер SKU этого VirtualHub.

Возвращается: всегда

virtual_hub_route_table_v2_s

complex

Список всех таблиц маршрутизации виртуального концентратора версии 2, связанных с этим VirtualHub.

Возвращается: всегда

attached_connections

list / elements=string

Список всех подключений, присоединенных к этой таблице маршрутизации версии 2.

Возвращается: всегда

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 VirtualRouter.

Возвращается: всегда

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

Список всех таблиц маршрутизации виртуального концентратора версии 2, связанных с этим VirtualHub.

Возвращается: всегда

attached_connections

list / elements=string

Список всех подключений, присоединённых к этой таблице маршрутизации версии 2.

Возвращается: всегда

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

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/virtualWans/virtualwanfred01"

vpn_gateway

complex

VpnGateway, связанный с этим VirtualHub.

Возвращается: всегда

id

string

Идентификатор ресурса.

Возвращается: всегда

Авторы

  • Fred-Sun (@Fred-Sun)
  • Haiyuan Zhang (@haiyuazhang)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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_virtualhub_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API