如何使用 PnP PowerShell 检查 SharePoint Online 列表中是否存在字段？

最近，我需要检查 SharePoint 列表中是否存在列。我没有手动检查，而是使用 PowerShell。在本教程中，我将向您展示如何使用 PnP PowerShell 检查 SharePoint Online 列表中是否存在字段。相同的脚本也适用于文档库。

使用 PnP PowerShell 检查 SharePoint Online 列表中是否存在字段

在这里，我将向您展示两种使用 PowerShell 检查 SharePoint Online 列表中是否存在字段的方法。

在这里，我创建了一个名为“EmployeeRecords”的 SharePoint Online 列表，我们想要检查名为“EmployeeID”的字段是否存在。您可以看到如下所示的列表和列：

方法 1：使用 Get-PnPField

Get-PnPField cmdlet 从指定的 SharePoint Online 列表中检索字段。您可以使用它来检查某个字段是否存在，方法是尝试使用此 PnP PowerShell cmdlet 按名称检索该字段。

这是完整的 PnP PowerShell 脚本。

Connect-PnPOnline -Url "https://szg52.sharepoint.com/sites/PowerShellFAQs" -Interactive
$listName = "EmployeeRecords"
$fieldName = "EmployeeID"

try {
    $field = Get-PnPField -List $listName -Identity $fieldName
    if ($field) {
        Write-Output "Field 'EmployeeID' exists in the list 'EmployeeRecords'."
    }
} catch {
    Write-Output "Field 'EmployeeID' does not exist in the list 'EmployeeRecords'."
}

执行上述 PowerShell 脚本后，您可以在下面的屏幕截图中看到它显示的确切输出。由于该列存在，它会显示一条消息“字段‘EmployeeID’存在于列表‘EmployeeRecords’中。”。

这是使用 PnP PowerShell 检查 SharePoint Online 列表中是否存在字段的最佳方法之一。

查看使用 PnP PowerShell 获取 SharePoint Online 中的所有列表字段

方法 2：使用 Get-PnPList 和 Fields 属性

让我向您展示另一种方法来检查 SharePoint Online 列表中是否存在字段。我将向您展示如何使用 Get-PnPList cmdlet 和字段属性来检查该字段是否存在于 SharePoint Online 列表中。

Connect-PnPOnline -Url "https://szg52.sharepoint.com/sites/PowerShellFAQs" -Interactive
$listName = "EmployeeRecords"
$fieldName = "EmployeeID"

# Get the list
$list = Get-PnPList -Identity $listName

# Load the fields collection
$ctx = Get-PnPContext
$ctx.Load($list.Fields)
$ctx.ExecuteQuery()

# Check if the field exists
$fieldExists = $list.Fields | Where-Object { $_.InternalName -eq $fieldName }

if ($fieldExists) {
    Write-Output "Field 'EmployeeID' exists in the list 'EmployeeRecords'."
} else {
    Write-Output "Field 'EmployeeID' does not exist in the list 'EmployeeRecords'."
}

此脚本检索 SharePoint Online 列表并检查其 Fields 集合以查看是否存在具有指定内部名称的字段。我执行了上面的 PnP PowerShell 脚本，您可以在下面的屏幕截图中看到输出：

结论

使用 PnP PowerShell 检查 SharePoint Online 列表中是否存在字段可以通过 Get-PnPField cmdlet 或通过检查字段来高效完成列表的属性。我强烈建议使用 Get-PnPField PnP PowerShell 来检查 SharePoint Online 列表中是否存在某个字段。