Home > Azure > Reference > PowerShell > Azure Virtual Network Gateway VPN Client Connection Cmdlets by Scaling Plugins Cmdlets

Azure Virtual Network Gateway VPN Client Connection Cmdlets by Scaling Plugins Cmdlets

This document provides a comprehensive reference for Azure PowerShell cmdlets related to Azure Virtual Network Gateway VPN client connection management, specifically focusing on cmdlets that interact with or are managed by scaling plugins.

Overview

Azure Virtual Network Gateway enables secure, cross-premises connectivity to your Azure virtual networks. VPN client connection management is crucial for ensuring secure access for remote users and devices. This section details cmdlets that leverage scaling plugins for managing these connections, often related to performance tuning, load balancing, or dynamic resource allocation.

Cmdlets

Get-AzVirtualNetworkGatewayVpnClientConnectionConfiguration

Retrieves the VPN client connection configuration for an Azure Virtual Network Gateway.

Syntax

Get-AzVirtualNetworkGatewayVpnClientConnectionConfiguration
    -VirtualNetworkGatewayName <String>
    -ResourceGroupName <String>
    [-DefaultProfile <IAzureContextContainer>]

Parameters

-VirtualNetworkGatewayName: The name of the virtual network gateway.

-ResourceGroupName: The name of the resource group.

Example

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

Modifies the VPN client connection configuration for an Azure Virtual Network Gateway. This may involve adjustments for scaling or plugin-specific settings.

Syntax

Set-AzVirtualNetworkGatewayVpnClientConnectionConfiguration
    -VirtualNetworkGatewayName <String>
    -ResourceGroupName <String>
    [-VpnClientConnectionConfiguration <PSVirtualNetworkGatewayVpnClientConnectionConfiguration>]
    [-ScalingPluginSettings <PSVirtualNetworkGatewayScalingPluginSettings>]
    [-DefaultProfile <IAzureContextContainer>]

Parameters

-VirtualNetworkGatewayName: The name of the virtual network gateway.

-ResourceGroupName: The name of the resource group.

-VpnClientConnectionConfiguration: The new VPN client connection configuration object.

-ScalingPluginSettings: Configuration settings for scaling plugins.

Example

$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "MyResourceGroup" -Name "MyVpnGateway"
$newConfig = $gateway.VpnClientConnectionConfigurations[0]
$newConfig.EgressNatIp.Add("1.2.3.4") # Example modification

$scalingSettings = New-Object Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayScalingPluginSettings
$scalingSettings.PluginName = "MyCustomPlugin"
$scalingSettings.Settings = @{"MaxConnections" = "1000"}

Set-AzVirtualNetworkGatewayVpnClientConnectionConfiguration -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway" -VpnClientConnectionConfiguration $newConfig -ScalingPluginSettings $scalingSettings
New-AzVirtualNetworkGatewayVpnClientConnectionConfiguration

Creates a new VPN client connection configuration for an Azure Virtual Network Gateway.

Syntax

New-AzVirtualNetworkGatewayVpnClientConnectionConfiguration
    -VirtualNetworkGatewayName <String>
    -ResourceGroupName <String>
    -VpnClientAddressPool <String[]>
    [-RadiusServer <String>]
    [-RadiusSecret <SecureString>]
    [-GatewayVpnClientConfiguration <PSVirtualNetworkGatewayVpnClientConfiguration>]
    [-DefaultProfile <IAzureContextContainer>]

Parameters

-VirtualNetworkGatewayName: The name of the virtual network gateway.

-ResourceGroupName: The name of the resource group.

-VpnClientAddressPool: The IP address pool for VPN clients.

-RadiusServer: The RADIUS server address.

-RadiusSecret: The shared secret for the RADIUS server.

-GatewayVpnClientConfiguration: The gateway VPN client configuration object.

Example

New-AzVirtualNetworkGatewayVpnClientConnectionConfiguration -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway" -VpnClientAddressPool "10.0.0.0/24" -RadiusServer "192.168.1.10" -RadiusSecret "MySecretPassword"
Remove-AzVirtualNetworkGatewayVpnClientConnectionConfiguration

Removes a VPN client connection configuration from an Azure Virtual Network Gateway.

Syntax

Remove-AzVirtualNetworkGatewayVpnClientConnectionConfiguration
    -VirtualNetworkGatewayName <String>
    -ResourceGroupName <String>
    -Name <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]

Parameters

-VirtualNetworkGatewayName: The name of the virtual network gateway.

-ResourceGroupName: The name of the resource group.

-Name: The name of the VPN client connection configuration to remove.

-Force: Suppresses confirmation prompts.

Example

Remove-AzVirtualNetworkGatewayVpnClientConnectionConfiguration -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway" -Name "DefaultVpnConfig" -Force

Scaling Plugin Concepts

Scaling plugins in Azure Virtual Network Gateways are designed to enhance performance, manage load, and facilitate dynamic scaling of VPN client connection handling. When you use cmdlets that mention scaling plugins, you are typically interacting with configurations that influence how the gateway distributes connections, manages resources under load, or integrates with custom scaling solutions.

Common Scaling Plugin Settings

Related Cmdlets