Skip to content

Latest commit

 

History

History
94 lines (69 loc) · 2.72 KB

Add-PnPFieldFromXml.md

File metadata and controls

94 lines (69 loc) · 2.72 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Add-PnPFieldFromXml

SYNOPSIS

Adds a field to a list or as a site column based upon a CAML/XML field definition

SYNTAX

Add-PnPFieldFromXml -FieldXml <String>
                    [-List <ListPipeBind>]
                    [-Web <WebPipeBind>]
                    [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />'
PS:> Add-PnPFieldFromXml -FieldXml $xml

Adds a field with the specified field CAML code to the site.

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

PS:> $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />'
PS:> Add-PnPFieldFromXml -List "Demo List" -FieldXml $xml

Adds a field with the specified field CAML code to the list "Demo List".

PARAMETERS

-FieldXml

CAML snippet containing the field definition. See http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx

Type: String
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: False

-List

The name of the list, its ID or an actual list object where this field needs to be added

Type: ListPipeBind
Parameter Sets: (All)

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

RELATED LINKS

SharePoint Developer Patterns and PracticesField CAML