共用方式為

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 參數

名稱 位於 必要 類型 Description
connectionName
 path True

string

vpn 連線的名稱。
gatewayName
 path True

string

閘道器的名稱。
resourceGroupName
 path True

string

VpnGateway 的資源組名。
subscriptionId
 path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version
 query True

string

用戶端 API 版本。

回應

名稱 類型 Description
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

名稱 Description
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

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"
      }
    }
  }
}

定義

名稱 Description
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

所有靜態路由的清單。
StaticRoutesConfig

此 HubVnetConnectionConfiguration 上靜態路由的組態，用於此 HubVnetConnection 上的靜態路由。
SubResource

另一個子資源的參考。
TrafficSelectorPolicy

虛擬網路網關聯機的流量選取器原則。
VirtualNetworkGatewayConnectionProtocol

用於此連線的連線通訊協定。
VnetLocalRouteOverrideCriteria

參數，判斷輪輻 vnet 中的 NVA 是否略過輪輻 vnet 中的目的地流量。
VnetRoute

控制從 VirtualHub 到虛擬網路連線之路由的路由清單。
VpnConnection

VpnConnection 資源。
VpnConnectionStatus

vpn 連線的目前狀態。
VpnLinkConnectionMode

Vpn 連結連線模式。
VpnSiteLinkConnection

VpnSiteLinkConnection 資源。

CloudError

來自服務的錯誤回應。

名稱 類型 Description
error

CloudErrorBody

雲端錯誤本文。

CloudErrorBody

來自服務的錯誤回應。

名稱 類型 Description
code

string

錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
details

CloudErrorBody[]

錯誤的其他詳細數據清單。
message

string

描述錯誤的訊息，適用於在使用者介面中顯示。
target

string

特定錯誤的目標。 例如，錯誤中屬性的名稱。

DhGroup

IKE 階段 1 中用於初始 SA 的 DH 群組。

名稱 類型 Description
DHGroup1

string

DHGroup14

string

DHGroup2

string

DHGroup2048

string

DHGroup24

string

ECP256

string

ECP384

string

None

string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration 用於虛擬網路網關聯機。

名稱 類型 Description
customBgpIpAddress

string

屬於 IpconfigurationId 的自定義 BgpPeeringAddress。
ipConfigurationId

string

屬於閘道之 ipconfiguration 的 IpconfigurationId。

IkeEncryption

IKE 加密演算法 (IKE 階段 2) 。

名稱 類型 Description
AES128

string

AES192

string

AES256

string

DES

string

DES3

string

GCMAES128

string

GCMAES256

string

IkeIntegrity

IKE 完整性演算法 (IKE 階段 2) 。

名稱 類型 Description
GCMAES128

string

GCMAES256

string

MD5

string

SHA1

string

SHA256

string

SHA384

string

IpsecEncryption

IPSec 加密演算法 (IKE 階段 1) 。

名稱 類型 Description
AES128

string

AES192

string

AES256

string

DES

string

DES3

string

GCMAES128

string

GCMAES192

string

GCMAES256

string

None

string

IpsecIntegrity

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

名稱 類型 Description
GCMAES128

string

GCMAES192

string

GCMAES256

string

MD5

string

SHA1

string

SHA256

string

IpsecPolicy

虛擬網路網關聯機的IPSec原則設定。

名稱 類型 Description
dhGroup

DhGroup

IKE 階段 1 中用於初始 SA 的 DH 群組。
ikeEncryption

IkeEncryption

IKE 加密演算法 (IKE 階段 2) 。
ikeIntegrity

IkeIntegrity

IKE 完整性演算法 (IKE 階段 2) 。
ipsecEncryption

IpsecEncryption

IPSec 加密演算法 (IKE 階段 1) 。
ipsecIntegrity

IpsecIntegrity

IPSec 完整性演算法 (IKE 階段 1) 。
pfsGroup

PfsGroup

IKE 階段 2 中用於新子 SA 的 Pfs 群組。
saDataSizeKilobytes

integer

IPSec 安全性關聯 (也稱為快速模式或階段 2 SA) KB 的承載大小，供站對站 VPN 通道使用。
saLifeTimeSeconds

integer

IPSec 安全性關聯 (也稱為快速模式或階段 2 SA) 存留期，以秒為單位，讓站對站 VPN 通道。

PfsGroup

IKE 階段 2 中用於新子 SA 的 Pfs 群組。

名稱 類型 Description
ECP256

string

ECP384

string

None

string

PFS1

string

PFS14

string

PFS2

string

PFS2048

string

PFS24

string

PFSMM

string

PropagatedRouteTable

要公告路由的 RouteTable 列表。

名稱 類型 Description
ids

SubResource[]

所有 RouteTable 的資源標識符清單。
labels

string[]

標籤清單。

ProvisioningState

目前的布建狀態。

名稱 類型 Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

RoutingConfiguration

路由組態，指出此聯機的相關聯和傳播路由表。

名稱 類型 Description
associatedRouteTable

SubResource

與此 RoutingConfiguration 相關聯的資源標識碼 RouteTable。
inboundRouteMap

SubResource

與這個 RoutingConfiguration 相關聯的 RouteMap 資源識別碼，用於輸入學習的路由。
outboundRouteMap

SubResource

與這個 RoutingConfiguration 相關聯的RouteMap 資源標識碼，用於輸出公告的路由。
propagatedRouteTables

PropagatedRouteTable

要公告路由的 RouteTable 列表。
vnetRoutes

VnetRoute

控制從 VirtualHub 到虛擬網路連線之路由的路由清單。

StaticRoute

所有靜態路由的清單。

名稱 類型 Description
addressPrefixes

string[]

所有位址前置詞的清單。
name

string

VnetRoute 內唯一的 StaticRoute 名稱。
nextHopIpAddress

string

下一個躍點的IP位址。

StaticRoutesConfig

此 HubVnetConnectionConfiguration 上靜態路由的組態，用於此 HubVnetConnection 上的靜態路由。

名稱 類型 Description
propagateStaticRoutes

boolean

布爾值，指出此連線上的靜態路由是否會自動傳播至此連接傳播至的路由表。
vnetLocalRouteOverrideCriteria

VnetLocalRouteOverrideCriteria

判斷輪輻 vnet 中 NVA 是否略過具有輪輻目的地之流量的參數。

SubResource

另一個子資源的參考。

名稱 類型 Description
id

string

資源識別碼。

TrafficSelectorPolicy

虛擬網路網關聯機的流量選取器原則。

名稱 類型 Description
localAddressRanges

string[]

CIDR 格式的本機位址空間集合。
remoteAddressRanges

string[]

CIDR 格式的遠端位址空間集合。

VirtualNetworkGatewayConnectionProtocol

用於此連線的連線通訊協定。

名稱 類型 Description
IKEv1

string

IKEv2

string

VnetLocalRouteOverrideCriteria

參數，判斷輪輻 vnet 中的 NVA 是否略過輪輻 vnet 中的目的地流量。

名稱 類型 Description
Contains

string

Equal

string

VnetRoute

控制從 VirtualHub 到虛擬網路連線之路由的路由清單。

名稱 類型 Description
bgpConnections

SubResource[]

HubBgpConnection 對象的參考清單。
staticRoutes

StaticRoute[]

所有靜態路由的清單。
staticRoutesConfig

StaticRoutesConfig

此 HubVnetConnection 上的靜態路由設定。

VpnConnection

VpnConnection 資源。

名稱 類型 Description
etag

string

每當更新資源時變更的唯一隻讀字串。
id

string

資源識別碼。
name

string

資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.connectionBandwidth

integer

MBPS 的預期頻寬。
properties.connectionStatus

VpnConnectionStatus

線上狀態。
properties.dpdTimeoutSeconds

integer

VPN 連線的 DPD 逾時以秒為單位。
properties.egressBytesTransferred

integer

傳送的輸出位元組。
properties.enableBgp

boolean

EnableBgp 旗標。
properties.enableInternetSecurity

boolean

啟用因特網安全性。
properties.enableRateLimiting

boolean

EnableBgp 旗標。
properties.ingressBytesTransferred

integer

傳送的輸入位元組。
properties.ipsecPolicies

IpsecPolicy[]

此連線要考慮的IPSec原則。
properties.provisioningState

ProvisioningState

VPN 連線資源的布建狀態。
properties.remoteVpnSite

SubResource

已連線 VPN 網站的識別碼。
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 連線的目前狀態。

名稱 類型 Description
Connected

string

Connecting

string

NotConnected

string

Unknown

string

VpnLinkConnectionMode

Vpn 連結連線模式。

名稱 類型 Description
Default

string

InitiatorOnly

string

ResponderOnly

string

VpnSiteLinkConnection

VpnSiteLinkConnection 資源。

名稱 類型 Description
etag

string

每當更新資源時變更的唯一隻讀字串。
id

string

資源識別碼。
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 網站鏈接識別碼。
type

string

資源類型。