Get-RdsRemoteApp

Reference

Module:: WindowsVirtualDesktopPowershell

Lists the RemoteApp programs published to an app group.

Syntax

Get-RdsRemoteApp
   [-TenantName] <String>
   [-HostPoolName] <String>
   [-AppGroupName] <String>
   [-Name <String>]
   [<CommonParameters>]

Description

The Get-RdsRemoteApp cmdlet lists the RemoteApp programs published to the specified app group. If you specify the name of a RemoteApp, this cmdlet returns the properties of the specified RemoteApp.

Examples

Example 1: List all RemoteApps that have been published to an app group

PS C:\> Get-RdsRemoteApp -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "officeApps"

TenantGroupName     : Default Tenant Group
TenantName          : contoso
HostPoolName        : contosoHostPool
AppGroupName        : officeApps
RemoteAppName       : Excel
FilePath            : C:\Program Files\Microsoft Office\root\Office16\EXCEL.EXE
AppAlias            :
CommandLineSetting  : DoNotAllow
Description         :
FriendlyName        : Excel
IconIndex           : 0
IconPath            : C:\Program Files\Microsoft
                      Office\Root\VFS\Windows\Installer\{90160000-000F-0000-1000-0000000FF1CE}\xlicons.exe
RequiredCommandLine :
ShowInWebFeed       : True

TenantGroupName     : Default Tenant Group
TenantName          : contoso
HostPoolName        : contosoHostPool
AppGroupName        : officeApps
RemoteAppName       : PowerPoint
FilePath            : C:\Program Files\Microsoft Office\root\Office16\POWERPNT.EXE
AppAlias            :
CommandLineSetting  : DoNotAllow
Description         :
FriendlyName        : PowerPoint
IconIndex           : 0
IconPath            : C:\Program Files\Microsoft
                      Office\Root\VFS\Windows\Installer\{90160000-000F-0000-1000-0000000FF1CE}\pptico.exe
RequiredCommandLine :
ShowInWebFeed       : True

This command lists all RemoteApps that have been published to the specified RemoteApp app group.

Example 2: List the properties of a specific RemoteApp

PS C:\> Get-RdsRemoteApp -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "officeApps" -Name "Excel"

TenantGroupName     : Default Tenant Group
TenantName          : contoso
HostPoolName        : contosoHostPool
AppGroupName        : officeApps
RemoteAppName       : Excel
FilePath            : C:\Program Files\Microsoft Office\root\Office16\EXCEL.EXE
AppAlias            :
CommandLineSetting  : DoNotAllow
Description         :
FriendlyName        : Excel
IconIndex           : 0
IconPath            : C:\Program Files\Microsoft
                      Office\Root\VFS\Windows\Installer\{90160000-000F-0000-1000-0000000FF1CE}\xlicons.exe
RequiredCommandLine :
ShowInWebFeed       : True

This command lists the properties of the specified RemoteApp in the app group. The RemoteApp and its properties are displayed only if the RemoteApp has been published to the RemoteApp app group and the current user is properly authorized.

Parameters

-AppGroupName

The name of the app group.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-HostPoolName

The name the of host pool.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the RemoteApp.

Type:	String
Aliases:	RemoteAppName
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-TenantName

The name of the tenant.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtRemoteApp