Remove-PnPPropertyBagValue

Removes a value from the property bag

Syntax

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

Examples

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

Remove-PnPPropertyBagValue -Key MyKey

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

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

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

Remove-PnPPropertyBagValue -Key MyKey -Folder /

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

Parameters

-Connection

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

Type:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Folder

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

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Force
Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Key

Key of the property bag value to be removed

Type:String
Position:0
Accept pipeline input:True
Accept wildcard characters: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
Position:Named
Accept pipeline input:False
Accept wildcard characters:False