Skip to content

Latest commit

 

History

History
130 lines (95 loc) · 2.75 KB

Set-PnPPropertyBagValue.md

File metadata and controls

130 lines (95 loc) · 2.75 KB
Raw
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Set-PnPPropertyBagValue

SYNOPSIS

Sets a property bag value

SYNTAX

Folder

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

Web

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

EXAMPLES

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

PS:> Set-PnPPropertyBagValue -Key MyKey -Value MyValue

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

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

PS:> Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder /

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

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

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

PARAMETERS

-Folder

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

Type: String
Parameter Sets: Folder

Required: False
Position: Named
Accept pipeline input: False

-Indexed

Type: SwitchParameter
Parameter Sets: Web

Required: True
Position: Named
Accept pipeline input: False

-Key

Type: String
Parameter Sets: Web

Required: True
Position: Named
Accept pipeline input: False

-Value

Type: String
Parameter Sets: Web

Required: True
Position: Named
Accept pipeline input: False

-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