Get-PnPField.md

external help file	applicable	schema
	SharePoint Server 2013, SharePoint Server 2016, SharePoint Online	2.0.0

Get-PnPField

SYNOPSIS

Returns a field from a list or site

SYNTAX

Get-PnPField [-List <ListPipeBind>]
             [-Group <String>]
             [-Web <WebPipeBind>]
             [-Includes <String[]>]
             [-Identity <FieldPipeBind>]
             [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Get-PnPField

Gets all the fields from the current site

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

PS:> Get-PnPField -List "Demo list" -Identity "Speakers"

Gets the speakers field from the list Demo list

PARAMETERS

-Group

Filter to the specified group

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Identity

The field object or name to get

Type: FieldPipeBind
Parameter Sets: (All)

Required: False
Position: 0
Accept pipeline input: True

-Includes

Specify properties to include when retrieving objects from the server.

Type: String[]
Parameter Sets: 

Required: False
Position: 0
Accept pipeline input: False

-List

The list object or name where to get the field from

Type: ListPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: True

-Web

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

-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

Microsoft.SharePoint.Client.Field

RELATED LINKS

SharePoint Developer Patterns and Practices