Get-RdsRemoteApp
Lists the RemoteApp programs published to an app group.
Syntax
Default (Default)
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.
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 |
-HostPoolName
The name the of 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 |
-Name
The name of the RemoteApp.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RemoteAppName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| 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.