Azure Virtual Network Gateway VPN Client Connection Cmdlets

This page provides a reference for PowerShell cmdlets used to manage VPN client connections for Azure Virtual Network Gateways.

These cmdlets are crucial for configuring, monitoring, and troubleshooting the connections that allow client devices to securely access your Azure Virtual Network resources.

Overview

Azure Virtual Network Gateways enable secure VPN connections between your on-premises network and your Azure Virtual Network, or between different Azure Virtual Networks. Managing VPN client connections involves tasks such as generating client configuration packages, downloading connection profiles, and verifying connection status.

Cmdlet Categories

The following cmdlets are organized by their primary function:

Cmdlet Details

Get-AzVirtualNetworkGatewayVpnClientConnection

Description: Retrieves information about VPN client connections for a specified virtual network gateway.

Parameters:

  • -Name: The name of the virtual network gateway.
  • -ResourceGroupName: The name of the resource group.

Example:

Get-AzVirtualNetworkGatewayVpnClientConnection -Name "MyVNG" -ResourceGroupName "MyResourceGroup"

New-AzVirtualNetworkGatewayVpnClientConnection

Description: Creates a new VPN client connection profile for a virtual network gateway. This is often used to generate configuration files for VPN clients.

Parameters:

  • -Name: The name of the virtual network gateway.
  • -ResourceGroupName: The name of the resource group.
  • -VpnClientProtocol: Specifies the VPN client protocol (e.g., 'IKEv2', 'SSTP').
  • -AuthenticationMethod: Specifies the authentication method (e.g., 'Eap', 'PresharedKey').

Example:

New-AzVirtualNetworkGatewayVpnClientConnection -Name "MyVNG" -ResourceGroupName "MyResourceGroup" -VpnClientProtocol "IKEv2" -AuthenticationMethod "Eap"

Remove-AzVirtualNetworkGatewayVpnClientConnection

Description: Removes a previously created VPN client connection profile from a virtual network gateway.

Parameters:

  • -Name: The name of the virtual network gateway.
  • -ResourceGroupName: The name of the resource group.

Example:

Remove-AzVirtualNetworkGatewayVpnClientConnection -Name "MyVNG" -ResourceGroupName "MyResourceGroup"

Get-AzVirtualNetworkGatewayVpnClientConfiguration

Description: Retrieves the current VPN client configuration settings applied to a virtual network gateway.

Parameters:

  • -VirtualNetworkGatewayName: The name of the virtual network gateway.
  • -ResourceGroupName: The name of the resource group.

Example:

Get-AzVirtualNetworkGatewayVpnClientConfiguration -VirtualNetworkGatewayName "MyVNG" -ResourceGroupName "MyResourceGroup"

Set-AzVirtualNetworkGatewayVpnClientConfiguration

Description: Configures the VPN client settings, such as address pools and DNS servers, for a virtual network gateway.

Parameters:

  • -VirtualNetworkGatewayName: The name of the virtual network gateway.
  • -ResourceGroupName: The name of the resource group.
  • -VpnClientAddressPool: A CIDR block for the VPN client IP address pool.
  • -VpnClientIpsecPfsGroup: The IPsec Perfect Forward Secrecy group.

Example:

Set-AzVirtualNetworkGatewayVpnClientConfiguration -VirtualNetworkGatewayName "MyVNG" -ResourceGroupName "MyResourceGroup" -VpnClientAddressPool "10.10.0.0/24"

Get-AzVirtualNetworkGatewayConnection

Description: Retrieves details about a specific connection associated with a virtual network gateway.

Parameters:

  • -Name: The name of the virtual network gateway connection.
  • -ResourceGroupName: The name of the resource group.

Example:

Get-AzVirtualNetworkGatewayConnection -Name "MyConnection" -ResourceGroupName "MyResourceGroup"

Get-AzVirtualNetworkGatewayConnectionStatus

Description: Retrieves the real-time connection status of a virtual network gateway connection.

Parameters:

  • -Name: The name of the virtual network gateway connection.
  • -ResourceGroupName: The name of the resource group.

Example:

Get-AzVirtualNetworkGatewayConnectionStatus -Name "MyConnection" -ResourceGroupName "MyResourceGroup"