Set-RdsRemoteApp

参考

模块:: WindowsVirtualDesktopPowershell

设置 RemoteApp 的属性。

语法

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>]

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>]

说明

Set-RdsRemoteApp cmdlet 设置发布到指定应用组的 RemoteApp 的属性。使用此命令，可以更改 RemoteApp 显示的图标、远程桌面客户端中显示的 RemoteApp 的友好名称，以及 RemoteApp（通过命令行参数）的启动执行。

示例

示例 1：更改 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

此命令将 RemoteApp 的友好名称更改为“Contoso Web App v2”，该名称将显示在远程桌面客户端中的最终用户。

示例 2：更改 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

此命令将 Internet Explorer 的命令行参数更改为始终启动“https://webapp.contoso.com"。

参数

-AppAlias

在主机代理返回之前，由 RD 主机代理为每个启动菜单应用生成的唯一字符串。 AppAlias 由 Get-RdsStartMenuApp cmdlet 返回，可用于标识要发布的应用。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-AppGroupName

应用组的名称。

类型:	String
Position:	2
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-CommandLineSetting

指定 RemoteApp 程序是否在连接时接受来自客户端的命令行参数。此参数的可接受值为：

允许：接受命令行参数。
DoNotAllow：不接受命令行参数。
必需：仅允许在 RequiredCommandLine 参数中指定的命令行参数。

类型:	CommandLineSetting
接受的值:	Allow, DoNotAllow, Require
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Description

描述租户以帮助管理员的 512 个字符字符串。允许任何字符。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FilePath

指定应用程序的可执行文件的路径。它可能包含任何环境变量。此路径必须是主机池中所有会话主机上的有效本地路径。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FileVirtualPath

应用程序的可执行文件的文件路径。此路径必须在主机池中的所有会话主机之间保持一致，并且允许环境变量。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FolderName

注意

尚不支持此功能。

应用程序将在远程桌面客户端中分组的文件夹的名称。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FriendlyName

一个 256 个字符的字符串，用于向最终用户显示。允许任何字符。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-HostPoolName

主机池的名称。

类型:	String
Position:	1
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-IconIndex

由 IconPath 参数定义的可执行文件中的图标索引。

类型:	Int32
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IconPath

指定要为应用程序显示的应用程序或 ico 文件的路径。它可能不包含任何环境变量。此路径必须是主机池中所有会话主机上的有效本地路径。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Name

RemoteApp 的名称。

类型:	String
别名:	RemoteAppName
Position:	3
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-RequiredCommandLine

指定一个字符串，其中包含客户端在连接时可与 RemoteApp 程序一起使用的命令行参数。如果指定此参数，CommandLineSetting 参数必须具有 Require 值。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ShowInWebFeed

注意