Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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>]
 [-EnabledMode {Disabled | Enabled | Maintenance}] [-EnableStaticAssignmentToHost <bool>]
 [-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>]
 [-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.

EXAMPLES

Example 1

Disables a published application specified by ID.

Example 2

Disables a published application specified by the $PubVDIApp object.

Example 3

Disables a published application specified by an object obtained from the pipeline output.

Example 4

Modifies the package and application package details of the published application specified by ID.

PARAMETERS

-EnableStaticAssignmentToHost

Specifies whether the static assignment to host is enabled or not.

-ConnectTo

Specifies the 'Matching Mode' option to connect with.

Acceptable values: AnyGuest.

Possible values: AnyGuest

Type reference: VDIMatchingMode

-VDIHostPoolId

Specifies the VDI Host Pool from which to publish an application.

-VDIHostPool

Specifies the VDI Host Pool from which to publish an application.

Type reference: VDIHostPool

-VDITemplate

Specifies the RAS template from which to publish an application.

Type reference: Template

-Target

File name and path of a published application executable.

-StartIn

Folder name in which to start a published application.

-Parameters

Optional parameters to pass to the published application executable.

-Package

The MSIX Package.

-PackagedApp

The application within the MSIX package.

-WinType

Published application window type. Acceptable values: Normal, Maximized, Minimized.

Possible values: Normal, Maximized, Minimized

Type reference: WindowType

-ReplicateShortcutSettings

Replicate shortcut settings to all sites.

-CreateShortcutOnDesktop

Create a shortcut on a client's desktop.

-CreateShortcutInStartFolder

Create a shortcut in the client's Start folder.

-CreateShortcutInStartUpFolder

Create a shortcut in the client's Auto Start folder.

-StartPath

Specifies the path in the Start folder where the shortcut will be created.

-InheritShortcutDefaultSettings

Inherit default shortcut settings.

-StartOnLogon

Start a resource automatically when a user logs on.

-ExcludePrelaunch

Exclude application from prelaunch.

-PreferredRoutingEnabled

Enable or disable Preferred Routing.

-Name

A new name to assign to the published resource.

-Icon

Published resource icon file name. Can be an executable (.exe), a .dll or a .ico file.

-IconIndex

Icon index

Specifies the index of the icon that will be loaded from the binary specified in the Icon property

-ReplicateMaintenance

Replicate Maintenance

-InheritMaintenance

Inherit Maintenance

-EnabledMode

Changes the availability status of the published resource.

Possible values: Disabled, Enabled, Maintenance

Type reference: PubResourceEnabledMode

-MaintenanceMessage_en_US

Maintenance message for the published resource in English.

-MaintenanceMessage_ja_JP

Maintenance message for the published resource in Japanese.

-MaintenanceMessage_fr_FR

Maintenance message for the published resource in French.

-MaintenanceMessage_es_ES

Maintenance message for the published resource in Spanish.

-MaintenanceMessage_it_IT

Maintenance message for the published resource in Italian.

-MaintenanceMessage_pt_BR

Maintenance message for the published resource in Portuguese.

-MaintenanceMessage_nl_NL

Maintenance message for the published resource in Dutch.

-MaintenanceMessage_de_DE

Maintenance message for the published resource in German.

-MaintenanceMessage_zh_TW

Maintenance message for the published resource in Chinese (Traditional).

-MaintenanceMessage_zh_CN

Maintenance message for the published resource in Chinese (Simplified).

-MaintenanceMessage_ko_KR

Maintenance message for the published resource in Korean.

-Description

Published resource description.

-PublishToSite

An array of sites to which to publish a resource.

Type reference: Site[]

-PublishToSiteIds

An array of sites to which to publish a resource.

-Id

Published resource ID.

-InputObject

An object specifying the published resource.

To obtain the object, use the Get-PubItem cmdlet.

Type reference: PubItem

-SiteId

Site ID.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

PubItem

OUTPUTS

None

Last updated