Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 2.01 KB

Get-PnPProperty.md

File metadata and controls

87 lines (62 loc) · 2.01 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Get-PnPProperty

SYNOPSIS

Returns a previously not loaded property of a ClientObject

SYNTAX

Get-PnPProperty -ClientObject <ClientObject>
                -Property <String[]>
                [-Connection <SPOnlineConnection>]

DESCRIPTION

Will populate properties of an object and optionally, if needed, load the value from the server. If one property is specified its value will be returned to the output.

EXAMPLES

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

PS:> $web = Get-PnPWeb
PS:> Get-PnPProperty -ClientObject $web -Property Id, Lists
PS:> $web.Lists

Will load both the Id and Lists properties of the specified Web object.

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

PS:> $list = Get-PnPList -Identity 'Site Assets'
PS:> Get-PnPProperty -ClientObject $list -Property Views

Will load the views object of the specified list object and return its value to the output.

PARAMETERS

-ClientObject

Specifies the object where the properties of should be retrieved

Type: ClientObject
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: False

-Property

The properties to load. If one property is specified its value will be returned to the output.

Type: String[]
Parameter Sets: (All)

Required: True
Position: 1
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

OUTPUTS

RELATED LINKS

SharePoint Developer Patterns and Practices