Virtual Hubs - Get
Извлекает сведения о Виртуальном концентраторе.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}?api-version=2023-09-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов Виртуального концентратора. |
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы. |
virtual
|
path | True |
string |
Имя Виртуального концентратора. |
api-version
|
query | True |
string |
Версия API клиента. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос выполнен успешно. Возвращает сведения о полученном виртуальном концентраторе. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
VirtualHubGet
Sample Request
Sample Response
{
"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": [],
"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
}
}
}
Определения
Имя | Описание |
---|---|
Cloud |
Ответ об ошибке от службы. |
Cloud |
Ответ об ошибке от службы. |
Hub |
Типы предпочтительного шлюза маршрутизации концентратора |
Preferred |
Предпочтительные типы шлюзов маршрутизации |
Provisioning |
Текущее состояние подготовки. |
Routing |
Текущее состояние маршрутизации Виртуального концентратора. |
Sub |
Ссылка на другой подресурс. |
Virtual |
Ресурс VirtualHub. |
Virtual |
Маршрут Виртуального концентратора. |
Virtual |
Таблица маршрутизации VirtualHub. |
Virtual |
Ресурс VirtualHubRouteTableV2. |
Virtual |
Маршрут VirtualHubRouteTableV2. |
Virtual |
Конфигурация автомасштабирования маршрутизатора VirtualHub. |
CloudError
Ответ об ошибке от службы.
Имя | Тип | Описание |
---|---|---|
error |
Текст ошибки облака. |
CloudErrorBody
Ответ об ошибке от службы.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды инвариантны и предназначены для программного использования. |
details |
Список дополнительных сведений об ошибке. |
|
message |
string |
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе. |
target |
string |
Целевой объект конкретной ошибки. Например, имя свойства в ошибке. |
HubRoutingPreference
Типы предпочтительного шлюза маршрутизации концентратора
Имя | Тип | Описание |
---|---|---|
ASPath |
string |
|
ExpressRoute |
string |
|
VpnGateway |
string |
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 |
AzureFirewall, связанный с этим VirtualHub. |
|
properties.bgpConnections |
Список ссылок на Bgp Connections. |
|
properties.expressRouteGateway |
ExpressRouteGateway, связанный с этим VirtualHub. |
|
properties.hubRoutingPreference |
HubRoutingPreference этого Виртуального концентратора. |
|
properties.ipConfigurations |
Список ссылок на IpConfigurations. |
|
properties.p2SVpnGateway |
P2SVpnGateway, связанный с этим VirtualHub. |
|
properties.preferredRoutingGateway |
Предпочтительный шлюз для маршрутизации локального трафика |
|
properties.provisioningState |
Состояние подготовки ресурса виртуального концентратора. |
|
properties.routeMaps |
Список ссылок на RouteMaps. |
|
properties.routeTable |
Таблица routeTable, связанная с этим виртуальным концентратором. |
|
properties.routingState |
Состояние маршрутизации. |
|
properties.securityPartnerProvider |
SecurityPartnerProvider, связанный с этим VirtualHub. |
|
properties.securityProviderName |
string |
Имя поставщика безопасности. |
properties.sku |
string |
Номер SKU этого Виртуального концентратора. |
properties.virtualHubRouteTableV2s |
Список всех таблиц маршрутизации виртуальных концентраторов версии 2, связанных с этим VirtualHub. |
|
properties.virtualRouterAsn |
integer |
VirtualRouter ASN. |
properties.virtualRouterAutoScaleConfiguration |
Конфигурация автомасштабирования маршрутизатора VirtualHub. |
|
properties.virtualRouterIps |
string[] |
Ip-адреса VirtualRouter. |
properties.virtualWan |
Виртуальная глобальная сеть, к которой принадлежит VirtualHub. |
|
properties.vpnGateway |
VpnGateway, связанный с этим VirtualHub. |
|
tags |
object |
Теги ресурсов. |
type |
string |
Тип ресурса. |
VirtualHubRoute
Маршрут Виртуального концентратора.
Имя | Тип | Описание |
---|---|---|
addressPrefixes |
string[] |
Список всех адресовPrefixes. |
nextHopIpAddress |
string |
IP-адрес NextHop. |
VirtualHubRouteTable
Таблица маршрутизации VirtualHub.
Имя | Тип | Описание |
---|---|---|
routes |
Список всех маршрутов. |
VirtualHubRouteTableV2
Ресурс VirtualHubRouteTableV2.
Имя | Тип | Описание |
---|---|---|
etag |
string |
Уникальная строка, доступная только для чтения, которая изменяется при каждом обновлении ресурса. |
id |
string |
Идентификатор ресурса. |
name |
string |
Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. |
properties.attachedConnections |
string[] |
Список всех подключений, подключенных к этой таблице маршрутов версии 2. |
properties.provisioningState |
Состояние подготовки ресурса таблицы маршрутизации виртуального концентратора версии 2. |
|
properties.routes |
Список всех маршрутов. |
VirtualHubRouteV2
Маршрут VirtualHubRouteTableV2.
Имя | Тип | Описание |
---|---|---|
destinationType |
string |
Тип назначений. |
destinations |
string[] |
Список всех назначений. |
nextHopType |
string |
Тип следующего прыжка. |
nextHops |
string[] |
IP-адрес NextHops. |
VirtualRouterAutoScaleConfiguration
Конфигурация автомасштабирования маршрутизатора VirtualHub.
Имя | Тип | Описание |
---|---|---|
minCapacity |
integer |
Минимальное количество единиц масштабирования для маршрутизатора VirtualHub. |