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

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.

EXAMPLES

Example 1

Enables a published resource specified by ID.

Example 2

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

Modifies a published resource which is specified by an object obtained from the pipeline output.

PARAMETERS

-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