Set-RdsRemoteApp

模組:: Microsoft.RDInfra.RDPowershell Module

設置 RemoteApp 的屬性。

語法

RA1 (預設值)

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

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
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

RA2

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-AppGroupName

應用組的名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	2
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-CommandLineSetting

指定 RemoteApp 程式是否在連接時接受來自用戶端的命令行參數。此參數可接受的值為：

允許：接受命令行參數。
DoNotAllow：不接受命令行參數。
Require：僅允許在 RequiredCommandLine 參數中指定的命令行參數。

參數屬性

類型:	CommandLineSetting
預設值:	None
接受的值:	Allow, DoNotAllow, Require
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Description

一個 512 個字元的字串，用於描述 Tenant，以説明管理員。允許使用任何字元。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-FilePath

指定應用程式的可執行檔案路徑。它可以包含任何環境變數。此路徑必須是主機池中所有會話主機上的有效本地路徑。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

RA1

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-FileVirtualPath

應用程式的可執行檔的檔案路徑。此路徑必須在主機池中的所有會話主機之間保持一致，並且允許使用環境變數。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-FolderName

備註

尚不支援此功能。

應用程式將在遠端桌面用戶端中分組的資料夾的名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-FriendlyName

一個 256 個字元的字串，用於向最終用戶顯示。允許使用任何字元。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-HostPoolName

主機池的名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	1
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-IconIndex

可執行文件中圖標的索引，由IconPath參數定義。

參數屬性

類型:	Int32
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-IconPath

指定要為應用程式顯示的應用程式或ico檔的路徑。它可能不包含任何環境變數。此路徑必須是主機池中所有會話主機上的有效本地路徑。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Name

RemoteApp 的名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	遠端應用名稱

參數集

(All)

Position:	3
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-RequiredCommandLine

指定一個字串，其中包含用戶端在與 RemoteApp 程式連接時可以使用的命令行參數。如果指定此參數，則 CommandLineSetting 參數的值必須為 Require。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ShowInWebFeed

備註

尚不支援此功能。

指定是否在 Web 源中顯示 RemoteApp 程式。默認情況下，將顯示所有 RemoteApps。注意：這允許管理員暫時關閉應用程式，然後重新打開，而無需刪除和重新創建自定義應用程式資訊。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-TenantName

租用戶的名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	0
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。如需詳細資訊，請參閱 about_CommonParameters。

共用方式為

Set-RdsRemoteApp

語法

RA1 (預設值)

RA2

Description

範例

範例 1：更改 RemoteApp 的友好名稱

範例 2：更改 RemoteApp 的命令行屬性

參數

-AppAlias

參數屬性

參數集

-AppGroupName

參數屬性

參數集

-CommandLineSetting

參數屬性

參數集

-Description

參數屬性

參數集

-FilePath

參數屬性

參數集

-FileVirtualPath

參數屬性

參數集

-FolderName

參數屬性

參數集

-FriendlyName

參數屬性

參數集

-HostPoolName

參數屬性

參數集

-IconIndex

參數屬性

參數集

-IconPath

參數屬性

參數集

-Name

參數屬性

參數集

-RequiredCommandLine

參數屬性

參數集

-ShowInWebFeed

參數屬性

參數集

-TenantName

參數屬性

參數集

CommonParameters

輸入

System.String

輸出

Microsoft.RDInfra.RDManagementData.RdMgmtRemoteApp