Azure Virtual Network Gateway VPN Client Connection Cmdlets
This section provides detailed information about the PowerShell cmdlets used to manage VPN client connections for Azure Virtual Network Gateways. These cmdlets allow you to configure, download, and manage VPN client profiles for establishing secure connections to your Azure Virtual Network.
Key Cmdlets
Get-AzVirtualNetworkGatewayVpnClientConfiguration
Retrieves the VPN client configuration for a virtual network gateway.
Get-AzVirtualNetworkGatewayVpnClientConfiguration -VirtualNetworkGatewayName "MyGateway" -ResourceGroupName "MyResourceGroup"
Get-AzVirtualNetworkGatewayVpnClientConfigurationFile
Downloads the VPN client configuration file for a virtual network gateway.
Get-AzVirtualNetworkGatewayVpnClientConfigurationFile -VirtualNetworkGatewayName "MyGateway" -ResourceGroupName "MyResourceGroup" -AuthenticationMethod "EAPTLS" -VpnType "VpnClient"
Set-AzVirtualNetworkGatewayVpnClientConfiguration
Configures the VPN client settings for a virtual network gateway.
Set-AzVirtualNetworkGatewayVpnClientConfiguration -VirtualNetworkGatewayName "MyGateway" -ResourceGroupName "MyResourceGroup" -VpnClientIpPoolAddressRange @("10.0.0.0/24") -VpnClientRootCertificates @($cert)
Add-AzVirtualNetworkGatewayVpnClientRootCertificate
Adds a root certificate to the virtual network gateway for VPN client authentication.
Add-AzVirtualNetworkGatewayVpnClientRootCertificate -VirtualNetworkGatewayName "MyGateway" -ResourceGroupName "MyResourceGroup" -CertificateData $([System.Convert]::ToBase64String((Get-Content -Path ".\MyRootCert.cer" -Encoding Byte -ReadCount 0)))
Remove-AzVirtualNetworkGatewayVpnClientRootCertificate
Removes a root certificate from the virtual network gateway.
Remove-AzVirtualNetworkGatewayVpnClientRootCertificate -VirtualNetworkGatewayName "MyGateway" -ResourceGroupName "MyResourceGroup" -Thumbprint "YOUR_CERT_THUMBPRINT"