Set-PubItemUserFilter

NAME

Set-PubItemUserFilter

SYNOPSIS

Modifies the filter of type 'User' for the specified published resource.

SYNTAX

Set-PubItemUserFilter [-InputObject] <PubItem> [-SiteId <uint>] [-UserFilterEnabled <bool>] [-UserFilterReplicate <bool>] [<CommonParameters>]

Set-PubItemUserFilter [-Id] <uint> [-SiteId <uint>] [-UserFilterEnabled <bool>] [-UserFilterReplicate <bool>] [<CommonParameters>]

DESCRIPTION

This cmdlet modifies general options for the filter of type 'User'.

To add user accounts to the filter, use the Add-PubItemUserFilter cmdlet.

PARAMETERS


-UserFilterEnabled <bool>
Whether the filter should be enabled or disabled for the specified resource.

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

-Enable <bool>
Whether the filter should be enabled or disabled for the specified resource.

This is an alias of the UserFilterEnabled parameter.

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

-UserFilterReplicate <bool>
Whether the filter settings should be replicated to all sites.

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

-Replicate <bool>
Whether the filter settings should be replicated to all sites.

This is an alias of the UserFilterReplicate parameter.

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

-InputObject <PubItem>
An object specifying the published resource to be updated.

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

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        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-PubItemUserFilter -Id 3 -Enable $False

Enables filtering of type 'User' for the published resource specified by ID.

RELATED LINKS