使用 PowerShell 更新 SharePoint Online 中的现代 Web 部件属性

要求：使用 PowerShell 更新 SharePoint Online 中的现代 Web 部件属性。

用于更新 Web 部件属性的 PnP PowerShell

PnP PowerShell 是本机 SharePoint PowerShell 模块的扩展。它提供了一个 PowerShell 命令库，可以简化 SharePoint 中复杂的脚本编写任务，从而更轻松地管理 SharePoint Online 环境。无论是操作 Web 部件、管理网站集还是自动化部署流程，PnP PowerShell 都是 SharePoint 专业人员的首选工具。

让我们使用 PnP PowerShell 更新“People”Web 部件属性。步骤如下：

1. 连接到您的 SharePoint 网站：首先使用 Connect-PnPOnline cmdlet 连接到您的 SharePoint Online 网站。
2. 检索目标页面：获取Web部件所在的页面。将 $PageName 替换为您的页面名称。
3. 识别 Web 部件：找到您要更新的 Web 部件。这个过程可能需要一些探索。使用 $page.Controls 列出所有 Web 部件，并通过其标题或其他属性识别您感兴趣的部件。
4. 更新 Web 部件属性：识别 Web 部件后，更新其属性。以下是如何更改特定属性的示例：

#Parameters
$SiteURL = "https://crescent.sharepoint.com/sites/Retail"
$PageName = "Welcome.aspx"
$WebPartTitle = "People" # Not the web part title, but name

#Connect to SharePoint Online
Connect-PnPOnline -Url $SiteURL -Interactive

#Get the Page
$Page = Get-PnPPage -Identity $PageName

#Get the Web Part to update
$webPart = $Page.Controls | Where-Object {$_.Title -eq $WebPartTitle}

#Frame JSON to update
$PeopleData="[{`"id`":`"[email protected]`"},{`"id`":`"[email protected]`"}]"
$jsonPorperty='{"layout":1,"persons":'+$PeopleData+'}'

#Update Web Part properties
Set-PnPPageWebPart -Page $PageName -Identity $webPart.InstanceId -PropertiesJson $jsonPorperty

提示：要获取目标 Web 部件属性 JSON 格式，请使用：$webPart.PropertiesJson。

在 SharePoint Online 中使用 PnP PowerShell 更新 Web 部件属性可以节省时间并确保整个 SharePoint 环境的一致性。通过这些步骤，您可以有效地管理 SharePoint Online 页面上的 Web 部件。请记住，确切的属性和值取决于 Web 部件的类型及其配置，因此请始终定制脚本以满足您的特定需求。

这是我关于向新式页面添加和设置 Web 部件的另一篇文章：如何将 Web 部件添加到 SharePoint Online 中的新式页面？