Get-AzVirtualNetworkGatewayVpnClientConnectionHealth
Get the list of vpn client connection health of an Azure virtual network gateway for per vpn client connection
Syntax
Get-AzVirtualNetworkGatewayVpnClientConnectionHealth
-VirtualNetworkGatewayName <String>
-ResourceGroupName <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-AzVirtualNetworkGatewayVpnClientConnectionHealth
[-ResourceId <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-AzVirtualNetworkGatewayVpnClientConnectionHealth
[-InputObject <PSVirtualNetworkGateway>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
List all connected vpn client connection health. This includes: vpnConnectionId vpnConnectionDuration vpnConnectionTime publicIpAddress privateIpAddress vpnUserName maxBandwidth egressPacketsTransferred egressBytesTransferred ingressPacketsTransferred ingressBytesTransferred maxPacketsPerSecond
Examples
Example 1
Get-AzVirtualNetworkGatewayVpnClientConnectionHealth -ResourceName gatewayName -ResourceGroupName resourceGroup
VpnConnectionId : OVPN_0085393D-B345-4846-0426-140616833F4C
VpnConnectionDuration : 27878
VpnConnectionTime : 05/30/2019 16:03:11
PublicIpAddress : 13.78.148.224:39672
PrivateIpAddress : 10.1.1.131
VpnUserName : GWP2SChildCert
MaxBandwidth : 48000000
EgressPacketsTransferred : 104084
EgressBytesTransferred : 4059276
IngressPacketsTransferred : 1410
IngressBytesTransferred : 67680
MaxPacketsPerSecond : 1
VpnConnectionId : OVPN_00F692AC-2D6F-DE7B-DCAF-07BE896233A0
VpnConnectionDuration : 27878
VpnConnectionTime : 05/30/2019 16:03:11
PublicIpAddress : 13.78.148.224:39692
PrivateIpAddress : 10.1.1.79
VpnUserName : GWP2SChildCert
MaxBandwidth : 48000000
EgressPacketsTransferred : 104623
EgressBytesTransferred : 4080297
IngressPacketsTransferred : 1416
IngressBytesTransferred : 67968
MaxPacketsPerSecond : 1For the Azure virtual network gateway named gatewayname in resource group resourceGroup, retrieves the currently connected vpn client connection by using OpenVpn.
Example 2
Get the list of vpn client connection health of an Azure virtual network gateway for per vpn client connection. (autogenerated)
Get-AzVirtualNetworkGatewayVpnClientConnectionHealth -ResourceGroupName resourceGroup -VirtualNetworkGatewayName 'ContosoVirtualNetwork'Parameters
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Virtual network gateway object
| Type: | PSVirtualNetworkGateway |
| Aliases: | VirtualNetworkGateway |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Virtual network gateway resource group's name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
Virtual network gateway resource Id
| Type: | String |
| Aliases: | VirtualNetworkGatewayId |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualNetworkGatewayName
Virtual network gateway name
| Type: | String |
| Aliases: | ResourceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |