Set-RASPubItem
NAME
Set-RASPubItem
SYNOPSIS
Modifies settings of a published resource of any type (folder, app, desktop).
SYNTAX
Set-RASPubItem [Id] (uint)** [Description (string)] [-EnabledMode {Disabled | Enabled | Maintenance}] [Icon (string)] [IconIndex (uint)] [InheritMaintenance (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)] [SiteId (uint)] [(CommonParameters)]
Set-RASPubItem [-InputObject]** (PubItem) [Description (string)] [-EnabledMode {Disabled | Enabled | Maintenance}] [Icon (string)] [IconIndex (uint)] [InheritMaintenance (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)] [SiteId (uint)] [(CommonParameters)]
DESCRIPTION
Modifies settings of a published resource.
Modifies settings which are common to published resources of all types.
For resource type-specific options, use Set-RASPubFolder, Set-RASRDSApp, and Set-RASRDSDesktop cmdlets.
A resource can be specified using either its name, ID, or an object containing the resource properties.
You can include only the parameters (resource properties) that you want to modify.
PARAMETERS
Name (string)
A new name to assign to the published resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Icon (string)
Published resource icon file name. Can be an executable (.exe), a .dll or a .ico file.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
IconIndex (uint)
Icon index
Specifies the index of the icon that will be loaded from the binary specified in the Icon property
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ReplicateMaintenance (bool)
Replicate Maintenance
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
InheritMaintenance (bool)
Inherit Maintenance
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
EnabledMode
(PubResourceEnabledMode) Changes the availability status of the published resource.
Possible values: Disabled, Enabled, Maintenance
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_en_US (string)
Maintenance message for the published resource in English.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_ja_JP (string)
Maintenance message for the published resource in Japanese.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_fr_FR (string)
Maintenance message for the published resource in French.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_es_ES (string)
Maintenance message for the published resource in Spanish.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_it_IT (string)
Maintenance message for the published resource in Italian.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_pt_BR (string)
Maintenance message for the published resource in Portuguese.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_nl_NL (string)
Maintenance message for the published resource in Dutch.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_de_DE (string)
Maintenance message for the published resource in German.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_zh_TW (string)
Maintenance message for the published resource in Chinese (Traditional).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_zh_CN (string)
Maintenance message for the published resource in Chinese (Simplified).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaintenanceMessage_ko_KR (string)
Maintenance message for the published resource in Korean.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Description (string)
Published resource description.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
PublishToSite (Site[])
An array of sites to which to publish a resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
PublishToSiteIds (uint[])
An array of sites to which to publish a resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
PreferredRoutingEnabled (bool)
Enable or disable Preferred Routing.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Id (uint)
Published resource ID.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
InputObject (PubItem)
An object specifying the published resource.
To obtain the object, use the Get-PubItem cmdlet.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
SiteId (uint)
Site ID.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
(CommonParameters)
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation.
INPUTS
OUTPUTS
-none-
EXAMPLES
**---------- EXAMPLE 1 ----------
Set-RASPubItem 1 -Enabled $false
Enables a published resource specified by ID. **---------- EXAMPLE 2 ----------
Set-RASPubItem -InputObject $PubItem -Enabled $false
Modifies a published resource specified in the $PubItem variable, which is an object identifying a resource.
The obtain the object, use the Get-RASPubItem cmdlet. **---------- EXAMPLE 3 ----------
Get-RASPubItem -Id 1 | Set-RASPubItem -Enabled $false
Modifies a published resource which is specified by an object obtained from the pipeline output.
RELATED LINKS
Last updated