SharePoint 框架解决方案的租户范围内解决方案部署

可以将 SharePoint 框架 (SPFx) 组件配置为,在解决方案包安装到租户应用程序目录时,立即可用于整个租户。 可以使用 ./config/package-solution.json 文件中的 skipFeatureDeployment 属性,对此进行配置。

如果解决方案启用此属性,租户管理员就可以将解决方案启用为,在解决方案包安装到租户应用程序目录时,自动可用于租户中的所有网站集和网站。

也可以通过在 Microsoft 365 平台社区 (PnP) YouTube 频道上观看以下视频来查看租户范围的部署选项:

注意

必须更新到最新版本的 SharePoint 框架 Yeoman 模板才能使用此功能。 可以通过执行 **npm install -g @microsoft/generator-sharepoint**来更新全局安装。

租户范围部署在 SPFx 1.4 版中发布,可用于开发将在 SharePoint 2019 和 SharePoint Online 上部署的 Web 部件。 此部署选项不适用于 SharePoint 2016 功能包 2,因为它仅支持 SPFx 1.1。

如果你用的是低于 1.4 版的 SPFx Web 部件,可以通过 适用于 Microsoft 365 的 CLI 按照说明进行升级。

特定于解决方案的要求

使用此选项时,将忽略 SharePoint Framework 解决方案中的任何功能框架定义。 如果解决方案包含功能框架定义,例如用于创建自定义列表,则不应使用此解决方案特定的选项。

有关详细信息,请参阅使用解决方案包预配 SharePoint 资产

注意

配置为在租户内自动进行部署的解决方案在站点级别的加载项应用功能中不可见。

将解决方案配置为在租户内可用

SharePoint 框架 Yeoman 模板将询问与此选项相关的具体问题。 此问题将直接影响 package-solution.json 文件中的 skipFeatureDeployment 属性。

关于部署租户选项的 Yeoman 问题

在下面的示例配置中,skipFeatureDeployment 设置为 true,指明可以在整个租户内集中部署解决方案。

{
  "solution": {
    "name": "tenant-deploy-client-side-solution",
    "id": "dd4feca4-6f7e-47f1-a0e2-97de8890e3fa",
    "version": "1.0.0.0",
    "skipFeatureDeployment": true,
    "features": [
      {
        "title": "Application Extension - Deployment of custom action.",
        "description": "Deploys a custom action with ClientSideComponentId association",
        "id": "54f0dc0e-c190-439d-933b-2dd2809ed3c3",
        "version": "1.0.0.0",
        "assets": {
          "elementManifests": [
            "elements.xml",
            "ClientSideInstance.xml"
          ]
        }
      }
    ]
  },
  "paths": {
    "zippedPackage": "solution/tenant-deploy-true.sppkg"
  }
}

批准通过租户范围内部署将应用部署到应用程序目录

如果将 skipFeatureDeployment 属性设置为 true 的解决方案已部署到租户应用程序目录,管理员可以将解决方案配置为在整个租户内集中部署。

默认情况下,“让此解决方案可供组织中的所有网站使用”复选框处于取消选中状态。 如果管理员选中此复选框,解决方案中的组件将在租户内自动可见和可用。

将解决方案部署到应用程序目录时,将显示“使此解决方案在组织的所有站点中可用”设置

请注意,由于仅在使用功能框架时,解决方案和网站专用升级操作才可用,因此没有适用于集中部署的解决方案的特定升级选项。 若要更新这些解决方案,可以更新 CDN 中的解决方案专用资产,并更新和部署应用程序目录中的包。 这会自动将整个租户内的所有现有组件实例更新为,使用最新组件资产(如 JavaScript 文件和更新后的 CSS 文件)。

警告

对于包含站点扩展的解决方案包,只有在最初激活站点扩展时才需要选中“使此解决方案在组织的所有站点中可用”复选框。 更新现有解决方案包时,在部署期间选中该复选框可能会在 “租户范围扩展 ”列表中创建重复条目。

SharePoint 网站上的客户端 Web 部件可见性

在经典和新式页面的 Web 部件选取器中,集中部署的解决方案中包含的 Web 部件均会立即显示。

包含扩展的 skipFeatureDeployment 设置的影响

SharePoint 框架扩展将立即在 SharePoint 网站中可用。 这意味着它们可与特定 SharePoint 元素(例如,字段用户自定义操作)中的 ClientSideComponentId 属性相关联。

另外,如果管理员在部署过程中选中“使此解决方案在组织的所有站点中可用”复选框,解决方案包中的自动化设置可能会在应用程序目录上的“租户范围扩展”列表中创建项。 此列表中的条目管理站点扩展的租户范围激活。 在 ./config/package-solution.json 中引用的 ClientSideInstance.xml 文件对自动化设置进行了说明。

有关详细信息,请参阅 SharePoint 框架扩展的租户范围部署

另请参阅