Azure Virtual Network Gateway VPN Client Connection Cmdlets

Reference for PowerShell cmdlets used to manage VPN client connection configurations for Azure Virtual Network Gateways.

Overview

This section provides a comprehensive list of PowerShell cmdlets designed for managing the configuration and deployment of VPN client connections to your Azure Virtual Network Gateways. These cmdlets allow you to automate the creation, modification, and removal of VPN client connection settings, including generating client configuration packages.

Cmdlets

Get-AzVpnClientConnectionConfiguration

Retrieves the VPN client connection configuration for a virtual network gateway.

Get-AzVpnClientConnectionConfiguration -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup"

New-AzVpnClientConnectionConfiguration

Creates a new VPN client connection configuration for a virtual network gateway.

New-AzVpnClientConnectionConfiguration -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup" -VpnClientAddressPool "10.0.0.0/24"

Set-AzVpnClientConnectionConfiguration

Updates an existing VPN client connection configuration.

Set-AzVpnClientConnectionConfiguration -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup" -VpnClientAddressPool "10.0.0.0/25"

Remove-AzVpnClientConnectionConfiguration

Removes a VPN client connection configuration from a virtual network gateway.

Remove-AzVpnClientConnectionConfiguration -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup"

Get-AzVpnClientPackage

Generates and downloads a VPN client package for a virtual network gateway.

Get-AzVpnClientPackage -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup" -PackageType VpnClientPackage -OutputFileName "vpnclient.zip"

Add-AzVpnClientRootCertificate

Adds a root certificate to the virtual network gateway for client authentication.

Add-AzVpnClientRootCertificate -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup" -CertificateData (Get-Content -Path "C:\certs\root.cer" -Encoding Byte)

Remove-AzVpnClientRootCertificate

Removes a root certificate from the virtual network gateway.

Remove-AzVpnClientRootCertificate -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup" -Thumbprint "your_certificate_thumbprint"

Set-AzVirtualNetworkGatewayVpnClientConfiguration

Configures the VPN client settings for a virtual network gateway.

Set-AzVirtualNetworkGatewayVpnClientConfiguration -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup" -VpnClientAddressPool "10.1.0.0/24" -VpnClientRootCertificates @(Get-AzVpnClientRootCertificate -VirtualNetworkGatewayName "myGateway" -ResourceGroupName "myResourceGroup")

Related Concepts