Skip to content

Latest commit

 

History

History
108 lines (79 loc) · 2.46 KB

Remove-PnPPropertyBagValue.md

File metadata and controls

108 lines (79 loc) · 2.46 KB
Raw
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Remove-PnPPropertyBagValue

SYNOPSIS

Removes a value from the property bag

SYNTAX

Remove-PnPPropertyBagValue -Key <String>
                           [-Folder <String>]
                           [-Force [<SwitchParameter>]]
                           [-Web <WebPipeBind>]
                           [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Remove-PnPPropertyBagValue -Key MyKey

This will remove the value with key MyKey from the current web property bag

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

PS:> Remove-PnPPropertyBagValue -Key MyKey -Folder /MyFolder

This will remove the value with key MyKey from the folder MyFolder which is located in the root folder of the current web

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

PS:> Remove-PnPPropertyBagValue -Key MyKey -Folder /

This will remove the value with key MyKey from the root folder of the current web

PARAMETERS

-Folder

Site relative url of the folder. See examples for use.

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Force

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Key

Key of the property bag value to be removed

Type: String
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: True

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices