Azure Virtual Network Gateway VPN Client Connection Cmdlets by Scenario

Overview

Azure Virtual Network Gateway enables secure hybrid connectivity between your on-premises networks and your Azure virtual networks. VPN client connection cmdlets allow you to configure and manage the client-side aspects of these VPN connections, enabling remote users to connect securely to your Azure resources. This particular set of cmdlets focuses on scenarios that leverage plugins for advanced configuration and functionality.

Key Cmdlets for Plugin Scenarios

• Get-AzVpnClientRootCertificate

  Retrieves the root certificates configured for VPN client authentication.

  Get-AzVpnClientRootCertificate -VpnGateway [-DefaultProfile ]
• Add-AzVpnClientRootCertificate

  Adds a root certificate to the VPN client configuration for authentication.

  Add-AzVpnClientRootCertificate -VpnGateway -Name -PublicCertData [-DefaultProfile ]
• Remove-AzVpnClientRootCertificate

  Removes a root certificate from the VPN client configuration.

  Remove-AzVpnClientRootCertificate -VpnGateway -Name [-DefaultProfile ]
• Set-AzVpnClientConfiguration

  Configures the VPN client settings for a virtual network gateway, including plugin-specific parameters.

  Set-AzVpnClientConfiguration -VpnGateway -VpnClientRootCertificates [-DefaultProfile ]
• Get-AzVpnClientConfiguration

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

  Get-AzVpnClientConfiguration -VpnGateway [-DefaultProfile ]
• Invoke-AzVpnClient

  Initiates a VPN client connection to the virtual network gateway.

  Invoke-AzVpnClient -ResourceGroupName -Name [-WanVpnAgent ] [-DefaultProfile ]
• Remove-AzVpnClientConfiguration

  Removes the VPN client configuration from a virtual network gateway.

  Remove-AzVpnClientConfiguration -VpnGateway [-DefaultProfile ]

Usage Examples

Example 1: Adding a root certificate

# Define variables
$resourceGroupName = "MyResourceGroup"
$vpnGatewayName = "myVpnGateway"
$certificateName = "MyRootCert"
$certificatePath = "C:\Certs\MyRootCert.cer"

# Get the VPN gateway
$vpnGateway = Get-AzVirtualNetworkGateway -ResourceGroupName $resourceGroupName -Name $vpnGatewayName

# Read the certificate data
$publicCertData = [System.Convert]::ToBase64String((Get-Content -Path $certificatePath -Encoding Byte -ReadCount 0))

# Add the root certificate
Add-AzVpnClientRootCertificate -VpnGateway $vpnGateway -Name $certificateName -PublicCertData $publicCertData
                        

Example 2: Initiating a VPN client connection

# Define variables
$resourceGroupName = "MyResourceGroup"
$vpnGatewayName = "myVpnGateway"

# Invoke the VPN client connection
Invoke-AzVpnClient -ResourceGroupName $resourceGroupName -Name $vpnGatewayName
                        

Parameters Explained