如何使用 PowerShell 或 PnP PowerShell 在 SharePoint Online 中创建列表？

在 SharePoint Online 中，我们创建列表和库来存储信息和文档。使用浏览器在 SharePoint 网站中创建列表很容易，但使用 PowerShell 创建 SharePoint 列表时有点不同。

在本教程中，我将解释如何使用 PowerShell 和 PnP PowerShell 在 SharePoint Online 中创建列表。

使用 PowerShell 在 SharePoint Online 中创建列表

在第一个示例中，我将向您展示如何使用 SharePoint 管理 shell 在 SharePoint Online 中创建列表。

以下是用于在 SharePoint 网站上创建名为“项目任务”的自定义列表的完整 PowerShell 脚本。

$siteUrl = "https://szg52.sharepoint.com/sites/PowerPlatformFAQs"
# Define Variables
$listTitle = "Project Tasks"
$listDescription = "A list to track project tasks."

$UserName = "[email protected]"
$Password = "Enter Your Password"
$SecurePassword= $Password | ConvertTo-SecureString -AsPlainText -Force
   
#Setup the Context
$Ctx = New-Object Microsoft.SharePoint.Client.ClientContext($siteUrl)
$Cred = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($UserName, $SecurePassword)
$Ctx.Credentials = $Cred

$web = $ctx.Web

# Create the list
$listCreationInfo = New-Object Microsoft.SharePoint.Client.ListCreationInformation
$listCreationInfo.Title = $listTitle
$listCreationInfo.TemplateType = [Microsoft.SharePoint.Client.ListTemplateType]::GenericList
$list = $web.Lists.Add($listCreationInfo)
$list.Description = $listDescription
$list.Update()
$ctx.ExecuteQuery()

我成功执行了上面的脚本；你可以看到下面：

脚本成功执行后，当您打开 SharePoint Online 网站时，您可以看到列表已成功创建。

查看使用 PnP PowerShell 从 SharePoint Online 列表创建、读取、更新和删除项目

使用 PowerShell 将列添加到 SharePoint 列表

让我使用 PowerShell 向您展示如何将列添加到 SharePoint 列表。

单行文本列

下面是 SharePoint 列表中单行文本列的代码。

# Add a single line of text column
$fieldXml = "<Field DisplayName='Task Name' InternalName='TaskName' Type='Text' />"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

如果您想要其他设置，可以更改脚本，如下所示：

# Add a single line of text column with additional settings
$fieldXml = "<Field DisplayName='Task Description' InternalName='TaskDescription' Type='Text' Required='TRUE' />"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

选择栏

下面是在 SharePoint Online 列表中创建选择列的代码。

# Add a choice column
$fieldXml = "<Field DisplayName='Priority' InternalName='Priority' Type='Choice' Format='Dropdown'>
                <CHOICES>
                    <CHOICE>High</CHOICE>
                    <CHOICE>Medium</CHOICE>
                    <CHOICE>Low</CHOICE>
                </CHOICES>
                <Default>Medium</Default>
             </Field>"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

对于选择列中的其他设置，您可以编写如下脚本：

# Add a choice column with additional settings
$fieldXml = "<Field DisplayName='Status' InternalName='Status' Type='Choice' Format='Dropdown' Required='TRUE'>
                <CHOICES>
                    <CHOICE>Not Started</CHOICE>
                    <CHOICE>In Progress</CHOICE>
                    <CHOICE>Completed</CHOICE>
                </CHOICES>
                <Default>Not Started</Default>
             </Field>"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

查看使用 PnP PowerShell 将选择列添加到 SharePoint Online 列表

是/否栏

以下是将“是/否”列添加到 SharePoint Online 列表的脚本。

# Add a yes/no column
$fieldXml = "<Field DisplayName='Completed' InternalName='Completed' Type='Boolean' />"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

个人或团体栏

以下是用于在 SharePoint Online 列表中创建人员或组列的 PowerShell 脚本。

# Add a person or group column
$fieldXml = "<Field DisplayName='Assigned To' InternalName='AssignedTo' Type='User' UserSelectionMode='PeopleAndGroups' />"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

下面是完整的 PowerShell 脚本，它将创建 SharePoint Online 列表并添加其他列。

$siteUrl = "https://szg52.sharepoint.com/sites/PowerPlatformFAQs"
# Define Variables
$listTitle = "Project Tasks"
$listDescription = "A list to track project tasks."

$UserName = "[email protected]"
$Password = "Enter Your Password"
$SecurePassword= $Password | ConvertTo-SecureString -AsPlainText -Force

# Create a new list
$ctx = New-Object Microsoft.SharePoint.Client.ClientContext($siteUrl)
$web = $ctx.Web

$listCreationInfo = New-Object Microsoft.SharePoint.Client.ListCreationInformation
$listCreationInfo.Title = $listTitle
$listCreationInfo.TemplateType = [Microsoft.SharePoint.Client.ListTemplateType]::GenericList
$list = $web.Lists.Add($listCreationInfo)
$list.Description = $listDescription
$list.Update()
$ctx.ExecuteQuery()

# Add a single line of text column
$fieldXml = "<Field DisplayName='Task Name' InternalName='TaskName' Type='Text' />"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

# Add a choice column
$fieldXml = "<Field DisplayName='Priority' InternalName='Priority' Type='Choice' Format='Dropdown'>
                <CHOICES>
                    <CHOICE>High</CHOICE>
                    <CHOICE>Medium</CHOICE>
                    <CHOICE>Low</CHOICE>
                </CHOICES>
                <Default>Medium</Default>
             </Field>"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

# Add a yes/no column
$fieldXml = "<Field DisplayName='Completed' InternalName='Completed' Type='Boolean' />"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

# Add a person or group column
$fieldXml = "<Field DisplayName='Assigned To' InternalName='AssignedTo' Type='User' UserSelectionMode='PeopleAndGroups' />"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

# Add a single line of text column with additional settings
$fieldXml = "<Field DisplayName='Task Description' InternalName='TaskDescription' Type='Text' Required='TRUE' />"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

# Add a choice column with additional settings
$fieldXml = "<Field DisplayName='Status' InternalName='Status' Type='Choice' Format='Dropdown' Required='TRUE'>
                <CHOICES>
                    <CHOICE>Not Started</CHOICE>
                    <CHOICE>In Progress</CHOICE>
                    <CHOICE>Completed</CHOICE>
                </CHOICES>
                <Default>Not Started</Default>
             </Field>"
$list.Fields.AddFieldAsXml($fieldXml, $true, [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint)
$ctx.ExecuteQuery()

# Disconnect from SharePoint Online
Disconnect-SPOService

这是在 SharePoint Online 中创建列表并向其添加其他列的方法。

阅读使用 PowerShell 和 PnP PowerShell 删除和恢复 SharePoint Online 网站

使用 PnP PowerShell 创建 SharePoint Online 列表

现在，让我向您展示如何使用 PnP PowerShell 创建 SharePoint Online 列表。

在 PnP PowerShell 中，您可以使用 New-PnPList cmdlet 在 SharePoint Online 网站上创建列表。

以下是完整的 PowerShell 脚本：

# Create a new list
$siteUrl = "https://szg52.sharepoint.com/sites/MarketingTeam"
Connect-PnPOnline -Url $siteUrl -Credentials (Get-Credential)

New-PnPList -Title "Marketing Tasks" -Template GenericList

执行上述 PowerShell 脚本后，您可以在下面的屏幕截图中看到输出：

现在，如果您打开 SharePoint 网站，您可以看到使用 PnP PowerShell 成功创建的列表。

这是使用 PnP PowerShell 在 SharePoint Online 网站中创建自定义列表的方法。

如果要将列添加到 SharePoint 列表，可以使用以下脚本。我已经解释了如何添加单行文本列、选择列、是/否列、人员或组列等。

# Add a single line of text column
Add-PnPField -List "Project Tasks" -DisplayName "Task Name" -InternalName "TaskName" -Type Text

# Add a choice column
Add-PnPField -List "Project Tasks" -DisplayName "Priority" -InternalName "Priority" -Type Choice -AddToDefaultView `
-Choices "High", "Medium", "Low" -DefaultValue "Medium"

# Add a yes/no column
Add-PnPField -List "Project Tasks" -DisplayName "Completed" -InternalName "Completed" -Type Boolean -AddToDefaultView

# Add a person or group column
Add-PnPField -List "Project Tasks" -DisplayName "Assigned To" -InternalName "AssignedTo" -Type User -AddToDefaultView

如果你想要一些额外的设置，你可以像下面这样写，这里我添加了一些属性，如 -Required、-DefaultValue 等。

# Add a single line of text column with additional settings
Add-PnPField -List "Project Tasks" -DisplayName "Task Description" -InternalName "TaskDescription" -Type Text `
-Required $true -AddToDefaultView

# Add a choice column with additional settings
Add-PnPField -List "Project Tasks" -DisplayName "Status" -InternalName "Status" -Type Choice -AddToDefaultView `
-Choices "Not Started", "In Progress", "Completed" -DefaultValue "Not Started" -Required $true

以下是完整的 PowerShell 脚本：

# Define Variables
$siteUrl = "https://szg52.sharepoint.com/sites/MarketingTeam"
$listTitle = "Project Tasks"

# Connect to SharePoint Online
Connect-PnPOnline -Url $siteUrl -Credentials (Get-Credential)

# Create a new list
New-PnPList -Title $listTitle -Template GenericList

# Add a single line of text column
Add-PnPField -List $listTitle -DisplayName "Task Name" -InternalName "TaskName" -Type Text -AddToDefaultView

# Add a choice column
Add-PnPField -List $listTitle -DisplayName "Priority" -InternalName "Priority" -Type Choice -AddToDefaultView `
-Choices "High", "Medium", "Low" -DefaultValue "Medium"

# Add a yes/no column
Add-PnPField -List $listTitle -DisplayName "Completed" -InternalName "Completed" -Type Boolean -AddToDefaultView

# Add a person or group column
Add-PnPField -List $listTitle -DisplayName "Assigned To" -InternalName "AssignedTo" -Type User -AddToDefaultView

# Add a single line of text column with additional settings
Add-PnPField -List $listTitle -DisplayName "Task Description" -InternalName "TaskDescription" -Type Text `
-Required $true -AddToDefaultView

# Add a choice column with additional settings
Add-PnPField -List $listTitle -DisplayName "Status" -InternalName "Status" -Type Choice -AddToDefaultView `
-Choices "Not Started", "In Progress", "Completed" -DefaultValue "Not Started" -Required $true

# Disconnect from SharePoint Online
Disconnect-PnPOnline

结论

当您想要在 SharePoint 生产环境中创建列表时，您主要使用 PowerShell 或 PnP PowerShell。在本教程中，我解释了如何使用 PowerShell 在 SharePoint Online 中创建列表和 PnP PowerShell。我还解释了如何使用 PnP PowerShell 和 PowerShell 将列添加到 SharePoint Online 列表。