Set-RASPubAVDDesktop
NAME
Set-RASPubAVDDesktop
SYNOPSIS
Modifies properties of a published desktop.
SYNTAX
Set-RASPubAVDDesktop [-Id] <uint> -AVDHostPoolID <uint> [-AllowMultiMonitor {Enabled | Disabled | UseClientSettings}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DesktopSize {UseAvailableArea | FullScreen | W640xH480 | W800xH600 | W854xH480 | W1024xH576 | W1024xH768 | W1152xH864 | W1280xH720 | W1280xH768 | W1280xH800 | W1280xH960 | W1280xH1024 | W1360xH768 | W1366xH768 | W1400xH1050 | W1440xH900 | W1600xH900 | W1600xH1024 | W1600xH1200 | W1680xH1050 | W1920xH1080 | W1920xH1200 | W1920xH1440 | W2048xH1152 | Custom}] [-Enabled <bool>] [-EnabledMode {Disabled | Enabled | Maintenance}] [-ExcludePrelaunch <bool>] [-Height <uint>] [-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>] [-PreferredRoutingEnabled <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartOnLogon <bool>] [-StartPath <string>] [-Width <uint>] [<CommonParameters>] Set-RASPubAVDDesktop [-InputObject] <PubItem> -AVDHostPoolID <uint> [-AllowMultiMonitor {Enabled | Disabled | UseClientSettings}] [-CreateShortcutInStartFolder <bool>] [-CreateShortcutInStartUpFolder <bool>] [-CreateShortcutOnDesktop <bool>] [-Description <string>] [-DesktopSize {UseAvailableArea | FullScreen | W640xH480 | W800xH600 | W854xH480 | W1024xH576 | W1024xH768 | W1152xH864 | W1280xH720 | W1280xH768 | W1280xH800 | W1280xH960 | W1280xH1024 | W1360xH768 | W1366xH768 | W1400xH1050 | W1440xH900 | W1600xH900 | W1600xH1024 | W1600xH1200 | W1680xH1050 | W1920xH1080 | W1920xH1200 | W1920xH1440 | W2048xH1152 | Custom}] [-Enabled <bool>] [-EnabledMode {Disabled | Enabled | Maintenance}] [-ExcludePrelaunch <bool>] [-Height <uint>] [-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>] [-PreferredRoutingEnabled <bool>] [-PublishToSite <Site[]>] [-PublishToSiteIds <uint[]>] [-ReplicateMaintenance <bool>] [-ReplicateShortcutSettings <bool>] [-SiteId <uint>] [-StartOnLogon <bool>] [-StartPath <string>] [-Width <uint>] [<CommonParameters>]
DESCRIPTION
Modifies properties of a published desktop. You can include only those parameters (desktop properties) that you want to modify. To set filtering options, use Pub Filtering cmdlets (e.g. Set-RASPubItemClientFilter). This is an Experimental feature which is subject to slight changes.
PARAMETERS
-AVDHostPoolID <uint> The AVD Host Pool ID.
-Width <uint> Desktop width.
-Height <uint> Desktop height.
-DesktopSize <DesktopSize> Desktop Size. Possible values are: 0 (Use available area), 1 (Full screen), Custom = 25. Specific sizes are specified by numbers in the 2 to 24 range: 2 (640x480), 3 (800x600), ... 24 (2048 x 1152) Listed in that order: 640x480, 800x600, 854x480, 1024x576, 1024x768, 1152x864, 1280x720, 1280x768, 1280x800, 1280x960, 1280x1024, 1360x768, 1366x768, 1400x1050, 1440x900, 1600x900, 1600x1024, 1600x1200, 1680x1050, 1920x1440, 1920x1080, 1920x1200, 2048x1152 Possible values: UseAvailableArea, FullScreen, W640xH480, W800xH600, W854xH480, W1024xH576, W1024xH768, W1152xH864, W1280xH720, W1280xH768, W1280xH800, W1280xH960, W1280xH1024, W1360xH768, W1366xH768, W1400xH1050, W1440xH900, W1600xH900, W1600xH1024, W1600xH1200, W1680xH1050, W1920xH1080, W1920xH1200, W1920xH1440, W2048xH1152, Custom
-AllowMultiMonitor <AllowMultiMonitor> Specifies the Multi-monitor option. Acceptable values: Enabled, Disabled, UseClientSettings. Possible values: Enabled, Disabled, UseClientSettings
-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-RASPubAVDDesktop -Id 1 -Enabled $false Disables a published desktop specified by ID. ---------- EXAMPLE 2 ---------- Set-RASPubAVDDesktop $PubAVDDesktop -Enabled $false Disables a published desktop specified by the $PubAVDDesktop object. To obtain the object, use the Get-RASPubAVDDesktop cmdlet. ---------- EXAMPLE 3 ---------- Get-RASPubAVDDesktop -Id 1 | Set-RASPubAVDDesktop -Enabled $false Disables a published desktop specified by an object obtained from the pipeline output.
Last updated