Set-RdsRemoteApp

Module:

Microsoft.RDInfra.RDPowershell Module

Sets the properties for a RemoteApp.

Syntax

RA1 (Default)

Set-RdsRemoteApp
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-AppGroupName] <String>
    [-Name] <String>
    [-FilePath <String>]
    [-CommandLineSetting <CommandLineSetting>]
    [-Description <String>]
    [-FileVirtualPath <String>]
    [-FolderName <String>]
    [-FriendlyName <String>]
    [-IconIndex <Int32>]
    [-IconPath <String>]
    [-RequiredCommandLine <String>]
    [-ShowInWebFeed]
    [<CommonParameters>]

RA2

Set-RdsRemoteApp
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-AppGroupName] <String>
    [-Name] <String>
    [-CommandLineSetting <CommandLineSetting>]
    [-Description <String>]
    [-FileVirtualPath <String>]
    [-FolderName <String>]
    [-FriendlyName <String>]
    [-IconIndex <Int32>]
    [-IconPath <String>]
    [-RequiredCommandLine <String>]
    [-ShowInWebFeed]
    [-AppAlias <String>]
    [<CommonParameters>]

Description

The Set-RdsRemoteApp cmdlet sets the properties for a RemoteApp published to the specified app group. With this command, you can change the icon that appears for the RemoteApp, the friendly name of the RemoteApp that appears in the Remote Desktop clients, and the start-up execution of the RemoteApp (through command line parameters).

Examples

Example 1: Change the friendly name of the RemoteApp

PS C:\> Set-RdsRemoteApp -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "webApps" -Name "internetExplorerContosoWebApp" -FriendlyName "Contoso Web App v2"

TenantGroupName     : Default Tenant Group
TenantName          : contoso
HostPoolName        : contosoHostPool
AppGroupName        : webApps
RemoteAppName       : internetExplorerContosoWebApp
FilePath            : C:\Program Files\internet explorer\iexplore.exe
AppAlias            :
CommandLineSetting  : DoNotAllow
Description         :
FriendlyName        : Contoso Web App v2
IconIndex           : 0
IconPath            : C:\Program Files\internet explorer\iexplore.exe
RequiredCommandLine :
ShowInWebFeed       : True

This command changes the friendly name of the RemoteApp to "Contoso Web App v2" which will appear to end-users in the Remote Desktop clients.

Example 2: Change the command line properties of the RemoteApp

PS C:\> Set-RdsRemoteApp -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "webApps" -Name "internetExplorerContosoWebApp" -CommandLineSetting Require -RequiredCommandLine "https://webapp.contoso.com"

TenantGroupName     : Default Tenant Group
TenantName          : contoso
HostPoolName        : contosoHostPool
AppGroupName        : webApps
RemoteAppName       : internetExplorerContosoWebApp
FilePath            : C:\Program Files\internet explorer\iexplore.exe
AppAlias            :
CommandLineSetting  : Require
Description         :
FriendlyName        : Contoso Web App v2
IconIndex           : 0
IconPath            : C:\Program Files\internet explorer\iexplore.exe
RequiredCommandLine : https://webapp.contoso.com
ShowInWebFeed       : True

This command changes the command-line arguments of Internet Explorer to always launch "https://webapp.contoso.com".

Parameters

-AppAlias

A unique string generated by the RD host agent for each start menu apps before it is returned by the host agent. The AppAlias is returned by the Get-RdsStartMenuApp cmdlet and can be used to identify an app for publishing.

Parameter properties

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

Parameter sets

RA2

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

-AppGroupName

The name of the app group.

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:	True
Value from remaining arguments:	False

-CommandLineSetting

Specifies whether the RemoteApp program accepts command-line arguments from the client at connection time. The acceptable values for this parameter are:

• Allow: Accepts command-line arguments.
• DoNotAllow: Does not accept command-line arguments.
• Require: Allows only command-line arguments specified in the RequiredCommandLine parameter.

Parameter properties

Type:	CommandLineSetting
Default value:	None
Accepted values:	Allow, DoNotAllow, Require
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

-Description

A 512 character string that describes the Tenant to help administrators. Any character is allowed.

Parameter properties

Type:	String
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

-FilePath

Specifies a path for the executable file for the application. It may include any environment variables. This path must be a valid local path on all session hosts in the host pool.

Parameter properties

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

Parameter sets

RA1

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

-FileVirtualPath

The file path to the executable file for the application. This path is must be consistent across all session hosts in the host pool and does allow environment variables.

Parameter properties

Type:	String
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

-FolderName

Note

This feature is not yet supported.

The name of the folder where the application will be grouped in the Remote Desktop clients.

Parameter properties

Type:	String
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

-FriendlyName

A 256 character string that is intended for display to end users. Any character is allowed.

Parameter properties

Type:	String
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

-HostPoolName

The name of the host pool.

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:	True
Value from remaining arguments:	False

-IconIndex

The index of the icon from the executable file, as defined by the IconPath parameter.

Parameter properties

Type:	Int32
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

-IconPath

Specifies a path to an application or ico file to display for the application. It may not include any environment variables. This path must be a valid local path on all session hosts in the host pool.

Parameter properties

Type:	String
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

-Name

The name of the RemoteApp.

Parameter properties

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

Parameter sets

(All)

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

-RequiredCommandLine

Specifies a string that contains command-line arguments that the client can use at connection time with the RemoteApp program. If you specify this parameter, the CommandLineSetting parameter must have a value of Require.

Parameter properties

Type:	String
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

-ShowInWebFeed

Note

This feature is not yet supported.

Specifies whether to show the RemoteApp program in the web feed. By default, all RemoteApps are shown. Note: This allows the admin to turn off an application temporarily and then turn it back on without deleting and re-creating the custom app information.

Parameter properties

Type:	SwitchParameter
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

-TenantName

The name of the tenant.

Parameter properties

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

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
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.

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtRemoteApp