Virtual Hubs - List

Служба:: Virtual WAN

Версия API:: 2025-05-01

Список всех VirtualHub в подписке.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs?api-version=2025-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	ListVirtualHubsResult	Операция Azure успешно завершена.
Other Status Codes	Common.CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

VirtualHubList

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/virtualHubs?api-version=2025-05-01

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists all the VirtualHubs in a subscription.
 *
 * @summary Lists all the VirtualHubs in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/VirtualHubList.json
 */
async function virtualHubList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.virtualHubs.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "name": "virtualHub1",
      "type": "Microsoft.Network/virtualHubs",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
      "location": "West US",
      "properties": {
        "addressPrefix": "10.10.1.0/24",
        "allowBranchToBranchTraffic": false,
        "hubRoutingPreference": "ExpressRoute",
        "preferredRoutingGateway": "ExpressRoute",
        "provisioningState": "Succeeded",
        "routingState": "Provisioned",
        "sku": "Basic",
        "virtualHubRouteTableV2s": [
          {
            "name": "rt2a",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1",
            "properties": {
              "attachedConnections": [
                "All_Vnets"
              ],
              "provisioningState": "Succeeded",
              "routes": [
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "20.10.0.0/16",
                    "20.20.0.0/16"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                },
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "0.0.0.0/0"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                }
              ]
            }
          }
        ],
        "virtualRouterAsn": 65515,
        "virtualRouterAutoScaleConfiguration": {
          "minCapacity": 2
        },
        "virtualRouterIps": [
          "10.10.1.12",
          "10.10.1.13"
        ],
        "virtualWan": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
        }
      }
    },
    {
      "name": "virtualHub2",
      "type": "Microsoft.Network/virtualHubs",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
      "location": "East US",
      "properties": {
        "addressPrefix": "210.10.1.0/24",
        "allowBranchToBranchTraffic": false,
        "hubRoutingPreference": "ExpressRoute",
        "preferredRoutingGateway": "ExpressRoute",
        "provisioningState": "Succeeded",
        "routingState": "Provisioned",
        "sku": "Basic",
        "virtualHubRouteTableV2s": [
          {
            "name": "rt2a",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2",
            "properties": {
              "attachedConnections": [
                "All_Vnets"
              ],
              "provisioningState": "Succeeded",
              "routes": [
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "20.10.0.0/16",
                    "20.20.0.0/16"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                },
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "0.0.0.0/0"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                }
              ]
            }
          }
        ],
        "virtualRouterAsn": 65515,
        "virtualRouterAutoScaleConfiguration": {
          "minCapacity": 2
        },
        "virtualRouterIps": [
          "10.10.1.12",
          "10.10.1.13"
        ],
        "virtualWan": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
        }
      }
    }
  ]
}

Определения

Имя	Описание
Common.CloudError	Ответ об ошибке от сервиса.
Common.CloudErrorBody	Ответ об ошибке от сервиса.
Common.SubResource	Ссылка на другой подресурс.
HubRoutingPreference	Типы шлюзов предпочтительной маршрутизации концентратора
ListVirtualHubsResult	Результат запроса на перечисление VirtualHubs. Он содержит список VirtualHubs и URL-адрес nextLink, чтобы получить следующий набор результатов.
PreferredRoutingGateway	Предпочтительные типы шлюзов маршрутизации
ProvisioningState	Состояние подготовки ресурса.
RoutingState	Текущее состояние маршрутизации VirtualHub.
VirtualHub	Ресурс VirtualHub.
VirtualHubRoute	Маршрут VirtualHub.
VirtualHubRouteTable	Таблица маршрутов VirtualHub.
VirtualHubRouteTableV2	Ресурс VirtualHubRouteTableV2.
VirtualHubRouteV2	Маршрут VirtualHubRouteTableV2.
VirtualRouterAutoScaleConfiguration	Конфигурация автомасштабирования маршрутизатора VirtualHub.

Common.CloudError

Объект

Ответ об ошибке от сервиса.

Имя	Тип	Описание
error	Common.CloudErrorBody	Тело ошибки облака.

Common.CloudErrorBody

Объект

Ответ об ошибке от сервиса.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	Common.CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

Common.SubResource

Объект

Ссылка на другой подресурс.

Имя	Тип	Описание
id	string	Идентификатор ресурса.

HubRoutingPreference

Перечисление

Типы шлюзов предпочтительной маршрутизации концентратора

Значение	Описание
ExpressRoute	ExpressRoute
VpnGateway	VpnGateway
ASPath	ASPath

ListVirtualHubsResult

Объект

Результат запроса на перечисление VirtualHubs. Он содержит список VirtualHubs и URL-адрес nextLink, чтобы получить следующий набор результатов.

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	VirtualHub[]	Элементы VirtualHub на этой странице

PreferredRoutingGateway

Перечисление

Предпочтительные типы шлюзов маршрутизации

Значение	Описание
ExpressRoute	ExpressRoute
VpnGateway	VpnGateway
None	Нет

ProvisioningState

Перечисление

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

Значение	Описание
Failed	Неудача
Succeeded	Succeeded
Canceled	Отменено
Creating	Создавать
Updating	Обновление
Deleting	Удаление

RoutingState

Перечисление

Текущее состояние маршрутизации VirtualHub.

Значение	Описание
None	Нет
Provisioned	Обеспечено
Provisioning	Provisioning
Failed	Неудача

VirtualHub

Объект

Ресурс VirtualHub.

Имя	Тип	Описание
etag	string	Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string	Идентификатор ресурса.
kind	string	Разновидность сервиса виртуального хаба. Это метаданные, используемые для взаимодействия с порталом Azure для сервера маршрутизации.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.addressPrefix	string	Адрес-префикс для этого VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Флаг для управления транзитом для хаба VirtualRouter.
properties.azureFirewall	Common.SubResource	azureFirewall, связанный с этим VirtualHub.
properties.bgpConnections	Common.SubResource[]	Список ссылок на Bgp Connections.
properties.expressRouteGateway	Common.SubResource	Шлюз expressRouteGateway, связанный с этим VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	hubRoutingPreference этого VirtualHub.
properties.ipConfigurations	Common.SubResource[]	Список ссылок на IpConfigurations.
properties.p2SVpnGateway	Common.SubResource	Шлюз P2SVpnGateway, связанный с этим VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	Предпочтительный шлюз для маршрутизации локального трафика
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса виртуального концентратора.
properties.routeMaps	Common.SubResource[]	Список ссылок на RouteMaps.
properties.routeTable	VirtualHubRouteTable	Таблица routeTable, связанная с этим виртуальным концентратором.
properties.routingState	RoutingState	Состояние маршрутизации.
properties.securityPartnerProvider	Common.SubResource	securityPartnerProvider, связанный с этим VirtualHub.
properties.securityProviderName	string	Имя поставщика безопасности.
properties.sku	string	Артикул этого VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	Список всех таблиц маршрутов виртуального концентратора версии 2, связанных с этим VirtualHub.
properties.virtualRouterAsn	integer (int64) minimum: 0 maximum: 4294967295	Виртуальный маршрутизатор ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	Конфигурация автомасштабирования маршрутизатора VirtualHub.
properties.virtualRouterIps	string[]	Ip-адреса VirtualRouter.
properties.virtualWan	Common.SubResource	VirtualWAN, к которому принадлежит VirtualHub.
properties.vpnGateway	Common.SubResource	VpnGateway, связанный с этим VirtualHub.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

VirtualHubRoute

Объект

Маршрут VirtualHub.

Имя	Тип	Описание
addressPrefixes	string[]	Список всех адресовПрефиксы.
nextHopIpAddress	string	IP-адрес NextHop.

VirtualHubRouteTable

Объект

Таблица маршрутов VirtualHub.

Имя	Тип	Описание
routes	VirtualHubRoute[]	Список всех маршрутов.

VirtualHubRouteTableV2

Объект

Ресурс VirtualHubRouteTableV2.

Имя	Тип	Описание
etag	string	Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string	Идентификатор ресурса.
name	string	Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.attachedConnections	string[]	Список всех подключений, подключенных к этой таблице маршрутов версии 2.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса таблицы маршрутов виртуального концентратора версии 2.
properties.routes	VirtualHubRouteV2[]	Список всех маршрутов.

VirtualHubRouteV2

Объект

Маршрут VirtualHubRouteTableV2.

Имя	Тип	Описание
destinationType	string	Тип назначений.
destinations	string[]	Список всех назначений.
nextHopType	string	Тип следующего прыжка.
nextHops	string[]	Ip-адрес NextHops.

VirtualRouterAutoScaleConfiguration

Объект

Конфигурация автомасштабирования маршрутизатора VirtualHub.

Имя	Тип	Описание
minCapacity	integer (int32) minimum: 0	Минимальное количество единиц масштабирования для маршрутизатора VirtualHub.