Set-PnPPropertyBagValue

Sets a property bag value

Syntax

Set-PnPPropertyBagValue
   -Key <String>
                          -Value <String>
                          [-Folder <String>]
                          [-Web <WebPipeBind>]
                          [-Connection <SPOnlineConnection>]
Set-PnPPropertyBagValue
   -Key <String>
                          -Value <String>
                          -Indexed [<SwitchParameter>]
                          [-Web <WebPipeBind>]
                          [-Connection <SPOnlineConnection>]

Examples

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

Set-PnPPropertyBagValue -Key MyKey -Value MyValue

This sets or adds a value to the current web property bag

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

Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder /

This sets or adds a value to the root folder of the current web

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

Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder /MyFolder

This sets or adds a value to the folder MyFolder which is located in the root folder of the current web

Required Parameters

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

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