virtual_network_gateways_vpnclient_connection_health
Creates, updates, deletes, gets or lists a virtual_network_gateways_vpnclient_connection_health resource.
Overview
| Name | virtual_network_gateways_vpnclient_connection_health |
| Type | Resource |
| Id | azure.network.virtual_network_gateways_vpnclient_connection_health |
Fields
The following fields are returned by SELECT queries:
- get
List of VPN client connection health details.
| Name | Datatype | Description |
|---|---|---|
egressBytesTransferred | integer (int64) | The egress bytes per second. |
egressPacketsTransferred | integer (int64) | The egress packets per second. |
ingressBytesTransferred | integer (int64) | The ingress bytes per second. |
ingressPacketsTransferred | integer (int64) | The ingress packets per second. |
maxBandwidth | integer (int64) | The max band width. |
maxPacketsPerSecond | integer (int64) | 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 (int64) | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resourceGroupName, virtualNetworkGatewayName, subscriptionId | Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
resourceGroupName | string | The name of the resource group. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
virtualNetworkGatewayName | string | The name of the virtual network gateway. |
SELECT examples
- get
Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
SELECT
egressBytesTransferred,
egressPacketsTransferred,
ingressBytesTransferred,
ingressPacketsTransferred,
maxBandwidth,
maxPacketsPerSecond,
privateIpAddress,
publicIpAddress,
vpnConnectionDuration,
vpnConnectionId,
vpnConnectionTime,
vpnUserName
FROM azure.network.virtual_network_gateways_vpnclient_connection_health
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;