Set-RASPubVDIApp
NAME
Set-RASPubVDIApp
SYNOPSIS
Modifies properties of a published VDI application.
SYNTAX
Set-RASPubVDIApp [-Id] <uint> [-ConnectTo {AnyGuest}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-Enabled <bool>] [-EnabledMode {Disabled | Enabled | Maintenance}] [-ExcludePrelaunch <bool>] [-Icon <string>] [-IconIndex <uint>] [-InheritMaintenance <bool>] [-InheritShortcutDefaultSettings <bool>] [-MaintenanceMessage_de_DE <string>] [-MaintenanceMessage_en_US <string>] [-MaintenanceMessage_es_ES <string>] [-MaintenanceMessage_fr_FR <string>] [-MaintenanceMessage_it_IT <string>] [-MaintenanceMessage_ja_JP <string>] [-MaintenanceMessage_ko_KR <string>] [-MaintenanceMessage_nl_NL <string>] [-MaintenanceMessage_pt_BR <string>] [-MaintenanceMessage_zh_CN <string>] [-MaintenanceMessage_zh_TW <string>] [-Name <string>] [-Package <string>] [-PackagedApp <string>] [-Parameters <string>] [-Persistent <bool>] [-PreferredRoutingEnabled <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartIn <string>] [-StartOnLogon <bool>] [-StartPath <string>] [-Target <string>] [-VDIHostPool <VDIHostPool>] [-VDIHostPoolId <uint>] [-VDITemplate <Template>] [-WinType {Normal | Maximized | Minimized}] [<CommonParameters>]
Set-RASPubVDIApp [-InputObject] <PubItem> [-ConnectTo {AnyGuest}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-Enabled <bool>] [-EnabledMode {Disabled | Enabled | Maintenance}] [-ExcludePrelaunch <bool>] [-Icon <string>] [-IconIndex <uint>] [-InheritMaintenance <bool>] [-InheritShortcutDefaultSettings <bool>] [-MaintenanceMessage_de_DE <string>] [-MaintenanceMessage_en_US <string>] [-MaintenanceMessage_es_ES <string>] [-MaintenanceMessage_fr_FR <string>] [-MaintenanceMessage_it_IT <string>] [-MaintenanceMessage_ja_JP <string>] [-MaintenanceMessage_ko_KR <string>] [-MaintenanceMessage_nl_NL <string>] [-MaintenanceMessage_pt_BR <string>] [-MaintenanceMessage_zh_CN <string>] [-MaintenanceMessage_zh_TW <string>] [-Name <string>] [-Package <string>] [-PackagedApp <string>] [-Parameters <string>] [-Persistent <bool>] [-PreferredRoutingEnabled <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartIn <string>] [-StartOnLogon <bool>] [-StartPath <string>] [-Target <string>] [-VDIHostPool <VDIHostPool>] [-VDIHostPoolId <uint>] [-VDITemplate <Template>] [-WinType {Normal | Maximized | Minimized}] [<CommonParameters>]
DESCRIPTION
Modifies properties of a published VDI application.
Use only the parameters (application properties) that you want to modify.
To set filtering options, use the Pub Filtering cmdlets (e.g. Set-RASPubItemClientFilter).
PARAMETERS
-Persistent <bool> Specifies whether the connection is persistent or not.
-ConnectTo <VDIMatchingMode> Specifies the 'Matching Mode' option to connect with.
Acceptable values: AnyGuest.
Possible values: AnyGuest
-VDIHostPoolId <uint> Specifies the VDI Host Pool from which to publish an application.
-VDIHostPool <VDIHostPool> Specifies the VDI Host Pool from which to publish an application.
-VDITemplate <Template> Specifies the RAS template from which to publish an application.
-Target <string> File name and path of a published application executable.
-StartIn <string> Folder name in which to start a published application.
-Parameters <string> Optional parameters to pass to the published application executable.
-Package <string> The MSIX Package.
-PackagedApp <string> The application within the MSIX package.
-WinType <WindowType> Published application window type. Acceptable values: Normal, Maximized, Minimized.
Possible values: Normal, Maximized, Minimized
-ReplicateShortcutSettings <bool> Replicate shortcut settings to all sites.
-CreateShortcutOnDesktop <bool> Create a shortcut on a client's desktop.
-CreateShortcutInStartFolder <bool> Create a shortcut in the client's Start folder.
-CreateShortcutInStartUpFolder <bool> Create a shortcut in the client's Auto Start folder.
-StartPath <string> Specifies the path in the Start folder where the shortcut will be created.
-InheritShortcutDefaultSettings <bool> Inherit default shortcut settings.
-StartOnLogon <bool> Start a resource automatically when a user logs on.
-ExcludePrelaunch <bool> Exclude application from prelaunch.
-Name <string> A new name to assign to the published resource.
-Icon <string> Published resource icon file name. Can be an executable (.exe), a .dll or a .ico file.
-IconIndex <uint> Icon index
Specifies the index of the icon that will be loaded from the binary specified in the Icon property
-ReplicateMaintenance <bool> Replicate Maintenance
-InheritMaintenance <bool> Inherit Maintenance
-Enabled <bool> Enable or disable a published resource.
-EnabledMode <PubResourceEnabledMode> Changes the availability status of the published resource.
Possible values: Disabled, Enabled, Maintenance
-MaintenanceMessage_en_US <string> Maintenance message for the published resource in English.
-MaintenanceMessage_ja_JP <string> Maintenance message for the published resource in Japanese.
-MaintenanceMessage_fr_FR <string> Maintenance message for the published resource in French.
-MaintenanceMessage_es_ES <string> Maintenance message for the published resource in Spanish.
-MaintenanceMessage_it_IT <string> Maintenance message for the published resource in Italian.
-MaintenanceMessage_pt_BR <string> Maintenance message for the published resource in Portuguese.
-MaintenanceMessage_nl_NL <string> Maintenance message for the published resource in Dutch.
-MaintenanceMessage_de_DE <string> Maintenance message for the published resource in German.
-MaintenanceMessage_zh_TW <string> Maintenance message for the published resource in Chinese (Traditional).
-MaintenanceMessage_zh_CN <string> Maintenance message for the published resource in Chinese (Simplified).
-MaintenanceMessage_ko_KR <string> Maintenance message for the published resource in Korean.
-Description <string> Published resource description.
-PublishToSite <Site[]> An array of sites to which to publish a resource.
-PublishToSiteIds <uint[]> An array of sites to which to publish a resource.
-PreferredRoutingEnabled <bool> Enable or disable Preferred Routing.
-Id <uint> Published resource ID.
-InputObject <PubItem> An object specifying the published resource.
To obtain the object, use the Get-PubItem cmdlet.
-SiteId <uint> Site ID.
<CommonParameters>
INPUTS
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Set-RASPubVDIApp -Id 1 -Enabled $false
Disables a published application specified by ID. ---------- EXAMPLE 2 ----------
Set-RASPubVDIApp $PubVDIApp -Enabled $false
Disables a published application specified by the $PubVDIApp object. ---------- EXAMPLE 3 ----------
Get-RASPubVDIApp -Id 1 | Set-RASPubVDIApp -Enabled $false
Disables a published application specified by an object obtained from the pipeline output. ---------- EXAMPLE 4 ----------
Set-RASPubVDIApp -Id 1 -Package "AppPackage2" -PackagedApp "TestApp2"
Modifies the package and application package details of the published application specified by ID.
RELATED LINKS
Last updated