你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Vpn Connections - Get

参考

Service:: Virtual WAN

API Version:: 2023-09-01

检索 VPN 连接的详细信息。

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

URI 参数

名称	在	必需	类型	说明
connectionName	path	True	string	vpn 连接的名称。
gatewayName	path	True	string	网关的名称。
resourceGroupName	path	True	string	VpnGateway 的资源组名称。
subscriptionId	path	True	string	可以唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	VpnConnection	请求成功。返回 VPN 连接的详细信息。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

VpnConnectionGet

Sample Request

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


/**
 * Samples for VpnConnections Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionGet.json
     */
    /**
     * Sample code: VpnConnectionGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnConnectionGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnConnections().getWithResponse("rg1", "gateway1",
            "vpnConnection1", com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python vpn_connection_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.vpn_connections.get(
        resource_group_name="rg1",
        gateway_name="gateway1",
        connection_name="vpnConnection1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionGet.json
if __name__ == "__main__":
    main()

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

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionGet.json
func ExampleVPNConnectionsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVPNConnectionsClient().Get(ctx, "rg1", "gateway1", "vpnConnection1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VPNConnection = armnetwork.VPNConnection{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1"),
	// 	Name: to.Ptr("vpnConnection1"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VPNConnectionProperties{
	// 		EgressBytesTransferred: to.Ptr[int64](0),
	// 		EnableInternetSecurity: to.Ptr(false),
	// 		IngressBytesTransferred: to.Ptr[int64](0),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RemoteVPNSite: &armnetwork.SubResource{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
	// 		},
	// 		RoutingConfiguration: &armnetwork.RoutingConfiguration{
	// 			AssociatedRouteTable: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
	// 			},
	// 			InboundRouteMap: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
	// 			},
	// 			OutboundRouteMap: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"),
	// 			},
	// 			PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
	// 				IDs: []*armnetwork.SubResource{
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
	// 					},
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"),
	// 					},
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"),
	// 				}},
	// 				Labels: []*string{
	// 					to.Ptr("label1"),
	// 					to.Ptr("label2")},
	// 				},
	// 			},
	// 			TrafficSelectorPolicies: []*armnetwork.TrafficSelectorPolicy{
	// 			},
	// 			VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1"),
	// 					Name: to.Ptr("Connection-Link1"),
	// 					Type: to.Ptr("Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"),
	// 					Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 					Properties: &armnetwork.VPNSiteLinkConnectionProperties{
	// 						ConnectionBandwidth: to.Ptr[int32](200),
	// 						EgressBytesTransferred: to.Ptr[int64](0),
	// 						EnableBgp: to.Ptr(false),
	// 						EnableRateLimiting: to.Ptr(false),
	// 						IngressBytesTransferred: to.Ptr[int64](0),
	// 						IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 						},
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						RoutingWeight: to.Ptr[int32](0),
	// 						SharedKey: to.Ptr("key"),
	// 						UseLocalAzureIPAddress: to.Ptr(false),
	// 						UsePolicyBasedTrafficSelectors: to.Ptr(false),
	// 						VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
	// 						VPNLinkConnectionMode: to.Ptr(armnetwork.VPNLinkConnectionModeResponderOnly),
	// 						VPNSiteLink: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
	// 						},
	// 					},
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2"),
	// 					Name: to.Ptr("Connection-Link2"),
	// 					Type: to.Ptr("Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"),
	// 					Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 					Properties: &armnetwork.VPNSiteLinkConnectionProperties{
	// 						ConnectionBandwidth: to.Ptr[int32](200),
	// 						EgressBytesTransferred: to.Ptr[int64](0),
	// 						EnableBgp: to.Ptr(false),
	// 						EnableRateLimiting: to.Ptr(false),
	// 						IngressBytesTransferred: to.Ptr[int64](0),
	// 						IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 						},
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						RoutingWeight: to.Ptr[int32](0),
	// 						SharedKey: to.Ptr("key"),
	// 						UseLocalAzureIPAddress: to.Ptr(false),
	// 						UsePolicyBasedTrafficSelectors: to.Ptr(false),
	// 						VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
	// 						VPNLinkConnectionMode: to.Ptr(armnetwork.VPNLinkConnectionModeInitiatorOnly),
	// 						VPNSiteLink: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"),
	// 						},
	// 					},
	// 			}},
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Retrieves the details of a vpn connection.
 *
 * @summary Retrieves the details of a vpn connection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionGet.json
 */
async function vpnConnectionGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const connectionName = "vpnConnection1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnConnections.get(resourceGroupName, gatewayName, connectionName);
  console.log(result);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionGet.json
// this example is just showing the usage of "VpnConnections_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VpnGatewayResource created on azure
// for more information of creating VpnGatewayResource, please refer to the document of VpnGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string gatewayName = "gateway1";
ResourceIdentifier vpnGatewayResourceId = VpnGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName);
VpnGatewayResource vpnGateway = client.GetVpnGatewayResource(vpnGatewayResourceId);

// get the collection of this VpnConnectionResource
VpnConnectionCollection collection = vpnGateway.GetVpnConnections();

// invoke the operation
string connectionName = "vpnConnection1";
NullableResponse<VpnConnectionResource> response = await collection.GetIfExistsAsync(connectionName);
VpnConnectionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VpnConnectionData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Sample Response

Status code:: 200

{
  "name": "vpnConnection1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "properties": {
    "provisioningState": "Succeeded",
    "remoteVpnSite": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
    },
    "enableInternetSecurity": false,
    "ingressBytesTransferred": 0,
    "egressBytesTransferred": 0,
    "trafficSelectorPolicies": [],
    "vpnLinkConnections": [
      {
        "name": "Connection-Link1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
        "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "vpnSiteLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
          },
          "connectionBandwidth": 200,
          "ipsecPolicies": [],
          "vpnConnectionProtocolType": "IKEv2",
          "sharedKey": "key",
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "enableBgp": false,
          "enableRateLimiting": false,
          "useLocalAzureIpAddress": false,
          "usePolicyBasedTrafficSelectors": false,
          "routingWeight": 0,
          "vpnLinkConnectionMode": "ResponderOnly"
        }
      },
      {
        "name": "Connection-Link2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
        "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "vpnSiteLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
          },
          "connectionBandwidth": 200,
          "ipsecPolicies": [],
          "vpnConnectionProtocolType": "IKEv2",
          "sharedKey": "key",
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "enableBgp": false,
          "enableRateLimiting": false,
          "useLocalAzureIpAddress": false,
          "usePolicyBasedTrafficSelectors": false,
          "routingWeight": 0,
          "vpnLinkConnectionMode": "InitiatorOnly"
        }
      }
    ],
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
      },
      "propagatedRouteTables": {
        "labels": [
          "label1",
          "label2"
        ],
        "ids": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"
          }
        ]
      },
      "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"
      }
    }
  }
}

定义

名称	说明
CloudError	来自服务的错误响应。
CloudErrorBody	来自服务的错误响应。
DhGroup	初始 SA 的 IKE 阶段 1 中使用的 DH 组。
GatewayCustomBgpIpAddressIpConfiguration	用于虚拟网络网关连接的 GatewayCustomBgpIpAddressIpConfiguration。
IkeEncryption	IKE 加密算法 (IKE 阶段 2) 。
IkeIntegrity	IKE 第 2 阶段) (IKE 完整性算法。
IpsecEncryption	IPSec 加密算法 (IKE 阶段 1) 。
IpsecIntegrity	IPSec 完整性算法 (IKE 阶段 1) 。
IpsecPolicy	虚拟网络网关连接的 IPSec 策略配置。
PfsGroup	用于新子 SA 的 IKE 阶段 2 中使用的 Pfs 组。
PropagatedRouteTable	要向其播发路由的 RouteTable 列表。
ProvisioningState	当前预配状态。
RoutingConfiguration	路由配置，指示此连接的关联和传播的路由表。
StaticRoute	所有静态路由的列表。
StaticRoutesConfig	此 HubVnetConnection 上的静态路由配置此 HubVnetConnection 上的静态路由的配置。
SubResource	对另一个子资源的引用。
TrafficSelectorPolicy	虚拟网络网关连接的流量选择器策略。
VirtualNetworkGatewayConnectionProtocol	用于此连接的连接协议。
VnetLocalRouteOverrideCriteria	确定辐射 vnet 中的 NVA 是否绕过分支 vnet 中的目标流量的参数。
VnetRoute	控制从 VirtualHub 到虚拟网络连接的路由的列表。
VpnConnection	VpnConnection 资源。
VpnConnectionStatus	VPN 连接的当前状态。
VpnLinkConnectionMode	Vpn 链接连接模式。
VpnSiteLinkConnection	VpnSiteLinkConnection 资源。

CloudError

来自服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

来自服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。例如，属性的名称出错。

DhGroup

初始 SA 的 IKE 阶段 1 中使用的 DH 组。

名称	类型	说明
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

用于虚拟网络网关连接的 GatewayCustomBgpIpAddressIpConfiguration。

名称	类型	说明
customBgpIpAddress	string	属于 IpconfigurationId 的自定义 BgpPeeringAddress。
ipConfigurationId	string	属于网关的 ipconfiguration 的 IpconfigurationId。

IkeEncryption

IKE 加密算法 (IKE 阶段 2) 。

名称	类型	说明
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

IKE 第 2 阶段) (IKE 完整性算法。

名称	类型	说明
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

IPSec 加密算法 (IKE 阶段 1) 。

名称	类型	说明
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

IPSec 完整性算法 (IKE 阶段 1) 。

名称	类型	说明
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

虚拟网络网关连接的 IPSec 策略配置。

名称	类型	说明
dhGroup	DhGroup	在 IKE 阶段 1 中用于初始 SA 的 DH 组。
ikeEncryption	IkeEncryption	IKE 加密算法 (IKE 阶段 2) 。
ikeIntegrity	IkeIntegrity	IKE 第 2 阶段) (IKE 完整性算法。
ipsecEncryption	IpsecEncryption	IPSec 加密算法 (IKE 阶段 1) 。
ipsecIntegrity	IpsecIntegrity	IPSec 完整性算法 (IKE 阶段 1) 。
pfsGroup	PfsGroup	用于新子 SA 的 IKE 阶段 2 中使用的 Pfs 组。
saDataSizeKilobytes	integer	IPSec 安全关联 (也称为快速模式或阶段 2 SA) 站点到站点 VPN 隧道的有效负载大小（以 KB 为单位）。
saLifeTimeSeconds	integer	IPSec 安全关联 (也称为快速模式或阶段 2 SA) 站点到站点 VPN 隧道的生存期（以秒为单位）。

PfsGroup

用于新子 SA 的 IKE 阶段 2 中使用的 Pfs 组。

名称	类型	说明
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

要向其播发路由的 RouteTable 列表。

名称	类型	说明
ids	SubResource[]	所有 RouteTable 的资源 ID 的列表。
labels	string[]	标签列表。

ProvisioningState

当前预配状态。

名称	类型	说明
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

路由配置，指示此连接的关联和传播的路由表。

名称	类型	说明
associatedRouteTable	SubResource	与此 RoutingConfiguration 关联的资源 ID RouteTable。
inboundRouteMap	SubResource	与此 RoutingConfiguration 关联的 RouteMap 的资源 ID，用于入站获知的路由。
outboundRouteMap	SubResource	与出站播发路由的此 RoutingConfiguration 关联的RouteMap 的资源 ID。
propagatedRouteTables	PropagatedRouteTable	要向其播发路由的 RouteTable 列表。
vnetRoutes	VnetRoute	控制从 VirtualHub 到虚拟网络连接的路由的列表。

StaticRoute

所有静态路由的列表。

名称	类型	说明
addressPrefixes	string[]	所有地址前缀的列表。
name	string	在 VnetRoute 中唯一的 StaticRoute 的名称。
nextHopIpAddress	string	下一跃点的 IP 地址。

StaticRoutesConfig

此 HubVnetConnection 上的静态路由配置此 HubVnetConnection 上的静态路由的配置。

名称	类型	说明
propagateStaticRoutes	boolean	指示此连接上的静态路由是否自动传播到此连接传播到的路由表的布尔值。
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	参数，确定辐射 vnet 中的 NVA 是否绕过辐射中的目标流量。

SubResource

对另一个子资源的引用。

名称	类型	说明
id	string	资源 ID。

TrafficSelectorPolicy

虚拟网络网关连接的流量选择器策略。

名称	类型	说明
localAddressRanges	string[]	采用 CIDR 格式的本地地址空间的集合。
remoteAddressRanges	string[]	采用 CIDR 格式的远程地址空间的集合。

VirtualNetworkGatewayConnectionProtocol

用于此连接的连接协议。

名称	类型	说明
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

确定辐射 vnet 中的 NVA 是否绕过分支 vnet 中的目标流量的参数。

名称	类型	说明
Contains	string
Equal	string

VnetRoute

控制从 VirtualHub 到虚拟网络连接的路由的列表。

名称	类型	说明
bgpConnections	SubResource[]	对 HubBgpConnection 对象的引用列表。
staticRoutes	StaticRoute[]	所有静态路由的列表。
staticRoutesConfig	StaticRoutesConfig	此 HubVnetConnection 上的静态路由配置。

VpnConnection

VpnConnection 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.connectionBandwidth	integer	预期带宽（以 MBPS 为单位）。
properties.connectionStatus	VpnConnectionStatus	连接状态。
properties.dpdTimeoutSeconds	integer	VPN 连接的 DPD 超时（以秒为单位）。
properties.egressBytesTransferred	integer	传输的出口字节数。
properties.enableBgp	boolean	EnableBgp 标志。
properties.enableInternetSecurity	boolean	启用 Internet 安全性。
properties.enableRateLimiting	boolean	EnableBgp 标志。
properties.ingressBytesTransferred	integer	传输的入口字节数。
properties.ipsecPolicies	IpsecPolicy[]	此连接要考虑的 IPSec 策略。
properties.provisioningState	ProvisioningState	VPN 连接资源的预配状态。
properties.remoteVpnSite	SubResource	已连接的 VPN 站点的 ID。
properties.routingConfiguration	RoutingConfiguration	路由配置，指示此连接上关联的和传播的路由表。
properties.routingWeight	integer	VPN 连接的路由权重。
properties.sharedKey	string	Vpn 连接的 SharedKey。
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	此连接要考虑的流量选择器策略。
properties.useLocalAzureIpAddress	boolean	使用本地 Azure IP 启动连接。
properties.usePolicyBasedTrafficSelectors	boolean	启用基于策略的流量选择器。
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	用于此连接的连接协议。
properties.vpnLinkConnections	VpnSiteLinkConnection[]	到网关的所有 VPN 站点链接连接的列表。

VpnConnectionStatus

VPN 连接的当前状态。

名称	类型	说明
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnLinkConnectionMode

Vpn 链接连接模式。

名称	类型	说明
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnSiteLinkConnection

VpnSiteLinkConnection 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.connectionBandwidth	integer	预期带宽（以 MBPS 为单位）。
properties.connectionStatus	VpnConnectionStatus	连接状态。
properties.egressBytesTransferred	integer	传输的出口字节数。
properties.egressNatRules	SubResource[]	出口 NatRules 列表。
properties.enableBgp	boolean	EnableBgp 标志。
properties.enableRateLimiting	boolean	EnableBgp 标志。
properties.ingressBytesTransferred	integer	传输的入口字节数。
properties.ingressNatRules	SubResource[]	入口 NatRules 列表。
properties.ipsecPolicies	IpsecPolicy[]	此连接要考虑的 IPSec 策略。
properties.provisioningState	ProvisioningState	VPN 站点链接连接资源的预配状态。
properties.routingWeight	integer	VPN 连接的路由权重。
properties.sharedKey	string	Vpn 连接的 SharedKey。
properties.useLocalAzureIpAddress	boolean	使用本地 Azure IP 启动连接。
properties.usePolicyBasedTrafficSelectors	boolean	启用基于策略的流量选择器。
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	用于此连接的连接协议。
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	此连接使用的 vpnGatewayCustomBgpAddresses。
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Vpn 链接连接模式。
properties.vpnSiteLink	SubResource	连接的 VPN 站点链接的 ID。
type	string	资源类型。