Virtual Hubs - Get
检索 VirtualHub 的详细信息。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}?api-version=2025-03-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
resource
|
path | True |
string |
VirtualHub 的资源组名称。 |
|
subscription
|
path | True |
string |
唯一标识 Azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。 |
|
virtual
|
path | True |
string |
VirtualHub 的名称。 |
|
api-version
|
query | True |
string |
客户端 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
请求成功。 返回检索到的 VirtualHub 的详细信息。 |
|
| Other Status Codes |
描述作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
VirtualHubGet
示例请求
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1?api-version=2025-03-01
示例响应
{
"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 |
VirtualHub 的当前路由状态。 |
|
Sub |
对另一个子资源的引用。 |
|
Virtual |
VirtualHub 资源。 |
|
Virtual |
VirtualHub 路由。 |
|
Virtual |
VirtualHub 路由表。 |
|
Virtual |
VirtualHubRouteTableV2 资源。 |
|
Virtual |
VirtualHubRouteTableV2 路由。 |
|
Virtual |
VirtualHub 路由器自动缩放配置。 |
CloudError
服务的错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
云错误正文。 |
CloudErrorBody
服务的错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
| details |
有关错误的其他详细信息的列表。 |
|
| message |
string |
描述错误的消息,旨在适合在用户界面中显示。 |
| target |
string |
特定错误的目标。 例如,错误属性的名称。 |
HubRoutingPreference
中心路由首选项网关类型
| 值 | 说明 |
|---|---|
| ExpressRoute | |
| VpnGateway | |
| ASPath |
PreferredRoutingGateway
首选路由网关类型
| 值 | 说明 |
|---|---|
| ExpressRoute | |
| VpnGateway | |
| None |
ProvisioningState
当前预配状态。
| 值 | 说明 |
|---|---|
| Succeeded | |
| Updating | |
| Deleting | |
| Failed |
RoutingState
VirtualHub 的当前路由状态。
| 值 | 说明 |
|---|---|
| None | |
| Provisioned | |
| Provisioning | |
| Failed |
SubResource
对另一个子资源的引用。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源 ID。 |
VirtualHub
VirtualHub 资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| etag |
string |
一个唯一的只读字符串,每当更新资源时更改。 |
| id |
string |
资源 ID。 |
| kind |
string |
一种服务虚拟中心。 这是用于路由服务器的 Azure 门户体验的元数据。 |
| location |
string |
资源位置。 |
| name |
string |
资源名称。 |
| properties.addressPrefix |
string |
此 VirtualHub 的地址前缀。 |
| properties.allowBranchToBranchTraffic |
boolean |
用于控制 VirtualRouter 中心的传输的标志。 |
| properties.azureFirewall |
与此 VirtualHub 关联的 azureFirewall。 |
|
| properties.bgpConnections |
对 Bgp 连接的引用列表。 |
|
| properties.expressRouteGateway |
与此 VirtualHub 关联的 expressRouteGateway。 |
|
| properties.hubRoutingPreference |
此 VirtualHub 的 hubRoutingPreference。 |
|
| properties.ipConfigurations |
对 IpConfiguration 的引用列表。 |
|
| properties.p2SVpnGateway |
与此 VirtualHub 关联的 P2SVpnGateway。 |
|
| properties.preferredRoutingGateway |
用于路由本地流量的首选网关 |
|
| properties.provisioningState |
虚拟中心资源的预配状态。 |
|
| properties.routeMaps |
对 RouteMaps 的引用列表。 |
|
| properties.routeTable |
与此虚拟中心关联的 routeTable。 |
|
| properties.routingState |
路由状态。 |
|
| properties.securityPartnerProvider |
与此 VirtualHub 关联的 securityPartnerProvider。 |
|
| properties.securityProviderName |
string |
安全提供程序名称。 |
| properties.sku |
string |
此 VirtualHub 的 SKU。 |
| properties.virtualHubRouteTableV2s |
与此 VirtualHub 关联的所有虚拟中心路由表 v2 的列表。 |
|
| properties.virtualRouterAsn |
integer (int64) minimum: 0maximum: 4294967295 |
VirtualRouter ASN。 |
| properties.virtualRouterAutoScaleConfiguration |
VirtualHub 路由器自动缩放配置。 |
|
| properties.virtualRouterIps |
string[] |
VirtualRouter IP。 |
| properties.virtualWan |
VirtualHub 所属的 VirtualWAN。 |
|
| properties.vpnGateway |
与此 VirtualHub 关联的 VpnGateway。 |
|
| tags |
object |
资源标记。 |
| type |
string |
资源类型。 |
VirtualHubRoute
VirtualHub 路由。
| 名称 | 类型 | 说明 |
|---|---|---|
| addressPrefixes |
string[] |
所有 addressPrefixes 的列表。 |
| nextHopIpAddress |
string |
NextHop ip 地址。 |
VirtualHubRouteTable
VirtualHub 路由表。
| 名称 | 类型 | 说明 |
|---|---|---|
| routes |
所有路由的列表。 |
VirtualHubRouteTableV2
VirtualHubRouteTableV2 资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| etag |
string |
一个唯一的只读字符串,每当更新资源时更改。 |
| id |
string |
资源 ID。 |
| name |
string |
资源组中唯一的资源的名称。 此名称可用于访问资源。 |
| properties.attachedConnections |
string[] |
附加到此路由表 v2 的所有连接的列表。 |
| properties.provisioningState |
虚拟中心路由表 v2 资源的预配状态。 |
|
| properties.routes |
所有路由的列表。 |
VirtualHubRouteV2
VirtualHubRouteTableV2 路由。
| 名称 | 类型 | 说明 |
|---|---|---|
| destinationType |
string |
目标的类型。 |
| destinations |
string[] |
所有目标的列表。 |
| nextHopType |
string |
下一跃点的类型。 |
| nextHops |
string[] |
NextHops ip 地址。 |
VirtualRouterAutoScaleConfiguration
VirtualHub 路由器自动缩放配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| minCapacity |
integer (int32) minimum: 0 |
VirtualHub 路由器的最小缩放单位数。 |