Vpn Link Connections - List By Vpn Connection
Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections?api-version=2023-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
connection
|
path | True |
string |
The name of the vpn connection. |
gateway
|
path | True |
string |
The name of the gateway. |
resource
|
path | True |
string |
The resource group name of the vpn gateway. |
subscription
|
path | True |
string |
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client API version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Request successful. Returns all Vpn connections for a virtual wan vpn gateway. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
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 | impersonate your user account |
Examples
VpnSiteLinkConnectionList
Sample Request
Sample Response
[
{
"name": "Connection-Link1",
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"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,
"vpnGatewayCustomBgpAddresses": [
{
"ipConfigurationId": "Instance0",
"customBgpIpAddress": "169.254.21.1"
},
{
"ipConfigurationId": "Instance1",
"customBgpIpAddress": "169.254.21.3"
}
],
"enableRateLimiting": false,
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"routingWeight": 0
}
}
]
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Dh |
The DH Groups used in IKE Phase 1 for initial SA. |
Gateway |
GatewayCustomBgpIpAddressIpConfiguration for a virtual network gateway connection. |
Ike |
The IKE encryption algorithm (IKE phase 2). |
Ike |
The IKE integrity algorithm (IKE phase 2). |
Ipsec |
The IPSec encryption algorithm (IKE phase 1). |
Ipsec |
The IPSec integrity algorithm (IKE phase 1). |
Ipsec |
An IPSec Policy configuration for a virtual network gateway connection. |
List |
Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results. |
Pfs |
The Pfs Groups used in IKE Phase 2 for new child SA. |
Provisioning |
The current provisioning state. |
Sub |
Reference to another subresource. |
Virtual |
Connection protocol used for this connection. |
Vpn |
The current state of the vpn connection. |
Vpn |
Vpn link connection mode. |
Vpn |
VpnSiteLinkConnection Resource. |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
Cloud error body. |
CloudErrorBody
An error response from the service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
DhGroup
The DH Groups used in IKE Phase 1 for initial SA.
Name | Type | Description |
---|---|---|
DHGroup1 |
string |
|
DHGroup14 |
string |
|
DHGroup2 |
string |
|
DHGroup2048 |
string |
|
DHGroup24 |
string |
|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
GatewayCustomBgpIpAddressIpConfiguration
GatewayCustomBgpIpAddressIpConfiguration for a virtual network gateway connection.
Name | Type | Description |
---|---|---|
customBgpIpAddress |
string |
The custom BgpPeeringAddress which belongs to IpconfigurationId. |
ipConfigurationId |
string |
The IpconfigurationId of ipconfiguration which belongs to gateway. |
IkeEncryption
The IKE encryption algorithm (IKE phase 2).
Name | Type | Description |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES256 |
string |
IkeIntegrity
The IKE integrity algorithm (IKE phase 2).
Name | Type | Description |
---|---|---|
GCMAES128 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
|
SHA384 |
string |
IpsecEncryption
The IPSec encryption algorithm (IKE phase 1).
Name | Type | Description |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
None |
string |
IpsecIntegrity
The IPSec integrity algorithm (IKE phase 1).
Name | Type | Description |
---|---|---|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
IpsecPolicy
An IPSec Policy configuration for a virtual network gateway connection.
Name | Type | Description |
---|---|---|
dhGroup |
The DH Group used in IKE Phase 1 for initial SA. |
|
ikeEncryption |
The IKE encryption algorithm (IKE phase 2). |
|
ikeIntegrity |
The IKE integrity algorithm (IKE phase 2). |
|
ipsecEncryption |
The IPSec encryption algorithm (IKE phase 1). |
|
ipsecIntegrity |
The IPSec integrity algorithm (IKE phase 1). |
|
pfsGroup |
The Pfs Group used in IKE Phase 2 for new child SA. |
|
saDataSizeKilobytes |
integer |
The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. |
saLifeTimeSeconds |
integer |
The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. |
ListVpnSiteLinkConnectionsResult
Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.
Name | Type | Description |
---|---|---|
nextLink |
string |
URL to get the next set of operation list results if there are any. |
value |
List of VpnSiteLinkConnections. |
PfsGroup
The Pfs Groups used in IKE Phase 2 for new child SA.
Name | Type | Description |
---|---|---|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
|
PFS1 |
string |
|
PFS14 |
string |
|
PFS2 |
string |
|
PFS2048 |
string |
|
PFS24 |
string |
|
PFSMM |
string |
ProvisioningState
The current provisioning state.
Name | Type | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
SubResource
Reference to another subresource.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
VirtualNetworkGatewayConnectionProtocol
Connection protocol used for this connection.
Name | Type | Description |
---|---|---|
IKEv1 |
string |
|
IKEv2 |
string |
VpnConnectionStatus
The current state of the vpn connection.
Name | Type | Description |
---|---|---|
Connected |
string |
|
Connecting |
string |
|
NotConnected |
string |
|
Unknown |
string |
VpnLinkConnectionMode
Vpn link connection mode.
Name | Type | Description |
---|---|---|
Default |
string |
|
InitiatorOnly |
string |
|
ResponderOnly |
string |
VpnSiteLinkConnection
VpnSiteLinkConnection Resource.
Name | Type | Description |
---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
id |
string |
Resource ID. |
name |
string |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
properties.connectionBandwidth |
integer |
Expected bandwidth in MBPS. |
properties.connectionStatus |
The connection status. |
|
properties.egressBytesTransferred |
integer |
Egress bytes transferred. |
properties.egressNatRules |
List of egress NatRules. |
|
properties.enableBgp |
boolean |
EnableBgp flag. |
properties.enableRateLimiting |
boolean |
EnableBgp flag. |
properties.ingressBytesTransferred |
integer |
Ingress bytes transferred. |
properties.ingressNatRules |
List of ingress NatRules. |
|
properties.ipsecPolicies |
The IPSec Policies to be considered by this connection. |
|
properties.provisioningState |
The provisioning state of the VPN site link connection resource. |
|
properties.routingWeight |
integer |
Routing weight for vpn connection. |
properties.sharedKey |
string |
SharedKey for the vpn connection. |
properties.useLocalAzureIpAddress |
boolean |
Use local azure ip to initiate connection. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Enable policy-based traffic selectors. |
properties.vpnConnectionProtocolType |
Connection protocol used for this connection. |
|
properties.vpnGatewayCustomBgpAddresses |
vpnGatewayCustomBgpAddresses used by this connection. |
|
properties.vpnLinkConnectionMode |
Vpn link connection mode. |
|
properties.vpnSiteLink |
Id of the connected vpn site link. |
|
type |
string |
Resource type. |