SharePointSDK.psm1-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> <!-- Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16--> <!-- Module: SharePointSDK Version: 2.0 --> <!-- All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Add-SPListFieldToDefaultView</command:name> <maml:description> <maml:para>Add a SharePoint list field to the list default view.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPListFieldToDefaultView</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Add a SharePoint list field to the list default view.. A boolean value of $true is returned if the operation is successful, otherwise, an exception is thrown and $false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Add-SPListFieldToDefaultView</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPListFieldToDefaultView</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPListFieldToDefaultView</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPListFieldToDefaultView</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$ListFields = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" $LastNameField = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" | Where-Object {$_.Title -eq 'Last Name'} $AddToDefaultView = Add-SPListFieldToDefaultView -SPConnection $SPConnection -ListTitle "Test List" -FieldInternalName $LastNameField.InternalName </dev:code> <dev:remarks> <maml:para>Adding field "Last Name" to the default view by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$ListFields = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" $LastNameField = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" | Where-Object {$_.Title -eq 'Last Name'} $AddToDefaultView = Add-SPListFieldToDefaultView -SPConnection $SPConnection -ListId "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96" -FieldInternalName $LastNameField.InternalName </dev:code> <dev:remarks> <maml:para>Adding field "Last Name" to the default view by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $ListFields = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" $LastNameField = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" | Where-Object {$_.Title -eq 'Last Name'} $AddToDefaultView = Add-SPListFieldToDefaultView -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListTitle "Test List" -FieldInternalName $LastNameField.InternalName </dev:code> <dev:remarks> <maml:para>Adding field "Last Name" to the default view by providing individual SharePoint connection parameters. </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Add-SPListItem</command:name> <maml:description> <maml:para>Add a list item to the SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPListItem</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Add a list item to the SharePoint site. When the item has been successfully added, the List Item ID is returned. a NULL value is returned if the item is not added to the list.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Add-SPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the SharePoint list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListFieldsValues</maml:name> <maml:description> <maml:para>A hash table containing List item that to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the SharePoint list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListFieldsValues</maml:name> <maml:description> <maml:para>A hash table containing List item that to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the SharePoint list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListFieldsValues</maml:name> <maml:description> <maml:para>A hash table containing List item that to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$HashTableListFieldsValues= @{ Title = "List Item Title" Description = "List Item Description Text" } $AddListItem = Add-SPListItem -SPConnection $SPConnection -ListName "Test List" -ListFieldsValues $HashTableListFieldsValues</dev:code> <dev:remarks> <maml:para>Adding a SharePoint List item using a SMA or Azure Automation connection object</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$HashTableListFieldsValues= @{ Title = "List Item Title" Description = "List Item Description Text" } $Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $AddListItem = Add-SPListItem -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListName "Test List" -ListFieldsValues $HashTableListFieldsValues </dev:code> <dev:remarks> <maml:para>Adding a SharePoint List item by providing individual connection parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Add-SPListItemAttachment</command:name> <maml:description> <maml:para>Upload a file as a SharePoint list item attachment.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SPListItemAttachment</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Upload a file as a SharePoint list item attachment. Please note this function DOES NOT work on SharePoint 2010 sites.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Add-SPListItemAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ByteArray"> <maml:name>ContentByteArray</maml:name> <maml:description> <maml:para>the byte array that contains the content of the attachment file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Name"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name of the attachment to be createdto the SharePoint List item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPListItemAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Path"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The file path of the file to be attached to the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPListItemAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ByteArray"> <maml:name>ContentByteArray</maml:name> <maml:description> <maml:para>the byte array that contains the content of the attachment file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Name"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name of the attachment to be createdto the SharePoint List item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SPListItemAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Path"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The file path of the file to be attached to the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ByteArray"> <maml:name>ContentByteArray</maml:name> <maml:description> <maml:para>the byte array that contains the content of the attachment file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Name"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name of the attachment to be createdto the SharePoint List item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Path"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The file path of the file to be attached to the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$AddAttachment = Add-SPListItemAttachment -SPConnection $SPConnection -ListName "Test List" -ListItemID 1 -FilePath "\\Server01\ShareFolder\File.txt"</dev:code> <dev:remarks> <maml:para>Uploading an attachment from a UNC path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $AddAttachment = Add-SPListItemAttachment -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSPO $true -ListName "Test List" -ListItemID 1 -FilePath "\\Server01\ShareFolder\File.txt" </dev:code> <dev:remarks> <maml:para>Uploading an attachment from a UNC path and providing individual SharePoint connection objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$text = "hello world" [Byte[]]$Bytes=[System.Text.Encoding]::Default.GetBytes($text) $AddAttachment = Add-SPListItemAttachment -SPConnection $SPConnection -ListName "Test List" -ListItemID 1 -ContentByteArray $Bytes -FileName "HelloWord.txt"</dev:code> <dev:remarks> <maml:para>Creating an attachment by reading the content of a file (without uploading)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>[Byte[]]$bytes = [System.IO.File]::ReadAllBytes("C:\Temp\Original.zip") $Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username", $SecurePassword) $AddAttachment = Add-SPListItemAttachment -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSPO $true -ListName "Test List" -ListItemID 1 -ContentByteArray $Bytes -FileName "renamed.zip"</dev:code> <dev:remarks> <maml:para>Creating an attachment by reading the content of a file (without uploading) and providing individual SharePoint connection objects.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Clear-SPSiteRecycleBin</command:name> <maml:description> <maml:para>Empty the SharePoint site recycle bin.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>SPSiteRecycleBin</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Empty the SharePoint site recycle bin. A boolean value of $true returned when the operation has been successfully performed, otherwise, an exception is thrown and $false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Clear-SPSiteRecycleBin</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Clear-SPSiteRecycleBin</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$EmptyRecycleBin = Clear-SPSiteRecycleBin -SPConnection $SPConnection</dev:code> <dev:remarks> <maml:para>Empty the SharePoint site recycle bin by providing the SMA / Azure Automation connection object</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $EmptyRecycleBin = Clear-SPSiteRecycleBin -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true </dev:code> <dev:remarks> <maml:para>Empty the SharePoint site recycle bin by providing the individual SharePoint site connection parameters</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SPGroup</command:name> <maml:description> <maml:para>Get a single group or all groups from the SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPGroup</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get a single group or all groups from the SharePoint site. A 'Microsoft.SharePoint.Client.Group' or 'Microsoft.SharePoint.Client.GroupCollection' object is returned when the list has been successfully retrieved, otherwise, an exception is thrown.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SPGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.GroupCollection Microsoft.SharePoint.Client.Group </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SPGroup = Get-SPGroup -SPConnection $SPConnection -GroupTitle "Team Site Members"</dev:code> <dev:remarks> <maml:para>Get the Group by title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SPGroup = Get-SPGroup -SPConnection $SPConnection -GroupId 8</dev:code> <dev:remarks> <maml:para>Get the Group by Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SPGroups = Get-SPGroup -SPConnection $SPConnection</dev:code> <dev:remarks> <maml:para>Get all groups</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $SPGroup = Get-SPGroup -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -GroupTitle "Team Site Members" </dev:code> <dev:remarks> <maml:para>Get all groups by providing individual SharePoint connection parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SPList</command:name> <maml:description> <maml:para>Get a list from the SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPList</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get a list from the SharePoint site. A 'Microsoft.SharePoint.Client.List' object is returned when the list has been successfully retrieved, otherwise, an exception is thrown.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.List </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SPList = Get-SPList -SPConnection $SPConnection -ListTitle "Test List"</dev:code> <dev:remarks> <maml:para>Get the list by title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SPList = Get-SPList -SPConnection $SPConnection -ListId "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96"</dev:code> <dev:remarks> <maml:para>Get the list by Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $SPList = Get-SPList -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListTitle "Test List"</dev:code> <dev:remarks> <maml:para>Get the list by title by providing individual SharePoint connection parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SPListFields</command:name> <maml:description> <maml:para>Get all fields from a list on a SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPListFields</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get all fields from a list on a SharePoint site.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SPListFields</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePoint SDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ListTitle"> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name / Title of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPListFields</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ListTitle"> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name / Title of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePoint SDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ListTitle"> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name / Title of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Array System.Array </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$ListFields = Get-SPListFields -SPConnection $SPConnection -ListName "Test List"</dev:code> <dev:remarks> <maml:para>Get all list fields for list "Test List"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "YourDomain\YourUserName" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $ListFields = Get-SPListFields -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -ListName "Test List" -IsSharePointOnlineSite $true </dev:code> <dev:remarks> <maml:para>Get all list fields for list "Test List" by providing individual SharePoint connection parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SPListItem</command:name> <maml:description> <maml:para>Get all items from a list on a SharePoint site or a specific item by specifying the List Item ID.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPListItem</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get all items from a list on a SharePoint site or a specific item by specifying the List Item ID. A Hash Table is used to store the property and value of each list item returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Array System.Collections.Hashtable </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$ListItems = Get-SPListItem -SPConnection $SPConnection -ListName "Test List"</dev:code> <dev:remarks> <maml:para>Get all SharePoint list items using the SMA / Azure Automation connection object and the list name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$ListItem = Get-SPListItem -SPConnection $SPConnection -ListName "Test List" -ListItemID 1</dev:code> <dev:remarks> <maml:para>Get a single SharePoint list item using the SMA / Azure Automation connection object and the list name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $ListItems = Get-SPListItem -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSPO $true -ListName "Test List"</dev:code> <dev:remarks> <maml:para>Get all SharePoint list items by providing individual SharePoint connection parameters and the list name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $ListItem = Get-SPListItem -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSPO $true -ListName "Test List" -ListItemID 1</dev:code> <dev:remarks> <maml:para>Get a single list item by providing individual SharePoint connection parameters and the list name.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SPListItemAttachments</command:name> <maml:description> <maml:para>Download all attachments from a SharePoint list item.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPListItemAttachments</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Download all attachments from a SharePoint list item. Please note this function DOES NOT work on SharePoint 2010 sites.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SPListItemAttachments</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>DestinationFolder</maml:name> <maml:description> <maml:para>The destination folder of where attachments will be saved to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPListItemAttachments</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>DestinationFolder</maml:name> <maml:description> <maml:para>The destination folder of where attachments will be saved to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>DestinationFolder</maml:name> <maml:description> <maml:para>The destination folder of where attachments will be saved to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$DownloadAttachments = Get-SPListItemAttachments -SPConnection $SPConnection -ListName "Test List" -ListItemID 1 -DestinationFolder "\\Server01\ShareFolder"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $DownloadAttachments = Get-SPListItemAttachments -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSPO $true -ListName "Test List" -ListItemID 1 -Destination "\\Server01\ShareFolder"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SPServerVersion</command:name> <maml:description> <maml:para>Get SharePoint server version.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPServerVersion</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get SharePoint server version using SharePoint CSOM (Client-Side Object Model)</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SPServerVersion</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePoint SDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPServerVersion</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePoint SDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Version </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-ServerVersion -SPConnection $SPConnection</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "YourDomain\YourUserName" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $ServerVersion = Get-SPServerVersion -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true</dev:code> <dev:remarks> <maml:para>Get the SharePoint server version for the SharePoint Online site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $ServerVersion = Get-SPServerVersion -SiteUrl "http://Shrepoint.YourCompany.com" -Credential $MyPSCred -IsSharePointOnlineSite $false</dev:code> <dev:remarks> <maml:para>Get the SharePoint server version for your On-Premises SharePoint site.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SPSiteTemplate</command:name> <maml:description> <maml:para>Get avaialble Site Template(s) from the SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPSiteTemplate</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get avaialble Site Template(s) from the SharePoint site. All avaialbe templates will be returned within a 'Microsoft.SharePoint.Client.WebTemplateCollection' object if no template name or title has been specified or a single template ('Microsoft.SharePoint.Client.WebTemplate' object) will be returned if either the name or the title has been specified. An exception will be thrown if nothing is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SPSiteTemplate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TemplateTitle</maml:name> <maml:description> <maml:para>The title of the site template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>The name of the site template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Locale"> <maml:name>TemplateLocale</maml:name> <maml:description> <maml:para>The locale of the site template. This is a optional parameter, the default value is 'en-us' if not specified. Use PowerShell cmdlet Get-Culture to get the current culture of the computer, or use "[System.Globalization.CultureInfo]::GetCultures("AllCultures")" to get all possible values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPSiteTemplate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TemplateTitle</maml:name> <maml:description> <maml:para>The title of the site template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>The name of the site template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Locale"> <maml:name>TemplateLocale</maml:name> <maml:description> <maml:para>The locale of the site template. This is a optional parameter, the default value is 'en-us' if not specified. Use PowerShell cmdlet Get-Culture to get the current culture of the computer, or use "[System.Globalization.CultureInfo]::GetCultures("AllCultures")" to get all possible values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TemplateTitle</maml:name> <maml:description> <maml:para>The title of the site template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>The name of the site template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Locale"> <maml:name>TemplateLocale</maml:name> <maml:description> <maml:para>The locale of the site template. This is a optional parameter, the default value is 'en-us' if not specified. Use PowerShell cmdlet Get-Culture to get the current culture of the computer, or use "[System.Globalization.CultureInfo]::GetCultures("AllCultures")" to get all possible values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.WebTemplateCollection Microsoft.SharePoint.Client.WebTemplate </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SPSiteTemplate -SPConnection $SPConnection -TemplateTitle "Team Site"</dev:code> <dev:remarks> <maml:para>Get the template by title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SPSiteTemplate = Get-SPSiteTemplate -SPConnection $SPConnection -TemplateName "STS#0"</dev:code> <dev:remarks> <maml:para>Get the template by Name</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $AllSPSiteTemplates = Get-SPSiteTemplate -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true</dev:code> <dev:remarks> <maml:para>Get all available templates</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SPSubSite</command:name> <maml:description> <maml:para>Get all SharePoint sub sites from a root site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SPSubSite</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Get all SharePoint sub sites from a root site. An array containing 'Microsoft.SharePoint.Client.Site' objects is returned when a sub sites has been successfully retrieved.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SPSubSite</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SPSubSite</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RootSiteURL"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Root Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RootSiteURL"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Root Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Array </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SPSubSite -SPConnection $SPConnection</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true } $SubSites = Get-SPSubSite @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Import-SPClientSDK</command:name> <maml:description> <maml:para>Load SharePoint Client SDK DLLs</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Import</command:verb> <command:noun>SPClientSDK</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Load SharePoint Client SDK DLLs from either the Global Assembly Cache or from the DLLs located in SharePointSDK PS module directory. It will use GAC if the DLLs are already loaded in GAC.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Import-SPClientSDK</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Import-SPClientSDK</dev:code> <dev:remarks> <maml:para>Load the SharePoint Client SDK DLLs</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPCredential</command:name> <maml:description> <maml:para>Create a SharePoint credential that can be used authenticating to a SharePoint (online or On-Premise) site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPCredential</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a Network Credential object(System.Net.NetworkCredential) or SharePoint Online credential object(Microsoft.SharePoint.Client.SharePointOnlineCredentials) that can be used authenticating to a SharePoint site. This function will return a Microsoft.SharePoint.Client.SharePointOnlineCredentials object if its going to be used on a SharePoint Online site, or a System.Net.NetworkCredential object if it is to be used on a On-Premise SharePoint site.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPCredential</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Connection , c"> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePoint SDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPCredential</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Connection , c"> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePoint SDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.SharePointOnlineCredentials System.Net.NetworkCredential </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SPCred = New-SPCredential -SPConnection "MySPOSite"</dev:code> <dev:remarks> <maml:para>Create a Credential object using a SMA / Azure Automation connection object named "MySPOSite"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCreds = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $SPCred = New-SPCredential -Credential $MyPSCred -IsSharePointOnlineSite $true</dev:code> <dev:remarks> <maml:para>Create a Credential for a SharePoint Online site by specifying the user name and password</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "YourDomain\YourUserName" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $SPCred = New-SPCredential -Credential $MyPSCred -IsSPO $false</dev:code> <dev:remarks> <maml:para>Create a Credential for a On-Premises SharePoint site by specifying the user credential</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "YourDomain\YourUserName" $SecurePassword = Read-Host -Prompt 'Input password here' -AsSecureString $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username", $SecurePassword) $SPCred = New-SPCredential -Credential $MyPSCred -IsSPO $false</dev:code> <dev:remarks> <maml:para>Create a Credential for a On-Premise SharePoint site by specifying the user credential and prompt user to enter the password.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPGroupMember</command:name> <maml:description> <maml:para>Add an user to a SharePoint group.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPGroupMember</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Add an user to a SharePoint group. A boolean value of $true returned when the user has been successfully added, otherwise, an exception is thrown and $false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="New"> <maml:name>NewMemberUserName</maml:name> <maml:description> <maml:para>The username of the user to be added to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="New"> <maml:name>NewMemberUserName</maml:name> <maml:description> <maml:para>The username of the user to be added to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="New"> <maml:name>NewMemberUserName</maml:name> <maml:description> <maml:para>The username of the user to be added to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="New"> <maml:name>NewMemberUserName</maml:name> <maml:description> <maml:para>The username of the user to be added to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="New"> <maml:name>NewMemberUserName</maml:name> <maml:description> <maml:para>The username of the user to be added to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SPGroupMember -SPConnection $SPConnection -GroupTitle "Test Group" -NewMemberUserName "domain\UserID"</dev:code> <dev:remarks> <maml:para>Add the user by providing the group title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$AddUser = New-SPGroupMember -SPConnection $SPConnection -GroupId 5 -NewMemberUserName "domain\UserID"</dev:code> <dev:remarks> <maml:para>Add the user by providing the group Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $AddUser = New-SPGroupMember -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -GroupTitle "Test Group" -NewMemberUserName "newmember@yourcompany.com" </dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPGroup</command:name> <maml:description> <maml:para>Create a new SharePoint group.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPGroup</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new SharePoint group. A boolean value of $true returned when the group has been successfully created, otherwise, an exception is thrown and $false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPGroup</maml:name> <command:parameter required="true" pipelineinput="false" globbing="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePoint SDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineinput="false" globbing="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>The name of the new group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named" aliases=""> <maml:name>GroupDescription</maml:name> <maml:description> <maml:para>The description of the new group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue>$NULL</dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named" aliases=""> <maml:name>GroupRoles</maml:name> <maml:description> <maml:para>An optional array parameter specifying the roles to be assigned to the group. Possible roles include: Administrator Contributor Editor Guest Reader</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPGroup</maml:name> <command:parameter required="true" pipelineinput="false" globbing="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineinput="false" globbing="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineinput="false" globbing="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named"> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>The name of the new group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named"> <maml:name>GroupDescription</maml:name> <maml:description> <maml:para>The description of the new group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named"> <maml:name>GroupRoles</maml:name> <maml:description> <maml:para>An optional array parameter specifying the roles to be assigned to the group. Possible roles include: Administrator Contributor Editor Guest Reader</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePoint SDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>The name of the new group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupDescription</maml:name> <maml:description> <maml:para>The description of the new group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue>$NULL</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupRoles</maml:name> <maml:description> <maml:para>An optional array parameter specifying the roles to be assigned to the group. Possible roles include: Administrator Contributor Editor Guest Reader</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!-- Outputs--> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$NewGroup = New-SPGroup -SPConnection $SPConnection -GroupTitle "Test SharePoint Group" -GroupDescription "Test SP group description"</dev:code> <dev:remarks> <maml:para>Creating a new SharePoint group using the SMA / Azure Automation connection object without assigning roles to the group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$NewGroup = New-SPGroup -SPConnection $SPConnection -GroupTitle "Test SharePoint Group" -GroupDescription "Test SP group description" -GroupRoles @('Reader', 'Contributor')</dev:code> <dev:remarks> <maml:para>Creating a new SharePoint group using the SMA / Azure Automation connection object and assign "Reader" and "Contributor" roles to the group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $NewGroup = New-SPGroup -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -GroupTitle "Test SharePoint Group" -GroupDescription "Test SP group description" -GroupRoles @('Administrator')</dev:code> <dev:remarks> <maml:para>Creating a new SharePoint group using individual SharePoint connection parameters and assign "Administrator" roles to the group.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPList</command:name> <maml:description> <maml:para>Create a new list on the SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPList</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new list on the SharePoint site. A 'Microsoft.SharePoint.Client.List' object is returned when the list has been successfully created, otherwise, an exception is thrown.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListDescription</maml:name> <maml:description> <maml:para>Description of the list</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>QuickLaunch</maml:name> <maml:description> <maml:para>Boolean parameter. Specify if the list should appear on Quick Launch. This is an optional parameter, the default value is $false if not speicified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTemplateType</maml:name> <maml:description> <maml:para>The template type of the list. For possible values, please refer to: https://msdn.microsoft.com/EN-US/library/microsoft.sharepoint.client.listtemplatetype.aspx</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListDescription</maml:name> <maml:description> <maml:para>Description of the list</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>QuickLaunch</maml:name> <maml:description> <maml:para>Boolean parameter. Specify if the list should appear on Quick Launch. This is an optional parameter, the default value is $false if not speicified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTemplateType</maml:name> <maml:description> <maml:para>The template type of the list. For possible values, please refer to: https://msdn.microsoft.com/EN-US/library/microsoft.sharepoint.client.listtemplatetype.aspx</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListDescription</maml:name> <maml:description> <maml:para>Description of the list</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>QuickLaunch</maml:name> <maml:description> <maml:para>Boolean parameter. Specify if the list should appear on Quick Launch. This is an optional parameter, the default value is $false if not speicified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTemplateType</maml:name> <maml:description> <maml:para>The template type of the list. For possible values, please refer to: https://msdn.microsoft.com/EN-US/library/microsoft.sharepoint.client.listtemplatetype.aspx</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.List </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$NewList = New-SPList -SPConnection $SPConnection -ListTitle "Test List" -ListDescription "Description for the test list" -QuickLaunch $true -ListTemplateType "GenericList"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $NewList = New-SPList -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListTitle "Test List" -ListDescription "Description for the test list" -ListTemplateType "GenericList"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListCheckboxField</command:name> <maml:description> <maml:para>Create a new checkbox Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListCheckboxField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new checkbox Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListCheckboxField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckedByDefault</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a checked by default Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListCheckboxField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckedByDefault</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a checked by default Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListCheckboxField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckedByDefault</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a checked by default Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListCheckboxField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckedByDefault</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a checked by default Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CheckedByDefault</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a checked by default Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "TestCheckbox"; FieldDisplayName = "Test Check box"; FieldDescription = "please specify the value for the test checkbox"; } $NewField = New-SPListCheckboxField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListId = "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96"; FieldName = "TestCheckbox"; FieldDisplayName = "Test Check box"; FieldDescription = "please specify the value for the test checkbox"; CheckedByDefault = $false; } $NewField = New-SPListCheckboxField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "TestCheckbox"; FieldDisplayName = "Test Check box"; FieldDescription = "please specify the value for the test checkbox"; AddToDefaultView = $false } $NewField = New-SPListCheckboxField @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListChoiceField</command:name> <maml:description> <maml:para>Create a new choice Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListChoiceField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new choice Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListChoiceField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify how the choices are displayed. Possible values: DropDown - Display the choices using a Drop-Down menu RadioButtons - Display the choices using radio buttons CheckBoxes - Display the choices using checkboxes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Choices</maml:name> <maml:description> <maml:para>Specify a list of choices using an array of strings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value for this Field. This is an optional parameter. the first choice will be used if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FillInChoice</maml:name> <maml:description> <maml:para>Boolean parameter, specify if 'Fill-In' choices are allowed. This is an optional parameter, the default value is $false when not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListChoiceField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify how the choices are displayed. Possible values: DropDown - Display the choices using a Drop-Down menu RadioButtons - Display the choices using radio buttons CheckBoxes - Display the choices using checkboxes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Choices</maml:name> <maml:description> <maml:para>Specify a list of choices using an array of strings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value for this Field. This is an optional parameter. the first choice will be used if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FillInChoice</maml:name> <maml:description> <maml:para>Boolean parameter, specify if 'Fill-In' choices are allowed. This is an optional parameter, the default value is $false when not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListChoiceField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify how the choices are displayed. Possible values: DropDown - Display the choices using a Drop-Down menu RadioButtons - Display the choices using radio buttons CheckBoxes - Display the choices using checkboxes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Choices</maml:name> <maml:description> <maml:para>Specify a list of choices using an array of strings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value for this Field. This is an optional parameter. the first choice will be used if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FillInChoice</maml:name> <maml:description> <maml:para>Boolean parameter, specify if 'Fill-In' choices are allowed. This is an optional parameter, the default value is $false when not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListChoiceField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify how the choices are displayed. Possible values: DropDown - Display the choices using a Drop-Down menu RadioButtons - Display the choices using radio buttons CheckBoxes - Display the choices using checkboxes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Choices</maml:name> <maml:description> <maml:para>Specify a list of choices using an array of strings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value for this Field. This is an optional parameter. the first choice will be used if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FillInChoice</maml:name> <maml:description> <maml:para>Boolean parameter, specify if 'Fill-In' choices are allowed. This is an optional parameter, the default value is $false when not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify how the choices are displayed. Possible values: DropDown - Display the choices using a Drop-Down menu RadioButtons - Display the choices using radio buttons CheckBoxes - Display the choices using checkboxes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Choices</maml:name> <maml:description> <maml:para>Specify a list of choices using an array of strings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value for this Field. This is an optional parameter. the first choice will be used if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FillInChoice</maml:name> <maml:description> <maml:para>Boolean parameter, specify if 'Fill-In' choices are allowed. This is an optional parameter, the default value is $false when not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "Colour"; FieldDisplayName = "Colour"; FieldDescription = "please select your favourite colours"; Required = $true; Style='CheckBoxes'; Choices=@('Red','Green','Black','Blue','White'); DefaultValue='Red'; FillInChoice=$true } $NewField = New-SPListChoiceField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListId = "d44bbd14-b98b-478e-8997-e6deb002dd18"; FieldName = "VehicleType"; FieldDisplayName = "Vehicle Type"; FieldDescription = "please specify the vehicle type"; Required = $true; EnforceUniqueValues = $true; Style='DropDown' Choices=@('Car','Truck','Ute','Bus','SUV') FillInChoice=$true } $NewField = New-SPListChoiceField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "VehicleType"; FieldDisplayName = "Vehicle Type"; FieldDescription = "please specify the vehicle type"; Required = $true; Style='RadioButtons' Choices=@('Car','Truck','Ute','Bus','SUV') FillInChoice=$true } $NewField = New-SPListChoiceField @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListDateTimeField</command:name> <maml:description> <maml:para>Create a new date time Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListDateTimeField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new date time Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListDateTimeField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the column Style. Possible values: DateOnly - Date Only DateTime - Date & Time This is an optional parameter. The default value is DateOnly if not specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue>DateOnly</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FriendlyDisplay</maml:name> <maml:description> <maml:para>Boolean parameter, specify if the Friendly display format should be used. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UseTodayAsDefaultValue</maml:name> <maml:description> <maml:para>Boolean parameter, specify if use Today's date as the default value. This is an optional parameter, if not specified, the value is set to $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListDateTimeField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the column Style. Possible values: DateOnly - Date Only DateTime - Date & Time This is an optional parameter. The default value is DateOnly if not specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue>DateOnly</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FriendlyDisplay</maml:name> <maml:description> <maml:para>Boolean parameter, specify if the Friendly display format should be used. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UseTodayAsDefaultValue</maml:name> <maml:description> <maml:para>Boolean parameter, specify if use Today's date as the default value. This is an optional parameter, if not specified, the value is set to $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListDateTimeField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the column Style. Possible values: DateOnly - Date Only DateTime - Date & Time This is an optional parameter. The default value is DateOnly if not specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue>DateOnly</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FriendlyDisplay</maml:name> <maml:description> <maml:para>Boolean parameter, specify if the Friendly display format should be used. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UseTodayAsDefaultValue</maml:name> <maml:description> <maml:para>Boolean parameter, specify if use Today's date as the default value. This is an optional parameter, if not specified, the value is set to $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListDateTimeField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the column Style. Possible values: DateOnly - Date Only DateTime - Date & Time This is an optional parameter. The default value is DateOnly if not specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue>DateOnly</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FriendlyDisplay</maml:name> <maml:description> <maml:para>Boolean parameter, specify if the Friendly display format should be used. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UseTodayAsDefaultValue</maml:name> <maml:description> <maml:para>Boolean parameter, specify if use Today's date as the default value. This is an optional parameter, if not specified, the value is set to $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the column Style. Possible values: DateOnly - Date Only DateTime - Date & Time This is an optional parameter. The default value is DateOnly if not specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>DateOnly</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FriendlyDisplay</maml:name> <maml:description> <maml:para>Boolean parameter, specify if the Friendly display format should be used. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UseTodayAsDefaultValue</maml:name> <maml:description> <maml:para>Boolean parameter, specify if use Today's date as the default value. This is an optional parameter, if not specified, the value is set to $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "Birthday"; FieldDisplayName = "Birthday"; FieldDescription = "please select your birthday"; Style = "DateTime"; Required = $true } $NewField = New-SPListDateTimeField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListId = "d44bbd14-b98b-478e-8997-e6deb002dd18"; FieldName = "Birthday"; FieldDisplayName = "Birthday"; FieldDescription = "please select your birthday"; Style = "DateOnly"; FriendlyDisplay = $true; Required = $true; EnforceUniqueValues = $true } $NewField = New-SPListDateTimeField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "StartTime"; FieldDisplayName = "StartTime"; FieldDescription = "please select the Start time"; Style = "DateTime"; FriendlyDisplay = $true; UseTodayAsDefaultValue = $true; Required = $true } $NewField = New-SPListDateTimeField @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListHyperLinkField</command:name> <maml:description> <maml:para>Create a new Hyperlink or Picture Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListHyperLinkField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new Hyperlink or Picture Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListHyperLinkField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the field Style. Possible values: Hyperlink - Create a hyperlink field Picture - Create a picture field This is an optional parameter. The default value is Hyperlink if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para> Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListHyperLinkField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the field Style. Possible values: Hyperlink - Create a hyperlink field Picture - Create a picture field This is an optional parameter. The default value is Hyperlink if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para> Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListHyperLinkField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the field Style. Possible values: Hyperlink - Create a hyperlink field Picture - Create a picture field This is an optional parameter. The default value is Hyperlink if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para> Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListHyperLinkField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the field Style. Possible values: Hyperlink - Create a hyperlink field Picture - Create a picture field This is an optional parameter. The default value is Hyperlink if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para> Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Style</maml:name> <maml:description> <maml:para>Specify the field Style. Possible values: Hyperlink - Create a hyperlink field Picture - Create a picture field This is an optional parameter. The default value is Hyperlink if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para> Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "URL"; FieldDisplayName = "URL"; FieldDescription = "please enter your URL"; Required = $true } $NewField = New-SPListHyperlinkField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListId = "d44bbd14-b98b-478e-8997-e6deb002dd18"; FieldName = "Photo"; FieldDisplayName = "Photo"; FieldDescription = "please specify your photo URL"; Style = "Picture" FriendlyDisplay = $true Required = $true } $NewField = New-SPListHyperlinkField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "URL"; FieldDisplayName = "URL"; FieldDescription = "please enter your URL"; Required = $true } $NewField = New-SPListHyperlinkField @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListLookupField</command:name> <maml:description> <maml:para>Create a new lookup Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListLookupField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new lookup Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListLookupField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceListId</maml:name> <maml:description> <maml:para>Specify the source list of where the field is getting the information from. This is an optional parameter, when not specified, it will get information from the own list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RelationshipDeleteBehavior</maml:name> <maml:description> <maml:para>Specify the relationship delete behavior. possible value: None - if the Field in the actual list is deleted; then all other lists which are referring that Field will be orphaned. Restrict - when deleting the Field from the list, SharePoint will restrict to delete unless all the data with lookup references are removed first. Cascade - when deleting the Field from the list, then SharePoint will delete all the referenced data where ever this Field is used as lookup Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowField</maml:name> <maml:description> <maml:para>Specify the field to show for the Field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalSourceFields</maml:name> <maml:description> <maml:para>An optional array parameter specifying titles of additional fields from the source list to be added to the list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListLookupField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceListId</maml:name> <maml:description> <maml:para>Specify the source list of where the field is getting the information from. This is an optional parameter, when not specified, it will get information from the own list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RelationshipDeleteBehavior</maml:name> <maml:description> <maml:para>Specify the relationship delete behavior. possible value: None - if the Field in the actual list is deleted; then all other lists which are referring that Field will be orphaned. Restrict - when deleting the Field from the list, SharePoint will restrict to delete unless all the data with lookup references are removed first. Cascade - when deleting the Field from the list, then SharePoint will delete all the referenced data where ever this Field is used as lookup Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowField</maml:name> <maml:description> <maml:para>Specify the field to show for the Field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalSourceFields</maml:name> <maml:description> <maml:para>An optional array parameter specifying titles of additional fields from the source list to be added to the list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListLookupField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceListId</maml:name> <maml:description> <maml:para>Specify the source list of where the field is getting the information from. This is an optional parameter, when not specified, it will get information from the own list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RelationshipDeleteBehavior</maml:name> <maml:description> <maml:para>Specify the relationship delete behavior. possible value: None - if the Field in the actual list is deleted; then all other lists which are referring that Field will be orphaned. Restrict - when deleting the Field from the list, SharePoint will restrict to delete unless all the data with lookup references are removed first. Cascade - when deleting the Field from the list, then SharePoint will delete all the referenced data where ever this Field is used as lookup Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowField</maml:name> <maml:description> <maml:para>Specify the field to show for the Field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalSourceFields</maml:name> <maml:description> <maml:para>An optional array parameter specifying titles of additional fields from the source list to be added to the list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListLookupField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceListId</maml:name> <maml:description> <maml:para>Specify the source list of where the field is getting the information from. This is an optional parameter, when not specified, it will get information from the own list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RelationshipDeleteBehavior</maml:name> <maml:description> <maml:para>Specify the relationship delete behavior. possible value: None - if the Field in the actual list is deleted; then all other lists which are referring that Field will be orphaned. Restrict - when deleting the Field from the list, SharePoint will restrict to delete unless all the data with lookup references are removed first. Cascade - when deleting the Field from the list, then SharePoint will delete all the referenced data where ever this Field is used as lookup Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowField</maml:name> <maml:description> <maml:para>Specify the field to show for the Field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalSourceFields</maml:name> <maml:description> <maml:para>An optional array parameter specifying titles of additional fields from the source list to be added to the list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceListId</maml:name> <maml:description> <maml:para>Specify the source list of where the field is getting the information from. This is an optional parameter, when not specified, it will get information from the own list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RelationshipDeleteBehavior</maml:name> <maml:description> <maml:para>Specify the relationship delete behavior. possible value: None - if the Field in the actual list is deleted; then all other lists which are referring that Field will be orphaned. Restrict - when deleting the Field from the list, SharePoint will restrict to delete unless all the data with lookup references are removed first. Cascade - when deleting the Field from the list, then SharePoint will delete all the referenced data where ever this Field is used as lookup Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowField</maml:name> <maml:description> <maml:para>Specify the field to show for the Field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalSourceFields</maml:name> <maml:description> <maml:para>An optional array parameter specifying titles of additional fields from the source list to be added to the list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "TestLookup"; FieldDisplayName = "Test Lookup Field"; FieldDescription = "please specify the value"; ShowField = 'Title' Required = $true } $NewField = New-SPListLookupField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> $parms = @{ SPConnection = $SPConnection; ListId = "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96"; FieldName = "TestLookup"; FieldDisplayName = "Test Lookup Field"; FieldDescription = "please specify the value"; Required = $true; AddToDefaultView = $true; ShowField = 'Title' } $NewField = New-SPListLookupField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $SourceList = Get-SPList -Credential $MyPSCred -SiteUrl "https://yourcompany.sharepoint.com" -IsSharePointOnlineSite $true -ListTitle "App Packages" $SourceListId = $SourceList.Id $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "TestLookup"; FieldDisplayName = "Test Lookup Field"; FieldDescription = "please specify the value"; SourceListId = $SourceListId; ShowField= 'Title' RelationshipDeleteBehavior = 'Cascade'; Required = $true } $NewField = New-SPListLookupField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id and individual SharePoint connection parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListMultiLineTextField</command:name> <maml:description> <maml:para>Create a new Multi-line text Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListMultiLineTextField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new Multi-line text Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListMultiLineTextField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumberOfLines</maml:name> <maml:description> <maml:para>Specify the number of lines for this multi-line Field. this is an optional parameter, if not specified, the default value is 6</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>6</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichText</maml:name> <maml:description> <maml:para>Boolean parameter, specify if Field is used for rich text content. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichTextMode</maml:name> <maml:description> <maml:para> Specify the type of rich text for this Field. possible values: Compatible - Rich text (Bold, italics, text alignment, hyperlinks) FullHtml - Enhanced rich text (Rich text with pictures, tables, and hyperlinks) This field is only required when the 'RichText' parameter is set to $true</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListMultiLineTextField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumberOfLines</maml:name> <maml:description> <maml:para>Specify the number of lines for this multi-line Field. this is an optional parameter, if not specified, the default value is 6</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>6</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichText</maml:name> <maml:description> <maml:para>Boolean parameter, specify if Field is used for rich text content. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichTextMode</maml:name> <maml:description> <maml:para> Specify the type of rich text for this Field. possible values: Compatible - Rich text (Bold, italics, text alignment, hyperlinks) FullHtml - Enhanced rich text (Rich text with pictures, tables, and hyperlinks) This field is only required when the 'RichText' parameter is set to $true</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListMultiLineTextField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumberOfLines</maml:name> <maml:description> <maml:para>Specify the number of lines for this multi-line Field. this is an optional parameter, if not specified, the default value is 6</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>6</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichText</maml:name> <maml:description> <maml:para>Boolean parameter, specify if Field is used for rich text content. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichTextMode</maml:name> <maml:description> <maml:para> Specify the type of rich text for this Field. possible values: Compatible - Rich text (Bold, italics, text alignment, hyperlinks) FullHtml - Enhanced rich text (Rich text with pictures, tables, and hyperlinks) This field is only required when the 'RichText' parameter is set to $true</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListMultiLineTextField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumberOfLines</maml:name> <maml:description> <maml:para>Specify the number of lines for this multi-line Field. this is an optional parameter, if not specified, the default value is 6</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>6</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichText</maml:name> <maml:description> <maml:para>Boolean parameter, specify if Field is used for rich text content. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichTextMode</maml:name> <maml:description> <maml:para> Specify the type of rich text for this Field. possible values: Compatible - Rich text (Bold, italics, text alignment, hyperlinks) FullHtml - Enhanced rich text (Rich text with pictures, tables, and hyperlinks) This field is only required when the 'RichText' parameter is set to $true</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NumberOfLines</maml:name> <maml:description> <maml:para>Specify the number of lines for this multi-line Field. this is an optional parameter, if not specified, the default value is 6</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>6</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichText</maml:name> <maml:description> <maml:para>Boolean parameter, specify if Field is used for rich text content. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RichTextMode</maml:name> <maml:description> <maml:para> Specify the type of rich text for this Field. possible values: Compatible - Rich text (Bold, italics, text alignment, hyperlinks) FullHtml - Enhanced rich text (Rich text with pictures, tables, and hyperlinks) This field is only required when the 'RichText' parameter is set to $true</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "FirstName"; FieldDisplayName = "First Name"; FieldDescription = "please specify the first name of the employee"; Required = $true } $NewField = New-SPListMultiLineTextField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListId = "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96"; FieldName = "FirstName"; FieldDisplayName = "First Name"; FieldDescription = "please specify the first name of the employee"; Required = $true; AddToDefaultView = $false; EnforceUniqueValues = $true; DefaultValue = 'John' } $NewField = New-SPListMultiLineTextField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "FirstName"; FieldDisplayName = "First Name"; FieldDescription = "please specify the first name of the employee"; Required = $true; DefaultValue = 'John' } $NewField = New-SPListMultiLineTextField @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListNumberField</command:name> <maml:description> <maml:para>Create a new number Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListNumberField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new number Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListNumberField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="min"> <maml:name>Minimum</maml:name> <maml:description> <maml:para>Specify the minimum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="max"> <maml:name>Maximum</maml:name> <maml:description> <maml:para>Specify the maximum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="decimal"> <maml:name>DecimalPlaces</maml:name> <maml:description> <maml:para>Specify the number of decimal places for this Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Percentage</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be be shown as percentage. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListNumberField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="min"> <maml:name>Minimum</maml:name> <maml:description> <maml:para>Specify the minimum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="max"> <maml:name>Maximum</maml:name> <maml:description> <maml:para>Specify the maximum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="decimal"> <maml:name>DecimalPlaces</maml:name> <maml:description> <maml:para>Specify the number of decimal places for this Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Percentage</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be be shown as percentage. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListNumberField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="min"> <maml:name>Minimum</maml:name> <maml:description> <maml:para>Specify the minimum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="max"> <maml:name>Maximum</maml:name> <maml:description> <maml:para>Specify the maximum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="decimal"> <maml:name>DecimalPlaces</maml:name> <maml:description> <maml:para>Specify the number of decimal places for this Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Percentage</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be be shown as percentage. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListNumberField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="min"> <maml:name>Minimum</maml:name> <maml:description> <maml:para>Specify the minimum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="max"> <maml:name>Maximum</maml:name> <maml:description> <maml:para>Specify the maximum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="decimal"> <maml:name>DecimalPlaces</maml:name> <maml:description> <maml:para>Specify the number of decimal places for this Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Percentage</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be be shown as percentage. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="min"> <maml:name>Minimum</maml:name> <maml:description> <maml:para>Specify the minimum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="max"> <maml:name>Maximum</maml:name> <maml:description> <maml:para>Specify the maximum value of the number Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="decimal"> <maml:name>DecimalPlaces</maml:name> <maml:description> <maml:para>Specify the number of decimal places for this Field. this is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Percentage</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be be shown as percentage. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "Year"; FieldDisplayName = "Year"; FieldDescription = "please specify the year"; Required = $true } $NewField = New-SPListNumberField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "InterestRate"; FieldDisplayName = "Interest Rate"; FieldDescription = "please specify the interest rate"; Required = $true; EnforceUniqueValues = $true; DecimalPlaces = 2; Percentage=$true; Minimum = 0.01; Maximum = 0.2 } $NewField = New-SPListNumberField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "Price"; FieldDisplayName = "Price"; FieldDescription = "please specify the price"; Required = $true; DecimalPlaces = 2; DefaultValue = 1 } $NewField = New-SPListNumberField @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListPersonField</command:name> <maml:description> <maml:para>Create a new Person or Group Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListPersonField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new Person or Group Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListPersonField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserSelectionMode</maml:name> <maml:description> <maml:para>Specify the user selection mode. Possible values: PeopleAndGroups - allows both user and group values PeopleOnly - only allows user values This is an optional parameter. The default value is PeopleAndGroup if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>PeopleAndGroup</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="UserSelectionScope , From"> <maml:name>FromGroupId</maml:name> <maml:description> <maml:para>Specify the group ID of where the user/group will be chosen from. This is an optional parameter, when not specified, it will be chosen from All Users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AllowMultiple</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field allows selecting multiple users/groups. this is an optional parameter, the default value is $false if not specified. This parameter must be set to $false if 'EnforceUniqueValues' is set to $true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListPersonField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserSelectionMode</maml:name> <maml:description> <maml:para>Specify the user selection mode. Possible values: PeopleAndGroups - allows both user and group values PeopleOnly - only allows user values This is an optional parameter. The default value is PeopleAndGroup if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>PeopleAndGroup</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="UserSelectionScope , From"> <maml:name>FromGroupId</maml:name> <maml:description> <maml:para>Specify the group ID of where the user/group will be chosen from. This is an optional parameter, when not specified, it will be chosen from All Users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AllowMultiple</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field allows selecting multiple users/groups. this is an optional parameter, the default value is $false if not specified. This parameter must be set to $false if 'EnforceUniqueValues' is set to $true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListPersonField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserSelectionMode</maml:name> <maml:description> <maml:para>Specify the user selection mode. Possible values: PeopleAndGroups - allows both user and group values PeopleOnly - only allows user values This is an optional parameter. The default value is PeopleAndGroup if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>PeopleAndGroup</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="UserSelectionScope , From"> <maml:name>FromGroupId</maml:name> <maml:description> <maml:para>Specify the group ID of where the user/group will be chosen from. This is an optional parameter, when not specified, it will be chosen from All Users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AllowMultiple</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field allows selecting multiple users/groups. this is an optional parameter, the default value is $false if not specified. This parameter must be set to $false if 'EnforceUniqueValues' is set to $true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListPersonField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserSelectionMode</maml:name> <maml:description> <maml:para>Specify the user selection mode. Possible values: PeopleAndGroups - allows both user and group values PeopleOnly - only allows user values This is an optional parameter. The default value is PeopleAndGroup if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>PeopleAndGroup</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="UserSelectionScope , From"> <maml:name>FromGroupId</maml:name> <maml:description> <maml:para>Specify the group ID of where the user/group will be chosen from. This is an optional parameter, when not specified, it will be chosen from All Users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AllowMultiple</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field allows selecting multiple users/groups. this is an optional parameter, the default value is $false if not specified. This parameter must be set to $false if 'EnforceUniqueValues' is set to $true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserSelectionMode</maml:name> <maml:description> <maml:para>Specify the user selection mode. Possible values: PeopleAndGroups - allows both user and group values PeopleOnly - only allows user values This is an optional parameter. The default value is PeopleAndGroup if not specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PeopleAndGroup</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="UserSelectionScope , From"> <maml:name>FromGroupId</maml:name> <maml:description> <maml:para>Specify the group ID of where the user/group will be chosen from. This is an optional parameter, when not specified, it will be chosen from All Users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AllowMultiple</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field allows selecting multiple users/groups. this is an optional parameter, the default value is $false if not specified. This parameter must be set to $false if 'EnforceUniqueValues' is set to $true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "URL"; FieldDisplayName = "URL"; FieldDescription = "please enter your URL"; Required = $true } $NewField = New-SPListPersonField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a person / group Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Group = $SPGroup = Get-SPGroup -SPConnection $SPConnection -GroupTitle "Test Group" $GroupId = $Group.Id $parms = @{ SPConnection = $SPConnection; ListId = "d44bbd14-b98b-478e-8997-e6deb002dd18"; FieldName = "Photo"; FieldDisplayName = "Photo"; FieldDescription = "please specify your photo URL"; Style = "Picture" FriendlyDisplay = $true FromGroupId = $GroupId Required = $true } $NewField = New-SPListPersonField @parms -verbose</dev:code> <dev:remarks> <maml:para>Add a person / group Field by providing the list Id and limit to a group</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "URL"; FieldDisplayName = "URL"; FieldDescription = "please enter your URL"; Required = $true; EnforceUniqueValues = $true } $NewField = New-SPListPersonField @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPListSingleLineTextField</command:name> <maml:description> <maml:para>Create a new single line text Field for a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPListSingleLineTextField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new single line text Field for a SharePoint list. A boolean value of $true is returned when the Field has been successfully created, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPListSingleLineTextField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaxLength</maml:name> <maml:description> <maml:para>Specify the maximum number of characters for this Field. this is an optional parameter, if not specified, the default value is 255</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>255</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListSingleLineTextField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaxLength</maml:name> <maml:description> <maml:para>Specify the maximum number of characters for this Field. this is an optional parameter, if not specified, the default value is 255</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>255</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListSingleLineTextField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaxLength</maml:name> <maml:description> <maml:para>Specify the maximum number of characters for this Field. this is an optional parameter, if not specified, the default value is 255</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>255</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPListSingleLineTextField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaxLength</maml:name> <maml:description> <maml:para>Specify the maximum number of characters for this Field. this is an optional parameter, if not specified, the default value is 255</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>255</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDisplayName"> <maml:name>FieldDisplayName</maml:name> <maml:description> <maml:para>The display name of the lookup Field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnDescription"> <maml:name>FieldDescription</maml:name> <maml:description> <maml:para>The description of the lookup Field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Required</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field is a required Field.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MaxLength</maml:name> <maml:description> <maml:para>Specify the maximum number of characters for this Field. this is an optional parameter, if not specified, the default value is 255</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>255</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should be added to the default view. this is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="unique"> <maml:name>EnforceUniqueValues</maml:name> <maml:description> <maml:para>Boolean parameter, specify if this Field should enforce unique values. this is an optional parameter, the default value is $false if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DefaultValue</maml:name> <maml:description> <maml:para>Specify the default value the Field. This is an optional parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the edit form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the new form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Specify the if this field should be shown in the display form. This is an optional parameter, the default value is $true if not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListTitle = "Test List"; FieldName = "FirstName"; FieldDisplayName = "First Name"; FieldDescription = "please specify the first name of the employee"; Required = $true } $NewField = New-SPListSingleLineTextField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$parms = @{ SPConnection = $SPConnection; ListId = "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96"; FieldName = "FirstName"; FieldDisplayName = "First Name"; FieldDescription = "please specify the first name of the employee"; Required = $true; AddToDefaultView = $false; EnforceUniqueValues = $true; DefaultValue = 'John' } $NewField = New-SPListSingleLineTextField @parms</dev:code> <dev:remarks> <maml:para>Add a lookup Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; ListTitle = "Test List"; FieldName = "FirstName"; FieldDisplayName = "First Name"; FieldDescription = "please specify the first name of the employee"; Required = $true; DefaultValue = 'John' } $NewField = New-SPListSingleLineTextField @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>New-SPSubSite</command:name> <maml:description> <maml:para>Create a new SharePoint sub site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SPSubSite</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Create a new SharePoint sub site. A 'Microsoft.SharePoint.Client.Site' object is returned when the site has been successfully created, otherwise, an exception is thrown.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SPSubSite</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewSiteTitle</maml:name> <maml:description> <maml:para>The title of the new sub site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewSiteUrlLeaf</maml:name> <maml:description> <maml:para>the URL leaf name of the new site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSiteDescription</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TemplateName"> <maml:name>NewSiteTemplateName</maml:name> <maml:description> <maml:para>The template type of the new site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TemplateLocale , Locale"> <maml:name>NewSiteTemplateLocale</maml:name> <maml:description> <maml:para>The locale of the template type of the new site. This is a optional parameter, the default value is 'en-us' if not specified. Use PowerShell cmdlet Get-Culture to get the current culture of the computer, or use "[System.Globalization.CultureInfo]::GetCultures("AllCultures")" to get all possible values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SPSubSite</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RootSiteURL"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Root Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewSiteTitle</maml:name> <maml:description> <maml:para>The title of the new sub site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewSiteUrlLeaf</maml:name> <maml:description> <maml:para>the URL leaf name of the new site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSiteDescription</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TemplateName"> <maml:name>NewSiteTemplateName</maml:name> <maml:description> <maml:para>The template type of the new site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TemplateLocale , Locale"> <maml:name>NewSiteTemplateLocale</maml:name> <maml:description> <maml:para>The locale of the template type of the new site. This is a optional parameter, the default value is 'en-us' if not specified. Use PowerShell cmdlet Get-Culture to get the current culture of the computer, or use "[System.Globalization.CultureInfo]::GetCultures("AllCultures")" to get all possible values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewSiteTitle</maml:name> <maml:description> <maml:para>The title of the new sub site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewSiteUrlLeaf</maml:name> <maml:description> <maml:para>the URL leaf name of the new site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewSiteDescription</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TemplateName"> <maml:name>NewSiteTemplateName</maml:name> <maml:description> <maml:para>The template type of the new site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TemplateLocale , Locale"> <maml:name>NewSiteTemplateLocale</maml:name> <maml:description> <maml:para>The locale of the template type of the new site. This is a optional parameter, the default value is 'en-us' if not specified. Use PowerShell cmdlet Get-Culture to get the current culture of the computer, or use "[System.Globalization.CultureInfo]::GetCultures("AllCultures")" to get all possible values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RootSiteURL"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Root Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Site </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SiteTemplate = Get-SPSiteTemplate -SPConnection $SPConnection -TemplateTitle 'Team Site' -TemplateLocale 'en-us' $SiteTemplateName = $SiteTemplate.Name $NewSite = New-SPSubSite -SPConnection $SPConnection -NewSiteTitle "Test Team Site #1" -NewSiteUrl "TestTeamSite1" -NewSiteDescription "Description for the new site" -NewSiteTemplateName $SiteTemplateName</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $SiteTemplate = Get-SPSiteTemplate -SPConnection $SPConnection -TemplateTitle 'Team Site' -TemplateLocale 'en-us' $SiteTemplateName = $SiteTemplate.Name $parms = @{ SiteUrl = "https://yourcompany.sharepoint.com"; Credential = $MyPSCred; IsSharePointOnlineSite = $true; NewSiteTitle = "Test Team Site #1"; NewSiteUrl = "TestTeamSite1"; NewSiteTemplateName = $SiteTemplateName } $NewSite = New-SPSubSite @parms -verbose</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Remove-SPGroupMember</command:name> <maml:description> <maml:para>Remove an user from a SharePoint group.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPGroupMember</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Remove an user from a SharePoint group. A boolean value of $true returned when the user has been successfully removed, otherwise, an exception is thrown and $false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Remove"> <maml:name>RemoveUserName</maml:name> <maml:description> <maml:para>The username of the user to be removed to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Remove"> <maml:name>RemoveUserName</maml:name> <maml:description> <maml:para>The username of the user to be removed to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Remove"> <maml:name>RemoveUserName</maml:name> <maml:description> <maml:para>The username of the user to be removed to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Remove"> <maml:name>RemoveUserName</maml:name> <maml:description> <maml:para>The username of the user to be removed to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The Id of the Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Remove"> <maml:name>RemoveUserName</maml:name> <maml:description> <maml:para>The username of the user to be removed to the SharePoint group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupTitle</maml:name> <maml:description> <maml:para>Name of the Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$RemoveUser = Remove-SPGroupMember -SPConnection $SPConnection -GroupTitle "Test Group" -RemoveUserName "domain\UserID"</dev:code> <dev:remarks> <maml:para>Remove the user by providing the group title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$RemoveUser = Remove-SPGroupMember -SPConnection $SPConnection -GroupId 5 -RemoveUserName "domain\UserID"</dev:code> <dev:remarks> <maml:para>Remove the user by providing the group Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $RemoveUser = Remove-SPGroupMember -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -GroupTitle "Test Group" -RemoveUserName "firstname.lastname@yourcompany.com"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Remove-SPList</command:name> <maml:description> <maml:para>Remove a list from the SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPList</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Remove a list from the SharePoint site. A boolean value of $true is returned when the list has been successfully removed, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$RemoveList = Remove-SPList -SPConnection $SPConnection -ListTitle "Test List"</dev:code> <dev:remarks> <maml:para>Removing the list by title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SPList -SPConnection $SPConnection -ListId "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96"</dev:code> <dev:remarks> <maml:para>Removing the list by Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $RemoveList = Remove-SPList -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListTitle "Test List"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Remove-SPListField</command:name> <maml:description> <maml:para>Remove a Field from a SharePoint list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPListField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Remove a Field from a SharePoint list. A boolean value of $true is returned when the Field has been successfully removed, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SPListField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPListField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPListField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPListField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$RemoveListField = Remove-SPListField -SPConnection $SPConnection -ListTitle "Test List" -FieldName "TestField"</dev:code> <dev:remarks> <maml:para>Removing the Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$RemoveListField = Remove-SPListField -SPConnection $SPConnection -ListId "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96" -FieldName "TestField"</dev:code> <dev:remarks> <maml:para>Removing the Field by providing the list ID</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $RemoveListField = Remove-SPListField -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListTitle "Test List" -FieldName "TestField"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Remove-SPListFieldFromDefaultView</command:name> <maml:description> <maml:para>Remove a SharePoint list field to the list default view.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPListFieldFromDefaultView</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Remove a SharePoint list field to the list default view.. A boolean value of $true is returned if the operation is successful, otherwise, an exception is thrown and $false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SPListFieldFromDefaultView</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPListFieldFromDefaultView</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPListFieldFromDefaultView</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPListFieldFromDefaultView</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnInternalName"> <maml:name>FieldInternalName</maml:name> <maml:description> <maml:para>The internal name of the field that to be added to the default view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list to be retrieved</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$ListFields = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" $LastNameField = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" | Where-Object {$_.Title -eq 'Last Name'} $RemoveFromDefaultView = Remove-SPListFieldFromDefaultView -SPConnection $SPConnection -ListTitle "Test List" -FieldInternalName $LastNameField.InternalName</dev:code> <dev:remarks> <maml:para>Removing field "Last Name" from the default view by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$ListFields = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" $LastNameField = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" | Where-Object {$_.Title -eq 'Last Name'} $RemoveFromDefaultView = Remove-SPListFieldFromDefaultView -SPConnection $SPConnection -ListId "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96" -FieldInternalName $LastNameField.InternalName</dev:code> <dev:remarks> <maml:para>Removing field "Last Name" from the default view by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $ListFields = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" $LastNameField = Get-SPListFields -SPConnection $SPConnection -ListName "Test List" | Where-Object {$_.Title -eq 'Last Name'} $RemoveFromDefaultView = Remove-SPListFieldFromDefaultView -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListTitle "Test List" -FieldInternalName $LastNameField.InternalName </dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Remove-SPListItem</command:name> <maml:description> <maml:para>Delete a list item to the SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPListItem</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Delete a list item to the SharePoint site.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$DeleteListItem = Remove-SPListItem -SPConnection $SPConnection -ListName "Test List" -ListItemID 1</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $DeleteListItem = Remove-SPListItem -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSPO $true -ListName "Test List" -ListItemID 1</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Remove-SPListItemAttachment</command:name> <maml:description> <maml:para>Remove a SharePoint list item attachment.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPListItemAttachment</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Remove a SharePoint list item attachment. Please note this function DOES NOT work on SharePoint 2010 sites.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SPListItemAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Path"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name of the attachment to be removed from the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPListItemAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Path"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name of the attachment to be removed from the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Path"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name of the attachment to be removed from the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$DeleteAttachment = Remove-SPListItemAttachment -SPConnection $SPConnection -ListName "Test List" -ListItemID 1 -FileName "File.txt"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $DeleteAttachment = Remove-SPListItemAttachment -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSPO $true -ListName "Test List" -ListItemID 1 -FileName "File.txt"</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Remove-SPSubSite</command:name> <maml:description> <maml:para>Delete a SharePoint sub site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SPSubSite</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Delete a SharePoint sub site. A 'Microsoft.SharePoint.Client.Site' object is returned when the site has been successfully created, otherwise, an exception is thrown.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SPSubSite</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubSiteURL</maml:name> <maml:description> <maml:para>The URL of the sub site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SPSubSite</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RootSiteURL"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Root Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubSiteURL</maml:name> <maml:description> <maml:para>The URL of the sub site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubSiteURL</maml:name> <maml:description> <maml:para>The URL of the sub site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RootSiteURL"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Root Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SubSites = get-SPSubSite -SiteUrl $SiteUrl -Credential $credential -IsSharePointOnlineSite $true Remove-SPSubSite -SiteUrl $SiteUrl -Credential $credential -IsSharePointOnlineSite $true -SubSiteURL $SubSites[0].Url</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SubSites = get-SPSubSite -SPConnection $SPConnection $DeleteSite = Remove-SPSubSite -SPConnection $SPConnection -SubSiteURL $SubSites[0].Url</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Set-SPListFieldVisibility</command:name> <maml:description> <maml:para>Set the visibility of a SharePoint list field.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SPListFieldVisibility</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Set the visibility of a SharePoint list field.. A boolean value of $true is returned when the Field has been successfully updated, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Set-SPListFieldVisibility</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the new form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the edit form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the display form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPListFieldVisibility</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the new form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the edit form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the display form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPListFieldVisibility</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the new form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the edit form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the display form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SPListFieldVisibility</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the new form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the edit form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the display form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInEditForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the new form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInNewForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the edit form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ShowInDisplayForm</maml:name> <maml:description> <maml:para>Boolean parameter, specify the if this field should be shown in the display form.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Fields = get-SPListFields -SPConnection $SPConnection -ListName "Test List" -Verbose $Field = $Fields | where-Object {$_.Title -eq 'Last Name'} $FieldTitle = $Field.Title $SetFieldVisibility = Set-SPListFieldVisibility -SPConnection $SPConnection -ListTitle "Test List" -FieldName $FieldTitle -ShowInNewForm $false</dev:code> <dev:remarks> <maml:para>Updating the display name of the "Last Name" Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Fields = get-SPListFields -SPConnection $SPConnection -ListName "Test List" -Verbose $Field = $Fields | where-Object {$_.Title -eq 'Last Name'} $FieldTitle = $Field.Title $SetFieldVisibility = Set-SPListFieldVisibility -SPConnection $SPConnection -ListId "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96" -FieldName $FieldTitle -ShowInEditForm $false -verbose</dev:code> <dev:remarks> <maml:para>Updating the display name of the "Last Name" Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $Fields = get-SPListFields -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListName "Test List" $Field = $Fields | where-Object {$_.Title -eq 'Last Name'} $FieldTitle = $Field.Title $SetFieldVisibility = Set-SPListFieldVisibility -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListTitle "Test List" -FieldName $FieldTitle -ShowInEditForm $false -ShowInDisplayForm $true</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Update-SPListField</command:name> <maml:description> <maml:para>Update a SharePoint list field.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>SPListField</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Update a SharePoint list field. A boolean value of $true is returned when the Field has been successfully updated, otherwise, an exception is thrown and boolean value false is returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Update-SPListField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="schema"> <maml:name>SchemaXML</maml:name> <maml:description> <maml:para>The updated field schema XML</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SPListField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="schema"> <maml:name>SchemaXML</maml:name> <maml:description> <maml:para>The updated field schema XML</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SPListField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="schema"> <maml:name>SchemaXML</maml:name> <maml:description> <maml:para>The updated field schema XML</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SPListField</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="schema"> <maml:name>SchemaXML</maml:name> <maml:description> <maml:para>The updated field schema XML</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListId</maml:name> <maml:description> <maml:para>The Id of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ColumnName , ColumnTitle , FieldTitle"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The name / title of the Field to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="schema"> <maml:name>SchemaXML</maml:name> <maml:description> <maml:para>The updated field schema XML</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListTitle</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Fields = get-SPListFields -SPConnection $SPConnection -ListName "Test List" -Verbose $Field = $Fields | where-Object {$_.Title -eq 'Last Name'} $FieldTitle = $Field.Title $SchemaXML = [XML]$Field.SchemaXml $SchemaXML.Field.DisplayName = "Surname" $UpdatedSchema = $SchemaXML.InnerXml $UpdateField = Update-SPListField -SPConnection $SPConnection -ListTitle "Test List" -FieldName $FieldTitle -SchemaXML $UpdatedSchema</dev:code> <dev:remarks> <maml:para>Updating the display name of the "Last Name" Field by providing the list title</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Fields = get-SPListFields -SPConnection $SPConnection -ListName "Test List" -Verbose $Field = $Fields | where-Object {$_.Title -eq 'Last Name'} $FieldTitle = $Field.Title $SchemaXML = [XML]$Field.SchemaXml $SchemaXML.Field.DisplayName = "Surname" $UpdatedSchema = $SchemaXML.InnerXml $UpdateField = Update-SPListField -SPConnection $SPConnection -ListId "7df1bdf8-5305-4fc5-ba78-c0bf766cdf96" -FieldName $FieldTitle -SchemaXML $UpdatedSchema -verbose</dev:code> <dev:remarks> <maml:para>Updating the display name of the "Last Name" Field by providing the list Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $Fields = get-SPListFields -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListName "Test List" $Field = $Fields | where-Object {$_.Title -eq 'Last Name'} $FieldTitle = $Field.Title $SchemaXML = [XML]$Field.SchemaXml $SchemaXML.Field.DisplayName = "Surname" $UpdatedSchema = $SchemaXML.InnerXml $UpdateField = Update-SPListField -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -FieldName $FieldTitle -SchemaXML $UpdatedSchema</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Update-SPListItem</command:name> <maml:description> <maml:para>Update a list item to the SharePoint site.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>SPListItem</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Update a list item to the SharePoint site.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Update-SPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListFieldsValues</maml:name> <maml:description> <maml:para>A hash table containing List item that to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListFieldsValues</maml:name> <maml:description> <maml:para>A hash table containing List item that to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SPConnection</maml:name> <maml:description> <maml:para>SharePointSDK Connection object (SMA / Azure Automation connection or hash table).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListName</maml:name> <maml:description> <maml:para>Name of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListItemID</maml:name> <maml:description> <maml:para>The ID of the item to be deleted</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ListFieldsValues</maml:name> <maml:description> <maml:para>A hash table containing List item that to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>SharePoint Site Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cred"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The PSCredential object that contains the user name and password required to connect to the SharePoint site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IsSPO"> <maml:name>IsSharePointOnlineSite</maml:name> <maml:description> <maml:para>Specify if the site is a SharePoint Online site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$HashTableListFieldsValues= @{ Title = "List Item Title"; Description = "List Item Description Text" } $UpdateListItem = Update-SPListItem -SPConnection $SPConnection -ListName "Test List" -ListItemID 1 -ListFieldsValues $HashTableListFieldsValues</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$HashTableListFieldsValues= @{ Title = "List Item Title"; Description = "List Item Description Text" } $Username = "you@yourcompany.com" $SecurePassword = ConvertTo-SecureString "password1234" -AsPlainText -Force $MyPSCred = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword) $UpdateListItem = Update-SPListItem -SiteUrl "https://yourcompany.sharepoint.com" -Credential $MyPSCred -IsSharePointOnlineSite $true -ListName "Test List" -ListItemID 1 -ListFieldsValues $HashTableListFieldsValues </dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16--> <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> </helpItems> |