Virtual Network Gateways - Get Vpnclient Connection Health
Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth?api-version=2024-01-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
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. |
virtual
|
path | True |
string |
The name of the virtual network gateway. |
api-version
|
query | True |
string |
Client API version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
List of VPN client connection health details. |
|
202 Accepted |
Accepted and the operation will complete asynchronously. |
|
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
GetVirtualNetworkGatewayVpnclientConnectionHealth
Sample request
POST https://management.azure.com/subscriptions/subid/resourceGroups/p2s-vnet-test/providers/Microsoft.Network/virtualNetworkGateways/vpnp2sgw/getVpnClientConnectionHealth?api-version=2024-01-01
Sample response
{
"value": [
{
"vpnConnectionId": "IKEv2_1e1cfe59-5c7c-4315-a876-b11fbfdfeed4",
"vpnConnectionDuration": 900,
"vpnConnectionTime": "2019-05-02T22:26:22",
"publicIpAddress": "167.220.2.232:45522",
"privateIpAddress": "192.168.210.2",
"vpnUserName": "gwp2schildcert",
"maxBandwidth": 240000000,
"egressPacketsTransferred": 557,
"egressBytesTransferred": 33420,
"ingressPacketsTransferred": 557,
"ingressBytesTransferred": 33420,
"maxPacketsPerSecond": 4
},
{
"vpnConnectionId": "IKEv2_571cfe59-2c7d-1415-e813-c51fbfdfea16",
"vpnConnectionDuration": 800,
"vpnConnectionTime": "2019-05-01T21:06:12",
"publicIpAddress": "167.220.2.232:45213",
"privateIpAddress": "192.168.210.1",
"vpnUserName": "gwp2schildcert",
"maxBandwidth": 220000000,
"egressPacketsTransferred": 357,
"egressBytesTransferred": 23420,
"ingressPacketsTransferred": 357,
"ingressBytesTransferred": 23420,
"maxPacketsPerSecond": 4
}
]
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Vpn |
VPN client connection health detail. |
Vpn |
List of virtual network gateway vpn client connection health. |
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. |
VpnClientConnectionHealthDetail
VPN client connection health detail.
Name | Type | Description |
---|---|---|
egressBytesTransferred |
integer |
The egress bytes per second. |
egressPacketsTransferred |
integer |
The egress packets per second. |
ingressBytesTransferred |
integer |
The ingress bytes per second. |
ingressPacketsTransferred |
integer |
The ingress packets per second. |
maxBandwidth |
integer |
The max band width. |
maxPacketsPerSecond |
integer |
The max packets transferred per second. |
privateIpAddress |
string |
The assigned private Ip of a connected vpn client. |
publicIpAddress |
string |
The public Ip of a connected vpn client. |
vpnConnectionDuration |
integer |
The duration time of a connected vpn client. |
vpnConnectionId |
string |
The vpn client Id. |
vpnConnectionTime |
string |
The start time of a connected vpn client. |
vpnUserName |
string |
The user name of a connected vpn client. |
VpnClientConnectionHealthDetailListResult
List of virtual network gateway vpn client connection health.
Name | Type | Description |
---|---|---|
value |
List of vpn client connection health. |