Azure Virtual Network Gateway VPN Client Connection Cmdlets
This document provides a reference for PowerShell cmdlets used to manage VPN client connections for Azure Virtual Network Gateways. These cmdlets allow you to configure, monitor, and troubleshoot VPN connections from clients to your Azure virtual network.
Overview
Azure VPN Gateway enables secure, cross-premises connectivity through encrypted tunnels. This section focuses on cmdlets that help you manage the client-side aspects of these VPN connections, including obtaining connection configurations, monitoring status, and troubleshooting common issues.
Key Cmdlets
| Cmdlet Name | Description | Example Usage |
|---|---|---|
| Get-AzVpnClientConnectionConfiguration | Retrieves the VPN client configuration for a specified gateway. This includes details needed to establish a client-to-site VPN connection. |
Get-AzVpnClientConnectionConfiguration -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup"
|
| Get-AzVpnClientConnectionHealth | Retrieves the health status of VPN client connections to a virtual network gateway. |
Get-AzVpnClientConnectionHealth -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup"
|
| Get-AzVirtualNetworkGatewayVpnClientConnectionState | (Deprecated - use Get-AzVpnClientConnectionHealth) Provides the state of VPN client connections. |
Get-AzVirtualNetworkGatewayVpnClientConnectionState -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup"
|
| Get-AzVpnClientRevokedCertificate | Retrieves the list of revoked certificates used for VPN client authentication. |
Get-AzVpnClientRevokedCertificate -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup"
|
| Add-AzVpnClientRevokedCertificate | Adds a revoked client certificate to the VPN gateway's configuration. |
Add-AzVpnClientRevokedCertificate -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup" -Name "CertToRemove" -Thumbprint "A1B2C3D4..."
|
| Remove-AzVpnClientRevokedCertificate | Removes a revoked client certificate from the VPN gateway's configuration. |
Remove-AzVpnClientRevokedCertificate -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup" -Name "CertToRemove"
|