Azure PowerShell Reference

Azure Virtual Network Gateway VPN Client Connection Cmdlets

Azure Virtual Network Gateway VPN Client Connection Cmdlets

This section provides a comprehensive reference for PowerShell cmdlets used to manage VPN client connections for Azure Virtual Network Gateways. These cmdlets enable you to configure, deploy, and manage VPN client configurations, allowing users to securely connect to your Azure Virtual Network.

Cmdlets by Architecture

Resource Manager Deployment Model (AzureRM) - Older

While AzureRM cmdlets are largely superseded by Az modules, understanding them can be helpful for legacy scripts.

  • Get-AzureVpnClientConnectionConfiguration
    Retrieves the VPN client connection configuration for a virtual network gateway.
  • Set-AzureVpnClientConnectionConfiguration
    Configures the VPN client connection settings for a virtual network gateway.
  • New-AzureVpnClientConnectionConfiguration
    Creates a new VPN client connection configuration profile for a virtual network gateway.
  • Remove-AzureVpnClientConnectionConfiguration
    Removes a VPN client connection configuration profile from a virtual network gateway.

Azure PowerShell Module (Az) - Recommended

The Az module is the current and recommended module for managing Azure resources. These cmdlets offer enhanced features and better integration.

  • Get-AzVirtualNetworkGatewayVpnClientConnectionConfiguration
    Gets a VPN client connection configuration for a virtual network gateway.
    Get-AzVirtualNetworkGatewayVpnClientConnectionConfiguration -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway"
  • New-AzVirtualNetworkGatewayVpnClientConnectionConfiguration
    Creates a VPN client connection configuration for a virtual network gateway.
    New-AzVirtualNetworkGatewayVpnClientConnectionConfiguration -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway" -Name "VpnClientConfig" -Location "EastUS"
  • Set-AzVirtualNetworkGatewayVpnClientConnectionConfiguration
    Updates a VPN client connection configuration for a virtual network gateway.
    Set-AzVirtualNetworkGatewayVpnClientConnectionConfiguration -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway" -Name "VpnClientConfig" -VpnClientRootCertificateThumbprint "THUMBPRINT_OF_ROOT_CERTIFICATE"
  • Remove-AzVirtualNetworkGatewayVpnClientConnectionConfiguration
    Deletes a VPN client connection configuration for a virtual network gateway.
    Remove-AzVirtualNetworkGatewayVpnClientConnectionConfiguration -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway" -Name "VpnClientConfig"
  • Get-AzVirtualNetworkGatewayVpnClientConfigurationPackage
    Retrieves the VPN client configuration package for a virtual network gateway.
    Get-AzVirtualNetworkGatewayVpnClientConfigurationPackage -ResourceGroupName "MyResourceGroup" -VirtualNetworkGatewayName "MyVpnGateway" -VpnType "P2S" -ProcessorArchitecture "Amd64" -IpsecConfiguration "Default"

Related Concepts

Common Parameters

Most Azure cmdlets support common parameters for managing resources across different scopes: