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.

Get-AzVpnClientConnectionConfiguration

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

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

Parameters:: -VirtualNetworkGatewayName <String>
Specifies the name of the virtual network gateway.; -ResourceGroupName <String>
Specifies the name of the resource group that contains the virtual network gateway.; -DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with Azure.

Example:

Get-AzVpnClientConnectionConfiguration -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup"

Set-AzVpnClientConnectionConfiguration

Configures settings for VPN client connections to a virtual network gateway.

Set-AzVpnClientConnectionConfiguration -VirtualNetworkGatewayName <String> -ResourceGroupName <String> [-VpnClientIPPool <String[]>] [-VpnClientProtocols <VpnClientProtocol[]>] [-Audience <String>] [-Issuer <String>] [-AadTenantId <String>] [-AadAudience <String>] [-UseRootCertificate <Boolean>] [-DefaultProfile <IAzureContextContainer>] []

Parameters:: -VirtualNetworkGatewayName <String>
Specifies the name of the virtual network gateway.; -ResourceGroupName <String>
Specifies the name of the resource group that contains the virtual network gateway.; -VpnClientIPPool <String[]>
Specifies an array of IP address pools to assign to VPN clients.; -VpnClientProtocols <VpnClientProtocol[]>
Specifies the VPN client protocols to enable (e.g., IKEv2, VpnClientProtocol.SSTP).; -Audience <String>
The audience URI for the token.; -Issuer <String>
The issuer URI for the token.; -AadTenantId <String>
The Azure AD tenant ID for authentication.; -AadAudience <String>
The Azure AD audience for the token.; -UseRootCertificate <Boolean>
Specifies whether to use the root certificate for authentication.

Example:

Set-AzVpnClientConnectionConfiguration -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup" -VpnClientIPPool "10.1.0.0/24" -VpnClientProtocols IKEv2,SSTP

Get-AzVpnClientIPConfiguration

Retrieves the IP configuration of a virtual network gateway for VPN client connections.

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

Parameters:: -VirtualNetworkGatewayName <String>
Specifies the name of the virtual network gateway.; -ResourceGroupName <String>
Specifies the name of the resource group that contains the virtual network gateway.

Example:

Get-AzVpnClientIPConfiguration -VirtualNetworkGatewayName "MyVpnGateway" -ResourceGroupName "MyResourceGroup"