Azure Virtual Network Gateway VPN Client Connection Statistics Cmdlets

Introduction

Azure Virtual Network Gateways enable secure, cross-premises connectivity through VPN tunnels. Understanding the connection statistics of your VPN clients is crucial for monitoring network health, troubleshooting connectivity issues, and ensuring optimal performance. The following PowerShell cmdlets provide granular access to this vital information.

Key Cmdlets

Get-AzVpnClientConnectionStatistics

Retrieves the VPN client connection statistics for a specified Virtual Network Gateway.

Syntax

Parameters

Name	Description	Required
-VirtualNetworkGatewayName	The name of the Virtual Network Gateway.	Yes
-ResourceGroupName	The name of the resource group.	No
-DefaultProfile	The Azure context to use for this command.	No

Example Usage

# Get connection statistics for a VPN gateway in the 'MyResourceGroup' resource group
Get-AzVpnClientConnectionStatistics -VirtualNetworkGatewayName "myVpnGateway" -ResourceGroupName "MyResourceGroup"

Output

The cmdlet returns an object containing the following properties:

• VpnClientConnectionStatistics: An array of objects, each representing a client connection with details like IP address, connection duration, ingress/egress bytes, and connection status.
• TotalBgpSessionStatus: Information about the BGP session status if applicable.

Get-AzVpnClientConnectionStatisticsPerUser

Retrieves the VPN client connection statistics for a specific user connected to a Virtual Network Gateway.

Syntax

Parameters

Name	Description	Required
-VirtualNetworkGatewayName	The name of the Virtual Network Gateway.	Yes
-User	The username of the VPN client.	Yes
-ResourceGroupName	The name of the resource group.	No
-DefaultProfile	The Azure context to use for this command.	No

Example Usage

# Get connection statistics for a specific user
Get-AzVpnClientConnectionStatisticsPerUser -VirtualNetworkGatewayName "myVpnGateway" -ResourceGroupName "MyResourceGroup" -User "jane.doe@example.com"

Output

Returns an object containing detailed connection statistics for the specified user, including their IP address, connection duration, data transfer, and connection state.

Related Cmdlets

• New-AzVirtualNetworkGateway
• Get-AzVirtualNetworkGateway
• Remove-AzVirtualNetworkGateway
• Set-AzVirtualNetworkGatewayIpConfig

For more advanced network management and monitoring in Azure, explore the full Azure PowerShell documentation.