RDRemoteApp

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Alias	Key	String	Specifies an alias for the RemoteApp program.
CollectionName	Key	String	Specifies the name of the personal virtual desktop collection or session collection. The cmdlet publishes the RemoteApp program to this collection.
DisplayName	Required	String	Specifies a name to display to users for the RemoteApp program.
FilePath	Required	String	Specifies a path for the executable file for the application. Do not include any environment variables.
CommandLineSetting	Write	String	Specifies whether the RemoteApp program accepts command-line arguments from the client at connection time. The acceptable values for this parameter are: Allow, DoNotAllow, Require	Allow, DoNotAllow, Require
Ensure	Write	String	Present if the RemoteApp should exist, Absent if it should be removed	Present, Absent
FileVirtualPath	Write	String	Specifies a path for the application executable file. This path resolves to the same location as the value of the FilePath parameter, but it can include environment variables.
FolderName	Write	String	Specifies the name of the folder that the RemoteApp program appears in on the Remote Desktop Web Access (RD Web Access) webpage and in the Start menu for subscribed RemoteApp and Desktop Connections.
IconIndex	Write	UInt32	Specifies the index within the icon file (specified by the IconPath parameter) where the RemoteApp program's icon can be found.
IconPath	Write	String	Specifies the path to a file containing the icon to display for the RemoteApp program identified by the Alias parameter.
RequiredCommandLine	Write	String	Specifies a string that contains command-line arguments that the client can use at connection time with the RemoteApp program.
ShowInWebAccess	Write	Boolean	Specifies whether to show the RemoteApp program in the RD Web Access server, and in RemoteApp and Desktop Connections that the user subscribes to.
UserGroups	Write	StringArray[]	Specifies a list of domain groups that can view the RemoteApp in RD Web Access, and in RemoteApp and Desktop Connections. To allow all users to see a RemoteApp program, provide a value of Null.

Description

This resource is used to configure the Remote Desktop Remote App.

Examples

Example 1

This example shows how to ensure deploy PowerShell as a RemoteApp.

configuration Example
{
    Import-DscResource -ModuleName 'RemoteDesktopServicesDsc'

    node localhost {

        RDRemoteApp 'Notepad' {
            Alias               = 'PowerShell without Profile'
            CollectionName      = 'BD_Python_Apps'
            CommandLineSetting  = 'Require'
            DisplayName         = 'PowerShell'
            FilePath            = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
            FolderName          = ''
            IconPath            = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
            RequiredCommandLine = '-noprofile'
            ShowInWebAccess     = $True
            UserGroups          = ''
            FileVirtualPath     = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
        }
    }
}