Skip to content

Latest commit

 

History

History
113 lines (82 loc) · 2.63 KB

Get-PnPPropertyBag.md

File metadata and controls

113 lines (82 loc) · 2.63 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Get-PnPPropertyBag

SYNOPSIS

Returns the property bag values.

SYNTAX

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

EXAMPLES

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

PS:> Get-PnPPropertyBag

This will return all web property bag values

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

PS:> Get-PnPPropertyBag -Key MyKey

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

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

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

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

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

-Folder

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

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Key

Key that should be looked up

Type: String
Parameter Sets: (All)

Required: False
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

OUTPUTS

SharePointPnP.PowerShell.Commands.PropertyBagValue

RELATED LINKS

SharePoint Developer Patterns and Practices