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

Vpn Connections - Get

检索 VPN 连接的详细信息。

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

URI 参数

Name In Required Type Description
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 版本。

响应

Name Type Description
200 OK

请求成功。 返回 vpn 连接的详细信息。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

VpnConnectionGet

Sample Request

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

Sample Response

{
  "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"
          }
        ]
      },
      "vnetRoutes": {
        "staticRoutes": []
      }
    }
  }
}

定义

CloudError

服务的错误响应。

CloudErrorBody

服务的错误响应。

DhGroup

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

GatewayCustomBgpIpAddressIpConfiguration

虚拟网络网关连接的 GatewayCustomBgpIpAddressIpConfiguration。

IkeEncryption

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

IkeIntegrity

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

IpsecEncryption

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

IpsecIntegrity

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

IpsecPolicy

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

PfsGroup

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

PropagatedRouteTable

要播发路由到的 RouteTable 列表。

ProvisioningState

当前预配状态。

RoutingConfiguration

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

StaticRoute

所有静态路由的列表。

SubResource

对另一个子资源的引用。

TrafficSelectorPolicy

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

VirtualNetworkGatewayConnectionProtocol

用于此连接的连接协议。

VnetRoute

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

VpnConnection

VpnConnection 资源。

VpnConnectionStatus

VPN 连接的当前状态。

VpnLinkConnectionMode

Vpn 链接连接模式。

VpnSiteLinkConnection

VpnSiteLinkConnection 资源。

CloudError

服务的错误响应。

Name Type Description
error

云错误正文。

CloudErrorBody

服务的错误响应。

Name Type Description
code
  • string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

有关错误的其他详细信息的列表。

message
  • string

描述错误的消息,旨在适合在用户界面中显示。

target
  • string

特定错误的目标。 例如,错误属性的名称。

DhGroup

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

Name Type Description
DHGroup1
  • string
DHGroup14
  • string
DHGroup2
  • string
DHGroup2048
  • string
DHGroup24
  • string
ECP256
  • string
ECP384
  • string
None
  • string

GatewayCustomBgpIpAddressIpConfiguration

虚拟网络网关连接的 GatewayCustomBgpIpAddressIpConfiguration。

Name Type Description
customBgpIpAddress
  • string

属于 IpconfigurationId 的自定义 BgpPeeringAddress。

ipConfigurationId
  • string

属于网关的 ipconfiguration 的 IpconfigurationId。

IkeEncryption

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

Name Type Description
AES128
  • string
AES192
  • string
AES256
  • string
DES
  • string
DES3
  • string
GCMAES128
  • string
GCMAES256
  • string

IkeIntegrity

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

Name Type Description
GCMAES128
  • string
GCMAES256
  • string
MD5
  • string
SHA1
  • string
SHA256
  • string
SHA384
  • string

IpsecEncryption

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

Name Type Description
AES128
  • string
AES192
  • string
AES256
  • string
DES
  • string
DES3
  • string
GCMAES128
  • string
GCMAES192
  • string
GCMAES256
  • string
None
  • string

IpsecIntegrity

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

Name Type Description
GCMAES128
  • string
GCMAES192
  • string
GCMAES256
  • string
MD5
  • string
SHA1
  • string
SHA256
  • string

IpsecPolicy

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

Name Type Description
dhGroup

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

ikeEncryption

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

ikeIntegrity

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

ipsecEncryption

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

ipsecIntegrity

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

pfsGroup

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

saDataSizeKilobytes
  • integer

IPSec 安全关联 (也称为快速模式或阶段 2 SA) KB 的有效负载大小,用于站点到站点 VPN 隧道。

saLifeTimeSeconds
  • integer

IPSec 安全关联 (也称为快速模式或阶段 2 SA) 生存期(以秒为单位)用于站点到站点 VPN 隧道。

PfsGroup

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

Name Type Description
ECP256
  • string
ECP384
  • string
None
  • string
PFS1
  • string
PFS14
  • string
PFS2
  • string
PFS2048
  • string
PFS24
  • string
PFSMM
  • string

PropagatedRouteTable

要播发路由到的 RouteTable 列表。

Name Type Description
ids

所有 RouteTable 的资源 ID 列表。

labels
  • string[]

标签列表。

ProvisioningState

当前预配状态。

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

RoutingConfiguration

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

Name Type Description
associatedRouteTable

与此 RoutingConfiguration 关联的资源 ID RouteTable。

propagatedRouteTables

要播发路由到的 RouteTable 列表。

vnetRoutes

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

StaticRoute

所有静态路由的列表。

Name Type Description
addressPrefixes
  • string[]

所有地址前缀的列表。

name
  • string

在 VnetRoute 中唯一的 StaticRoute 的名称。

nextHopIpAddress
  • string

下一跃点的 IP 地址。

SubResource

对另一个子资源的引用。

Name Type Description
id
  • string

资源 ID。

TrafficSelectorPolicy

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

Name Type Description
localAddressRanges
  • string[]

采用 CIDR 格式的本地地址空间的集合。

remoteAddressRanges
  • string[]

采用 CIDR 格式的远程地址空间集合。

VirtualNetworkGatewayConnectionProtocol

用于此连接的连接协议。

Name Type Description
IKEv1
  • string
IKEv2
  • string

VnetRoute

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

Name Type Description
bgpConnections

对 HubBgpConnection 对象的引用列表。

staticRoutes

所有静态路由的列表。

VpnConnection

VpnConnection 资源。

Name Type Description
etag
  • string

在更新资源时更改的唯一只读字符串。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.connectionBandwidth
  • integer

预期带宽(以 MBPS 为单位)。

properties.connectionStatus

连接状态。

properties.dpdTimeoutSeconds
  • integer

VPN 连接的 DPD 超时(以秒为单位)。

properties.egressBytesTransferred
  • integer

传输的Egress个字节。

properties.enableBgp
  • boolean

EnableBgp 标志。

properties.enableInternetSecurity
  • boolean

启用 Internet 安全性。

properties.enableRateLimiting
  • boolean

EnableBgp 标志。

properties.ingressBytesTransferred
  • integer

传输的入口字节数。

properties.ipsecPolicies

此连接要考虑的 IPSec 策略。

properties.provisioningState

VPN 连接资源的预配状态。

properties.remoteVpnSite

连接的 VPN 站点的 ID。

properties.routingConfiguration

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

properties.routingWeight
  • integer

VPN 连接的路由权重。

properties.sharedKey
  • string

VPN 连接的 SharedKey。

properties.trafficSelectorPolicies

此连接要考虑的流量选择器策略。

properties.useLocalAzureIpAddress
  • boolean

使用本地 Azure IP 启动连接。

properties.usePolicyBasedTrafficSelectors
  • boolean

启用基于策略的流量选择器。

properties.vpnConnectionProtocolType

用于此连接的连接协议。

properties.vpnLinkConnections

指向网关的所有 VPN 站点链接连接的列表。

VpnConnectionStatus

VPN 连接的当前状态。

Name Type Description
Connected
  • string
Connecting
  • string
NotConnected
  • string
Unknown
  • string

VpnLinkConnectionMode

Vpn 链接连接模式。

Name Type Description
Default
  • string
InitiatorOnly
  • string
ResponderOnly
  • string

VpnSiteLinkConnection

VpnSiteLinkConnection 资源。

Name Type Description
etag
  • string

在更新资源时更改的唯一只读字符串。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.connectionBandwidth
  • integer

预期带宽(以 MBPS 为单位)。

properties.connectionStatus

连接状态。

properties.egressBytesTransferred
  • integer

传输的Egress个字节。

properties.egressNatRules

出口 NatRules 列表。

properties.enableBgp
  • boolean

EnableBgp 标志。

properties.enableRateLimiting
  • boolean

EnableBgp 标志。

properties.ingressBytesTransferred
  • integer

传输的入口字节数。

properties.ingressNatRules

入口 NatRules 列表。

properties.ipsecPolicies

此连接要考虑的 IPSec 策略。

properties.provisioningState

VPN 站点链接连接资源的预配状态。

properties.routingWeight
  • integer

VPN 连接的路由权重。

properties.sharedKey
  • string

VPN 连接的 SharedKey。

properties.useLocalAzureIpAddress
  • boolean

使用本地 Azure IP 启动连接。

properties.usePolicyBasedTrafficSelectors
  • boolean

启用基于策略的流量选择器。

properties.vpnConnectionProtocolType

用于此连接的连接协议。

properties.vpnGatewayCustomBgpAddresses

此连接使用的 vpnGatewayCustomBgpAddresses。

properties.vpnLinkConnectionMode

Vpn 链接连接模式。

properties.vpnSiteLink

连接的 VPN 站点链接的 ID。

type
  • string

资源类型。