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

Name	Datatype	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.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.

SELECT examples

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 }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}';