Set-RdsRemoteApp

设置 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 返回,可用于标识要发布的应用。

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

-AppGroupName

应用组的名称。

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

-CommandLineSetting

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

  • 允许:接受命令行参数。
  • DoNotAllow:不接受命令行参数。
  • 需要:仅允许在 RequiredCommandLine 参数中指定的命令行参数。
Type:CommandLineSetting
Accepted values:Allow, DoNotAllow, Require
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

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

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

-FilePath

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

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

-FileVirtualPath

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

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

-FolderName

注意

尚不支持此功能。

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

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

-FriendlyName

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

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

-HostPoolName

主机池的名称。

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

-IconIndex

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IconPath

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

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

-Name

RemoteApp 的名称。

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

-RequiredCommandLine

指定一个字符串,该字符串包含客户端可以在与 RemoteApp 程序连接时使用的命令行参数。 如果指定此参数,CommandLineSetting 参数的值必须为 Require。

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

-ShowInWebFeed

注意

尚不支持此功能。

指定是否在 Web 源中显示 RemoteApp 程序。 默认情况下,将显示所有 RemoteApp。 注意:这允许管理员暂时关闭应用程序,然后重新打开它,而无需删除并重新创建自定义应用信息。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TenantName

租户的名称。

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

输入

System.String

输出

Microsoft.RDInfra.RDManagementData.RdMgmtRemoteApp