Troubleshooting Utilities for Azure VPN Connections
This section provides documentation for PowerShell cmdlets designed to help troubleshoot and manage VPN client connections to Azure Virtual Network Gateways. These utilities are crucial for diagnosing connectivity issues, verifying configurations, and ensuring seamless remote access to your Azure resources.
Retrieves information about active VPN client connections to an Azure Virtual Network Gateway.
Get-AzVirtualNetworkGatewayVPNClientConnection [-Name] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
| Name | Description | Required |
|---|---|---|
| -Name | Specifies the name of the Virtual Network Gateway. | True |
| -ResourceGroupName | Specifies the name of the resource group. | True |
| -DefaultProfile | The credentials, account, tenant, and subscription used for communication with Azure. | False |
Get-AzVirtualNetworkGatewayVPNClientConnection -Name "myVNG" -ResourceGroupName "myResourceGroup"
Tests the connectivity from a VPN client to an Azure Virtual Network Gateway.
Test-AzVirtualNetworkGatewayVPNClientConnection [-VirtualNetworkGatewayName] <String> [-ResourceGroupName] <String> [-IpAddress] <String> [-TunnelName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
| Name | Description | Required |
|---|---|---|
| -VirtualNetworkGatewayName | The name of the Virtual Network Gateway. | True |
| -ResourceGroupName | The name of the resource group. | True |
| -IpAddress | The IP address of the VPN client to test connectivity from. | True |
| -TunnelName | The name of the VPN tunnel to test. | True |
| -DefaultProfile | The credentials, account, tenant, and subscription used for communication with Azure. | False |
Test-AzVirtualNetworkGatewayVPNClientConnection -VirtualNetworkGatewayName "myVNG" -ResourceGroupName "myResourceGroup" -IpAddress "192.168.1.100" -TunnelName "Tunnel1"
Removes a specific VPN client connection from an Azure Virtual Network Gateway. Use with caution.
Remove-AzVirtualNetworkGatewayVPNClientConnection [-Name] <String> [-ResourceGroupName] <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
| Name | Description | Required |
|---|---|---|
| -Name | Specifies the name of the Virtual Network Gateway. | True |
| -ResourceGroupName | Specifies the name of the resource group. | True |
| -Force | Suppresses confirmation prompts. | False |
| -AsJob | Run cmdlet in the background. | False |
| -DefaultProfile | The credentials, account, tenant, and subscription used for communication with Azure. | False |
Remove-AzVirtualNetworkGatewayVPNClientConnection -Name "myVNG" -ResourceGroupName "myResourceGroup" -Force