Hub Virtual Network Connections - Create Or Update
如果中心虚拟网络连接不存在,则创建一个中心虚拟网络连接,否则会更新现有的虚拟网络连接。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}?api-version=2024-05-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
connection
|
path | True |
string |
HubVirtualNetworkConnection 的名称。 |
resource
|
path | True |
string |
HubVirtualNetworkConnection 的资源组名称。 |
subscription
|
path | True |
string |
唯一标识 Azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。 |
virtual
|
path | True |
string |
VirtualHub 的名称。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
name |
string |
资源组中唯一的资源的名称。 此名称可用于访问资源。 |
properties.allowHubToRemoteVnetTransit |
boolean |
已弃用:VirtualHub 到 RemoteVnet 传输以启用或不启用。 |
properties.allowRemoteVnetToUseHubVnetGateways |
boolean |
已弃用:允许 RemoteVnet 使用虚拟中心的网关。 |
properties.enableInternetSecurity |
boolean |
启用 Internet 安全性。 |
properties.remoteVirtualNetwork |
对远程虚拟网络的引用。 |
|
properties.routingConfiguration |
路由配置,指示此连接上关联的路由表和传播的路由表。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
请求成功。 返回已创建或更新的中心虚拟网络连接的详细信息。 |
|
201 Created |
请求成功。 返回检索到的中心虚拟网络连接的详细信息。 |
|
Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
HubVirtualNetworkConnectionPut
示例请求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1?api-version=2024-05-01
{
"properties": {
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"
},
"enableInternetSecurity": false,
"routingConfiguration": {
"associatedRouteTable": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
},
"propagatedRouteTables": {
"labels": [
"label1",
"label2"
],
"ids": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
}
]
},
"vnetRoutes": {
"staticRoutesConfig": {
"vnetLocalRouteOverrideCriteria": "Equal"
},
"staticRoutes": [
{
"name": "route1",
"addressPrefixes": [
"10.1.0.0/16",
"10.2.0.0/16"
],
"nextHopIpAddress": "10.0.0.68"
},
{
"name": "route2",
"addressPrefixes": [
"10.3.0.0/16",
"10.4.0.0/16"
],
"nextHopIpAddress": "10.0.0.65"
}
]
},
"inboundRouteMap": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
},
"outboundRouteMap": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
}
}
}
}
示例响应
{
"name": "connection1",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"properties": {
"provisioningState": "Updating",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"
},
"enableInternetSecurity": false,
"routingConfiguration": {
"associatedRouteTable": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
},
"propagatedRouteTables": {
"labels": [
"label1",
"label2"
],
"ids": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
}
]
},
"vnetRoutes": {
"staticRoutesConfig": {
"propagateStaticRoutes": true,
"vnetLocalRouteOverrideCriteria": "Equal"
},
"staticRoutes": [
{
"name": "route1",
"addressPrefixes": [
"10.1.0.0/16",
"10.2.0.0/16"
],
"nextHopIpAddress": "10.0.0.68"
},
{
"name": "route2",
"addressPrefixes": [
"10.3.0.0/16",
"10.4.0.0/16"
],
"nextHopIpAddress": "10.0.0.65"
}
],
"bgpConnections": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1"
}
]
},
"inboundRouteMap": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
},
"outboundRouteMap": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
}
}
}
}
{
"name": "connection1",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"properties": {
"provisioningState": "Updating",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"
},
"enableInternetSecurity": false,
"routingConfiguration": {
"associatedRouteTable": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
},
"propagatedRouteTables": {
"labels": [
"label1",
"label2"
],
"ids": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
}
]
},
"vnetRoutes": {
"staticRoutesConfig": {
"propagateStaticRoutes": true,
"vnetLocalRouteOverrideCriteria": "Equal"
},
"staticRoutes": [
{
"name": "route1",
"addressPrefixes": [
"10.1.0.0/16",
"10.2.0.0/16"
],
"nextHopIpAddress": "10.0.0.68"
},
{
"name": "route2",
"addressPrefixes": [
"10.3.0.0/16",
"10.4.0.0/16"
],
"nextHopIpAddress": "10.0.0.65"
}
],
"bgpConnections": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1"
}
]
},
"inboundRouteMap": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
},
"outboundRouteMap": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
}
}
}
}
定义
名称 | 说明 |
---|---|
Cloud |
服务的错误响应。 |
Cloud |
服务的错误响应。 |
Hub |
HubVirtualNetworkConnection 资源。 |
Propagated |
要向其播发路由的 RouteTable 列表。 |
Provisioning |
当前预配状态。 |
Routing |
路由配置,指示此连接的关联路由表和传播的路由表。 |
Static |
所有静态路由的列表。 |
Static |
此 HubVnetConnectionConfiguration 上静态路由的配置,用于此 HubVnetConnection 上的静态路由。 |
Sub |
对另一个子资源的引用。 |
Vnet |
确定辐射 vnet 中的 NVA 是否为辐射 vnet 中的流量绕过参数。 |
Vnet |
控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 |
CloudError
服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
云错误正文。 |
CloudErrorBody
服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
details |
有关错误的其他详细信息的列表。 |
|
message |
string |
描述错误的消息,旨在适合在用户界面中显示。 |
target |
string |
特定错误的目标。 例如,错误属性的名称。 |
HubVirtualNetworkConnection
HubVirtualNetworkConnection 资源。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
一个唯一的只读字符串,每当更新资源时更改。 |
id |
string |
资源 ID。 |
name |
string |
资源组中唯一的资源的名称。 此名称可用于访问资源。 |
properties.allowHubToRemoteVnetTransit |
boolean |
已弃用:VirtualHub 到 RemoteVnet 传输以启用或不启用。 |
properties.allowRemoteVnetToUseHubVnetGateways |
boolean |
已弃用:允许 RemoteVnet 使用虚拟中心的网关。 |
properties.enableInternetSecurity |
boolean |
启用 Internet 安全性。 |
properties.provisioningState |
中心虚拟网络连接资源的预配状态。 |
|
properties.remoteVirtualNetwork |
对远程虚拟网络的引用。 |
|
properties.routingConfiguration |
路由配置,指示此连接上关联的路由表和传播的路由表。 |
PropagatedRouteTable
要向其播发路由的 RouteTable 列表。
名称 | 类型 | 说明 |
---|---|---|
ids |
所有 RouteTable 的资源 ID 列表。 |
|
labels |
string[] |
标签列表。 |
ProvisioningState
当前预配状态。
值 | 说明 |
---|---|
Deleting | |
Failed | |
Succeeded | |
Updating |
RoutingConfiguration
路由配置,指示此连接的关联路由表和传播的路由表。
名称 | 类型 | 说明 |
---|---|---|
associatedRouteTable |
与此 RoutingConfiguration 关联的资源 ID RouteTable。 |
|
inboundRouteMap |
与此 RoutingConfiguration 关联的 RouteMap 的资源 ID,用于入站学习的路由。 |
|
outboundRouteMap |
与此 RoutingConfiguration 关联的RouteMap 的资源 ID,用于出站播发路由。 |
|
propagatedRouteTables |
要向其播发路由的 RouteTable 列表。 |
|
vnetRoutes |
控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 |
StaticRoute
所有静态路由的列表。
名称 | 类型 | 说明 |
---|---|---|
addressPrefixes |
string[] |
所有地址前缀的列表。 |
name |
string |
在 VnetRoute 中唯一的 StaticRoute 的名称。 |
nextHopIpAddress |
string |
下一跃点的 IP 地址。 |
StaticRoutesConfig
此 HubVnetConnectionConfiguration 上静态路由的配置,用于此 HubVnetConnection 上的静态路由。
名称 | 类型 | 说明 |
---|---|---|
propagateStaticRoutes |
boolean |
指示此连接上的静态路由是否自动传播到此连接传播到的路由表的布尔值。 |
vnetLocalRouteOverrideCriteria |
参数,用于确定辐射 vnet 中的 NVA 是否为辐射中具有目标的流量绕过。 |
SubResource
对另一个子资源的引用。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
VnetLocalRouteOverrideCriteria
确定辐射 vnet 中的 NVA 是否为辐射 vnet 中的流量绕过参数。
值 | 说明 |
---|---|
Contains | |
Equal |
VnetRoute
控制从 VirtualHub 到虚拟网络连接的路由的路由列表。
名称 | 类型 | 说明 |
---|---|---|
bgpConnections |
对 HubBgpConnection 对象的引用列表。 |
|
staticRoutes |
所有静态路由的列表。 |
|
staticRoutesConfig |
此 HubVnetConnection 上的静态路由的配置。 |