Skip to content

Latest commit

 

History

History
122 lines (90 loc) · 3.88 KB

Get-AzureRmVpnClientPackage.md

File metadata and controls

122 lines (90 loc) · 3.88 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.Commands.Network.dll-Help.xml
AzureRM.Network
2B4A3E2A-1868-492F-9F77-932319D2CE6D
2.0.0

Get-AzureRmVpnClientPackage

SYNOPSIS

Gets information about a VPN client package.

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: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:
Accepted values: Amd64, X86

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VirtualNetworkGatewayName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

Parameters: ResourceGroupName (ByValue), VirtualNetworkGatewayName (ByValue)

OUTPUTS

System.String

NOTES

RELATED LINKS

Resize-AzureRmVirtualNetworkGateway

Set-AzureRmVirtualNetworkGatewayVpnClientConfig