Azure Virtual Network Gateway VPN Client Connection Throughput Cmdlets

Get-AzVpnClientConnectionThroughput

Module: Az.Network

Applies to: Az.Network v1.0.0 and later

Synopsis: Gets the throughput for an Azure VPN client connection.

Description: The Get-AzVpnClientConnectionThroughput cmdlet gets the throughput for a specific Azure VPN client connection. This cmdlet is useful for monitoring the performance of your VPN connections.

Syntax

Get-AzVpnClientConnectionThroughput
   -ResourceGroupName <String>
   -VirtualNetworkGatewayName <String>
   -VpnConnectionId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Parameters

-ResourceGroupName <String>: Specifies the name of the resource group for the virtual network gateway.
-VirtualNetworkGatewayName <String>: Specifies the name of the virtual network gateway.
-VpnConnectionId <String>: Specifies the ID of the VPN client connection for which to retrieve throughput information.
-DefaultProfile <IAzureContextContainer>: The credentials, account, tenant, and subscription for the session.

Examples

Example 1: Get throughput for a specific VPN client connection

Get-AzVpnClientConnectionThroughput -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway" -VpnConnectionId "a1b2c3d4-e5f6-7890-1234-567890abcdef"

This command retrieves the throughput statistics for the VPN client connection with the ID 'a1b2c3d4-e5f6-7890-1234-567890abcdef' associated with the 'MyVpnGateway' in the 'MyResourceGroup' resource group.

Return Values

The cmdlet returns an object of type Microsoft.Azure.Commands.Network.Models.PSVpnClientConnectionThroughput, which contains the following properties:

InboundTrafficInBytes: The inbound traffic in bytes.
OutboundTrafficInBytes: The outbound traffic in bytes.

Notes

This cmdlet requires the Az.Network module to be installed and imported. Ensure that you have the necessary permissions to access the virtual network gateway and its associated resources.