Azure Virtual Network Gateway VPN Client Connection Overview Cmdlets

This section provides an overview of the Azure PowerShell cmdlets used to manage and configure VPN client connections for Azure Virtual Network Gateways. These cmdlets are essential for establishing secure connectivity between your on-premises networks or individual clients and your Azure Virtual Networks.

Key Cmdlets

Get-AzVirtualNetworkGatewayVpnClientConnectionConfiguration

Retrieves the VPN client connection configuration for a Virtual Network Gateway.

Learn More →

Set-AzVirtualNetworkGatewayVpnClientConnectionConfiguration

Configures the VPN client connection settings for a Virtual Network Gateway.

Learn More →

Add-AzVirtualNetworkGatewayVpnClientRootCertificate

Adds a root certificate for VPN client authentication to a Virtual Network Gateway.

Learn More →

Remove-AzVirtualNetworkGatewayVpnClientRootCertificate

Removes a root certificate from a Virtual Network Gateway.

Learn More →

Get-AzVirtualNetworkGatewayVpnClientRootCertificate

Retrieves the root certificates configured for VPN client authentication on a Virtual Network Gateway.

Learn More →

Add-AzVirtualNetworkGatewayVpnClientRevokedCertificate

Adds a revoked client certificate to a Virtual Network Gateway to prevent specific clients from connecting.

Learn More →

Remove-AzVirtualNetworkGatewayVpnClientRevokedCertificate

Removes a revoked client certificate from a Virtual Network Gateway.

Learn More →

Get-AzVirtualNetworkGatewayVpnClientRevokedCertificate

Retrieves the revoked client certificates configured for a Virtual Network Gateway.

Learn More →

Common Parameters

Most of these cmdlets accept common Azure PowerShell parameters such as:

-ResourceGroupName: The name of the resource group for the Virtual Network Gateway.
-VirtualNetworkGatewayName: The name of the Virtual Network Gateway.
-Force: Suppresses confirmation prompts.
-AsJob: Runs the cmdlet as a background job.

Example Usage

Here's an example of how to retrieve the VPN client connection configuration for a gateway:


Get-AzVirtualNetworkGatewayVpnClientConnectionConfiguration `
    -ResourceGroupName "MyResourceGroup" `
    -VirtualNetworkGatewayName "MyVpnGateway"

Ensure you have the latest version of the Az.Network module installed to access these cmdlets. You can update it using Update-Module -Name Az.Network.