Search Results for

    Show / Hide Table of Contents

    Remove-PnPField

    SYNOPSIS

    Removes a field from a list or a site.

    SYNTAX

    Remove-PnPField [-Identity] <FieldPipeBind> [[-List] <ListPipeBind>] [-Force] [-Connection <PnPConnection>]
    

    DESCRIPTION

    Allows to remove a field from a list or a site.

    EXAMPLES

    EXAMPLE 1

    Remove-PnPField -Identity "Speakers"
    

    Removes the "Speakers" field from the site columns.

    EXAMPLE 2

    Remove-PnPField -List "Demo list" -Identity "Speakers"
    

    Removes the speakers field from the list "Demo list".

    EXAMPLE 3

    $batch = New-PnPBatch
    Remove-PnPField -List "Demo list" -Identity "Speakers" -Batch $batch
    Remove-PnPField -List "Demo list" -Identity "Sponsors" -Batch $batch
    Remove-PnPField -List "Demo list" -Identity "Organizers" -Batch $batch
    Remove-PnPField -Identity "Test" -Batch $batch
    Invoke-PnPBatch $batch
    

    Removes the speakers, sponsors and organizers fields from the list "Demo list" as well as Test field from the web in a batch.

    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
    

    -Force

    Specifying the Force parameter will skip the confirmation question.

    Type: SwitchParameter
    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 remove.

    Type: FieldPipeBind
    Parameter Sets: (All)
    
    Required: True
    Position: 0
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    -List

    The list object or name where to remove the field from.

    Type: ListPipeBind
    Parameter Sets: (All)
    
    Required: False
    Position: 1
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    -Batch

    Batch object used to remove fields in a batched manner. See above example on how to use this.

    Type: PnPBatch
    Parameter Sets: (All)
    
    Required: False
    Position: named
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    RELATED LINKS

    Microsoft 365 Patterns and Practices

    Back to top Generated by DocFX spacer