Get-AzureRmVpnClientPackage

Reference

Module:: AzureRM.Network

Gets information about a VPN client package.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmVpnClientPackage
   -ResourceGroupName <String>
   -VirtualNetworkGatewayName <String>
   -ProcessorArchitecture <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmVpnClientPackage cmdlet gets information about the VPN client packages available from a virtual network gateway. Client packages contain configuration data that enable a client computer to make a VPN connection to an Azure virtual network; client computers must have the correct configuration package installed in order to make a VPN connection. Different configuration packages are available based on the client computer's version of Windows (for example, Windows 7 or Windows 10) and on the client computer's processor architecture (AMD64 or x86). You must specify the architecture type when running Get-AzureRmVpnClientPackage.

Examples

Example 1: Get information about a processor architecture VPN client package

PS C:\>Get-AzureRmVpnClientPackage -ProcessorArchitecture -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -ProcessorArchitecture "Amd64"

This command gets information about the AMD64 VPN client packages stored on the virtual network gateway named ContosoVirtualNetworkGateway. To get information about the x86 client packages, set the value of the ProcessorArchitecture parameter to x86.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProcessorArchitecture

Specifies the type of CPU architecture that the client package is designed for. Valid values are Amd64 and X86.

Type:	String
Accepted values:	Amd64, X86
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of the resource group that the virtual network gateway is assigned to. Resource groups categorize items to help simplify inventory management and general Azure administration.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VirtualNetworkGatewayName

Specifies the name of the virtual network gateway where the client package information is stored.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Parameters: ResourceGroupName (ByValue), VirtualNetworkGatewayName (ByValue)

Outputs