Get-PnPPropertyBag

Returns the property bag values.

Syntax

Get-PnPPropertyBag
   [-Key <String>]
                     [-Folder <String>]
                     [-Web <WebPipeBind>]
                     [-Connection <SPOnlineConnection>]

Examples

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

Get-PnPPropertyBag

This will return all web property bag values

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

Get-PnPPropertyBag -Key MyKey

This will return the value of the key MyKey from the web property bag

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

Get-PnPPropertyBag -Folder /MyFolder

This will return all property bag values for the folder MyFolder which is located in the root of the current web

------------------EXAMPLE 4------------------

Get-PnPPropertyBag -Folder /MyFolder -Key vti_mykey

This will return the value of the key vti_mykey from the folder MyFolder which is located in the root of the current web

------------------EXAMPLE 5------------------

Get-PnPPropertyBag -Folder / -Key vti_mykey

This will return the value of the key vti_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
-Key

Key that should be looked up

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

Outputs

SharePointPnP.PowerShell.Commands.PropertyBagValue