Set-PubItem

NAME

Set-PubItem

SYNOPSIS

Modifies settings of a published resource of any type (folder, app, desktop).

SYNTAX

Set-PubItem [-InputObject] <PubItem> [-Description <string>] [-Enable <bool>] [-Icon <string>] [-IconIndex <uint>] [-NewName <string>] [-PublishToSite <Site[]>] [-SiteId <uint>] [<CommonParameters>]

Set-PubItem [-Id] <uint> [-Description <string>] [-Enable <bool>] [-Icon <string>] [-IconIndex <uint>] [-NewName <string>] [-PublishToSite <Site[]>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Modifies settings of a published resource.

This cmdlet is used to modify settings which are common to published resources of all types.

For resource type-specific options, use Set-PubFolder, Set-RDSApp, and Set-RDSDesktop 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


-InputObject <PubItem>
Published item to be updated. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-NewName <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

-Enable <bool>
Enable or disable a published resource. 

        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

-Id <uint>
Published resource ID. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        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

PSAdmin.PubItem

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Set-PubItem 1 -Enable $false

Enables a published resource specified by ID.

---------- EXAMPLE 2 ----------

Set-PubItem -InputObject $PubItem -Enable $false

Modifies a published resource specified in the $PubItem variable, which is an object identifying a resource.

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

---------- EXAMPLE 3 ----------

Get-PubItem -Id 1 | Set-PubItem -Enable $false

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

RELATED LINKS