Set-PubFolder

NAME

Set-PubFolder

SYNOPSIS

Modifies properties of a published folder.

SYNTAX

Set-PubFolder [-InputObject] <PubItem> [-AdminOnly <bool>] [-Description <string>] [-Enabled <bool>] [-Icon <string>] [-IconIndex <uint>] [-NewName <string>] [-PublishToSite <Site[]>] [-PublishToSiteIds <List`1>] [-SiteId <uint>] [<CommonParameters>]

Set-PubFolder [-Id] <uint> [-AdminOnly <bool>] [-Description <string>] [-Enabled <bool>] [-Icon <string>] [-IconIndex <uint>] [-NewName <string>] [-PublishToSite <Site[]>] [-PublishToSiteIds <List`1>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Modifies properties of a published folder.

You can include only the parameters (published folder properties) that you want to modify.

To set filtering options, use Pub Filtering cmdlets (e.g. Set-PubItemClientFilter).

PARAMETERS


-AdminOnly <bool>
Use folder for administrative purposes only. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-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

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

This is an alias of the Enabled parameter. 

        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 <List`1>
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

PubItem

OUTPUTS

-none-

EXAMPLES


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

Set-PubFolder 1 -Enabled $false

Disables a published folder specified by ID.

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

Set-PubFolder $PubFolder -Enabled $false

Disables a published folder specified by the $PubFolder object.

To obtain an object, use the Get-PubFolder cmdlet.

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

Get-PubFolder -Id 1 | Set-PubFolder -Enabled $false

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

RELATED LINKS