Поделиться через


Virtual Hubs - List By Resource Group

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs?api-version=2023-09-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов VirtualHub.

subscriptionId
path True

string

Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True

string

Версия API клиента.

Ответы

Имя Тип Описание
200 OK

ListVirtualHubsResult

Запрос выполнен успешно. Возвращает сведения обо всех виртуальных концентраторах в группе ресурсов.

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

VirtualHubListByResourceGroup

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs?api-version=2023-09-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "virtualHub1",
      "type": "Microsoft.Network/virtualHubs",
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
        },
        "virtualHubRouteTableV2s": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "name": "rt2a",
            "properties": {
              "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"
                  ]
                }
              ],
              "attachedConnections": [
                "All_Vnets"
              ]
            }
          }
        ],
        "addressPrefix": "10.10.1.0/24",
        "sku": "Basic",
        "routingState": "Provisioned",
        "virtualRouterAsn": 65515,
        "virtualRouterIps": [
          "10.10.1.12",
          "10.10.1.13"
        ],
        "allowBranchToBranchTraffic": false,
        "preferredRoutingGateway": "ExpressRoute",
        "hubRoutingPreference": "ExpressRoute",
        "virtualRouterAutoScaleConfiguration": {
          "minCapacity": 2
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "East US",
      "name": "virtualHub2",
      "type": "Microsoft.Network/virtualHubs",
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
        },
        "virtualHubRouteTableV2s": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "name": "rt2a",
            "properties": {
              "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"
                  ]
                }
              ],
              "attachedConnections": [
                "All_Vnets"
              ]
            }
          }
        ],
        "addressPrefix": "210.10.1.0/24",
        "sku": "Basic",
        "routingState": "Provisioned",
        "virtualRouterAsn": 65515,
        "virtualRouterIps": [
          "10.10.1.12",
          "10.10.1.13"
        ],
        "allowBranchToBranchTraffic": false,
        "preferredRoutingGateway": "ExpressRoute",
        "hubRoutingPreference": "ExpressRoute",
        "virtualRouterAutoScaleConfiguration": {
          "minCapacity": 2
        }
      }
    }
  ]
}

Определения

Имя Описание
CloudError

Ответ об ошибке от службы.

CloudErrorBody

Ответ об ошибке от службы.

HubRoutingPreference

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

ListVirtualHubsResult

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

PreferredRoutingGateway

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

ProvisioningState

Текущее состояние подготовки.

RoutingState

Текущее состояние маршрутизации Виртуального концентратора.

SubResource

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

VirtualHub

Ресурс VirtualHub.

VirtualHubRoute

Маршрут VirtualHub.

VirtualHubRouteTable

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

VirtualHubRouteTableV2

Ресурс VirtualHubRouteTableV2.

VirtualHubRouteV2

Маршрут VirtualHubRouteTableV2.

VirtualRouterAutoScaleConfiguration

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

CloudError

Ответ об ошибке от службы.

Имя Тип Описание
error

CloudErrorBody

Текст ошибки облака.

CloudErrorBody

Ответ об ошибке от службы.

Имя Тип Описание
code

string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.

details

CloudErrorBody[]

Список дополнительных сведений об ошибке.

message

string

Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.

target

string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

HubRoutingPreference

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

Имя Тип Описание
ASPath

string

ExpressRoute

string

VpnGateway

string

ListVirtualHubsResult

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

Имя Тип Описание
nextLink

string

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

value

VirtualHub[]

Список виртуальных хуб.

PreferredRoutingGateway

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

Имя Тип Описание
ExpressRoute

string

None

string

VpnGateway

string

ProvisioningState

Текущее состояние подготовки.

Имя Тип Описание
Deleting

string

Failed

string

Succeeded

string

Updating

string

RoutingState

Текущее состояние маршрутизации Виртуального концентратора.

Имя Тип Описание
Failed

string

None

string

Provisioned

string

Provisioning

string

SubResource

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

Имя Тип Описание
id

string

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

VirtualHub

Ресурс VirtualHub.

Имя Тип Описание
etag

string

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

id

string

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

kind

string

Тип виртуального концентратора службы. Это метаданные, используемые для интерфейса портал Azure для Сервера маршрутизации.

location

string

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

name

string

Имя ресурса.

properties.addressPrefix

string

Префикс адреса для этого Виртуального концентратора.

properties.allowBranchToBranchTraffic

boolean

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

properties.azureFirewall

SubResource

Объект azureFirewall, связанный с этим VirtualHub.

properties.bgpConnections

SubResource[]

Список ссылок на Connections Bgp.

properties.expressRouteGateway

SubResource

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

properties.hubRoutingPreference

HubRoutingPreference

HubRoutingPreference этого VirtualHub.

properties.ipConfigurations

SubResource[]

Список ссылок на IpConfigurations.

properties.p2SVpnGateway

SubResource

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

properties.preferredRoutingGateway

PreferredRoutingGateway

Предпочтительный шлюз для маршрутизации локального трафика

properties.provisioningState

ProvisioningState

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

properties.routeMaps

SubResource[]

Список ссылок на RouteMaps.

properties.routeTable

VirtualHubRouteTable

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

properties.routingState

RoutingState

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

properties.securityPartnerProvider

SubResource

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

properties.securityProviderName

string

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

properties.sku

string

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

properties.virtualHubRouteTableV2s

VirtualHubRouteTableV2[]

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

properties.virtualRouterAsn

integer

VirtualRouter ASN.

properties.virtualRouterAutoScaleConfiguration

VirtualRouterAutoScaleConfiguration

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

properties.virtualRouterIps

string[]

Ip-адреса VirtualRouter.

properties.virtualWan

SubResource

Виртуальная глобальная сеть, к которой принадлежит VirtualHub.

properties.vpnGateway

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

Минимальное количество единиц масштабирования для маршрутизатора VirtualHub.