Get-PnPField
SYNOPSIS
Returns a field from a list or site
SYNTAX
Get-PnPField [-List <ListPipeBind>] [[-Identity] <FieldPipeBind>] [-Group <String>] [-InSiteHierarchy]
[-Connection <PnPConnection>] [-Includes <String[]>]
DESCRIPTION
EXAMPLES
EXAMPLE 1
Get-PnPField
Gets all the fields from the current site
EXAMPLE 2
Get-PnPField -List "Demo list" -Identity "Speakers"
Gets the speakers field from the list Demo list
EXAMPLE 3
Get-PnPField -Group "Custom Columns"
Gets all the fields for the group called Custom Columns for the site currently connected to
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: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Group
Filter to the specified group
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
The field object or name to get
Type: FieldPipeBind
Parameter Sets: (All)
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-InSiteHierarchy
Search site hierarchy for fields
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-List
The list object or name where to get the field from
Type: ListPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Includes
Optionally allows properties to be retrieved for the returned field which are not included in the response by default
Type: String[]
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False