Edit

Share via


Get-AzureRemoteAppVpnDeviceConfigScript

Retrieves the configuration script for an Azure RemoteApp VPN device.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Default (Default)

Get-AzureRemoteAppVpnDeviceConfigScript
    [-VNetName] <String>
    [-Vendor] <String>
    [-Platform] <String>
    [-OSFamily] <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Get-AzureRemoteAppVpnDeviceConfigScript cmdlet retrieves the configuration script for an Azure RemoteApp virtual private network (VPN) device.

Examples

Example 1: Get a configuration script for a VPN device

PS C:\> Get-AzureRemoteAppVpnDeviceConfigScript -VNetName "ContosoVNet" -Vendor "Microsoft Corporation" -OSFamily "Windows Server 2012 R2"

This command returns the script or configuration file used to configure the VPN device for the virtual network named ContosoVNet. This script or configuration file should be run or loaded onto the VPN device in the typical manner for that device. Consult the VPN device vendor for the unique requirements for each device.

Parameters

-OSFamily

Specifies the operating system (OS) family that runs on the device platform.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Platform

Specifies the device platform.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:AzureSMProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Vendor

Specifies the vendor of the VPN device.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VNetName

Specifies the name of an Azure RemoteApp virtual network.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.