DSCResources/MSFT_xRDRemoteApp/en-US/about_xRDRemoteApp.help.txt
|
.NAME
xRDRemoteApp .DESCRIPTION This resource is used to configure the Remote Desktop Remote App. .PARAMETER Alias Key - String Specifies an alias for the RemoteApp program. .PARAMETER CollectionName Key - String Specifies the name of the personal virtual desktop collection or session collection. The cmdlet publishes the RemoteApp program to this collection. .PARAMETER DisplayName Required - String Specifies a name to display to users for the RemoteApp program. .PARAMETER FilePath Required - String Specifies a path for the executable file for the application. Do not include any environment variables. .PARAMETER Ensure Write - String Allowed values: Present, Absent Present if the RemoteApp should exist, Absent if it should be removed .PARAMETER 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. .PARAMETER 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. .PARAMETER CommandLineSetting Write - String Allowed values: Allow, DoNotAllow, Require 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 .PARAMETER RequiredCommandLine Write - String Specifies a string that contains command-line arguments that the client can use at connection time with the RemoteApp program. .PARAMETER IconIndex Write - UInt32 Specifies the index within the icon file (specified by the IconPath parameter) where the RemoteApp program's icon can be found. .PARAMETER IconPath Write - String Specifies the path to a file containing the icon to display for the RemoteApp program identified by the Alias parameter. .PARAMETER 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. .PARAMETER 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. .EXAMPLE 1 This example shows how to ensure deploy PowerShell as a RemoteApp. configuration Example { Import-DscResource -ModuleName 'xRemoteDesktopSessionHost' node localhost { xRDRemoteApp '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' } } } |