网站模板 JSON 架构

项目
04/08/2023

网站模版是操作列表。对于更复杂的操作（如创建列表），还有子操作。每个操作都是由“谓词”值指定的。谓词操作按照在 JSON 脚本出现中的顺序运行。只能使用本文列出的谓词操作，否则会在尝试上传网站脚本时，导致“无法处理操作”错误抛出。我们将会陆续添加其他操作。

指定的整体 JSON 结构如下：

{
  "$schema": "schema.json",
  "actions": [
    ...
    <one or more verb actions>
    ...
  ],
  "bindata": { },
  "version": 1
}

提示

可以查看和引用如下的最新架构：https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json

注意

可以在网站上多次运行操作。在同一网站上使用相同参数重新运行操作将会更新现有架构并且不会出现架构重复。

addContentTypesFromHub

使用addContentTypesFromHub 谓词将内容类型从内容类型中心同步到网站。

注意

在网站上应用addContentTypesFromHub后，列表上的addContentType子操作将能够按名称将其添加到列表中。

JSON 值

ids: 需要同步的内容类型 ID 的数组。

示例

{
  "verb": "addContentTypesFromHub",
  "ids": ["0x01007CE30DD1206047728BAFD1C39A850120"]
}

新建 SharePoint 列表

使用 createSPList 谓词新建 SharePoint 列表。

注意

在网站上应用 createSPList 后，运行具有相同列表名称的 createSPList 将会更新现有列表。

JSON 值

listName：列表的名称。

templateType：向列表应用的模板。通常使用值 100。虽然 SPListTemplateType 枚举中收录了模板类型值的完整列表，但目前支持的值包括：

列表模板名称	枚举
泛型列表	100
文档库	101
调查	102
链接	103
公告	104
联系人	105
事件	106
任务	107
讨论板	108
图片库	109
网页	119
问题跟踪	1100

如果使用 101 或 119 并引用默认名称（“文档”或“网页”），可以修改随模板一起创建的库。请参阅下面的示例。

subactions：一组按列出的顺序运行以创建列表的操作。

示例

{
  "verb": "createSPList",
  "listName": "Customer Tracking",
  "templateType": 100,
  "subactions": [
    {
      "verb": "setDescription",
      "description": "List of Customers and Orders"
    }
  ]
},
{
  "verb": "createSPList",
  "listName": "Documents",
  "templateType": 101,
  "subactions": [
    {
      "verb": "setDescription",
      "description": "This is a modified default document library"
    }
  ]
}

子操作数组提供了其他操作，可用于指定如何构造列表。此外，子操作也使用 verb 值指定。

setDescription

设置列表的说明。

JSON 值

description：新列表的说明。

示例

{
  "verb": "setDescription",
  "description": "List of Customers and Orders"
}

addSPField

添加新字段。

JSON 值

fieldType：可以将字段类型设置为“Text”、“Note”、“Number”、“Boolean”、“User”或“DateTime”。有关其他数据类型，请参阅 addSPFieldXml 操作。
displayName：字段的显示名称。
id：可选属性。如果提供，则指定字段的 ID。它需要是一个唯一的、随机生成的 GUID。建议为此字段提供值，以确保重新运行脚本时不会多次添加该字段。
internalName：可选属性。如果提供，则指定字段的内部名称。如果未提供，内部名称将基于显示名称。
isRequired：如果此字段为必填以包含信息，则为 True；否则为 False。
addToDefaultView：如果要将字段添加到默认视图，则为 True，否则为 False。
enforceUnique：默认为 False 的可选属性。如果为 True，此字段的所有值必须都是唯一的。

示例

{
  "verb": "addSPField",
  "fieldType": "Text",
  "displayName": "Customer Name",
  "isRequired": false,
  "id": "c532fcb9-cdb3-45c6-8247-c784dcd58e1a",
  "addToDefaultView": true
}

deleteSPField

删除选定模板类型提供的默认字段。

JSON 值

displayName：标识要删除的字段的显示名称。

示例

{
  "verb": "deleteSPField",
  "displayName": "Modified"
}

addSPFieldXml

使用协作应用程序标记语言 (CAML) 启用定义字段及其元素。有关参考，请参阅 Field 元素 (Field)。要防止在脚本多次运行时多次创建字段，在字段 schemaXml 中提供 ID 属性很重要。

暂无法将这些字段构造指定为网站列，也无法将它们添加到内容类型中。若要使用 Field XML 创建网站列，请使用 createSiteColumnXml 操作。

JSON 值

schemaXml：用于定义字段的 CAML 块。
addToDefaultView：如果要将字段添加到默认视图，则为 True，否则为 False。

示例

{
  "verb": "addSPFieldXml",
  "schemaXml": "<Field ID=\"{596cbd92-36e3-40cc-a910-0f53468ce5e4}\" Type=\"Choice\" DisplayName=\"Project Category\" Required=\"FALSE\" Format=\"Dropdown\" StaticName=\"ProjectCategory\" Name=\"ProjectCategory\"><Default>Operations</Default><CHOICES><CHOICE>Operations</CHOICE><CHOICE>IT</CHOICE><CHOICE>Legal</CHOICE><CHOICE>Engineering</CHOICE></CHOICES></Field>"
}

addSPLookupFieldXml

允许使用协作应用程序标记语言 (CAML) 定义查阅字段及其依赖列表元素。有关参考，请参阅 Field 元素 (Field)。要防止在脚本多次运行时多次创建字段，在字段 schemaXml 中提供 ID 属性很重要。

JSON 值

schemaXml：用于定义字段的 CAML 块。
targetListName：用于标识此查阅字段要引用的列表的名称。请提供此值或 targetListUrl。
targetListUrl：用于标识此查阅字段要引用的列表的 Web 相对 URL。请提供此值或 targetListName。
addToDefaultView：如果要将字段添加到默认视图，则为 True，否则为 False。

示例

{
  "verb": "addSPLookupFieldXml",
  "schemaXml": "<Field Type=\"Lookup\" DisplayName=\"Contoso Project Category\" Required=\"FALSE\" EnforceUniqueValues=\"FALSE\" ShowField=\"Title\" UnlimitedLengthInDocumentLibrary=\"FALSE\" RelationshipDeleteBehavior=\"None\" ID=\"{101f1f89-d667-4c7f-9ebc-76cb5831d0a2}\" StaticName=\"ContosoProjectCategory\" Name=\"ContosoProjectCategory\" />",
  "targetListName": "Contoso Project Master"
}

addSiteColumn

用于将之前定义的网站栏直接添加到列表（现有列表或通过网站脚本创建的新列表）的子操作。

JSON 值

internalName：要添加的网站栏的内部名称。
addToDefaultView：默认为 False 的可选属性。如果 为 True，则新添加的字段也将添加到默认视图。

示例

 {
  "verb": "addSiteColumn",
  "internalName": "siteColumnUser",
  "addToDefaultView": true
 }

addSPView

定义视图并将其添加到列表。使用此操作指定所需的列以及想要如何显示列表项（使用 CAML 查询）。通过操作属性，你可以指定行限制、视图是否分页以及嵌套文件夹中的递归项。此外，你还可以将构造的视图指定为默认视图。

JSON 值

name：视图的名称。
viewFields：视图中字段的内部名称的数组。
query：包含视图查询的 where 子句的 CAML 查询字符串。请参阅 CAML 架构。
rowLimit：视图的行限制。
isPaged：指定视图是否分页。
makeDefault：如果为 True，视图将被设置为列表的默认视图，否则为 False。
scope：用于指定视图范围的可选设置。有关更多信息，请参阅 SPViewScope 枚举。
formatterJSON：指定该视图的 JSON 格式的可选设置。

示例

{
  "verb": "addSPView",
  "name": "Contoso Projects by Category",
  "viewFields":
  [
    "ID",
    "Title",
    "siteColumnUser",
    "ProjectCategory"
  ],
  "query": "<OrderBy><FieldRef Name=\"ProjectCategory\" /><FieldRef Name=\"siteColumnUser\" Ascending=\"FALSE\" /></OrderBy>",
  "rowLimit": 100,
  "isPaged": true,
  "makeDefault": true
}

removeSPView

从列表中删除视图。此操作还可用于删除网站模板应用的视图。

JSON 值

name：要删除的视图的名称。

示例

{
  "verb": "removeSPView",
  "name": "All Items"
}

addContentType

将内容类型添加到列表。当前，这些仅限于网站模板中包含的默认内容类型，或者使用 createContentType 操作在脚本中定义的内容类型。

注意

当前，我们不支持添加企业内容类型。

JSON 值

name：要添加的内容类型的名称。

示例

{
  "verb": "addContentType",
  "name": "name"
}

removeContentType

删除选定模板类型提供的内容类型。

JSON 值

name：要删除的内容类型的名称。

示例

{
  "verb": "removeContentType",
  "name": "name"
}

setSPFieldCustomFormatter

设置字段的列格式。有关详细信息，请参阅使用列格式自定义 SharePoint。

JSON 值

fieldDisplayName：要对其执行操作的字段的显示名称。
formatterJSON：要用作字段 CustomFormatter 的 JSON 对象。

示例

此示例将把数字列格式化为数据栏。

{
  "verb": "setSPFieldCustomFormatter",
  "fieldDisplayName": "Effort (days)",
  "formatterJSON":
  {
    "debugMode": true,
    "elmType": "div",
    "txtContent": "@currentField",
    "attributes": {
      "class": "sp-field-dataBars"
    },
    "style": {
      "width": {
        "operator": "?",
        "operands": [
          {
            "operator": ">",
            "operands": ["@currentField", "20"]
          },
          "100%",
          {
            "operator": "+",
              "operands": [
                {
                  "operator": "toString()",
                  "operands": [
                    {
                      "operator": "*",
                      "operands": ["@currentField",5]
                    }
                  ]
                },
                "%"
              ]
          }
        ]
      }
    }
  }
}

associateFieldCustomizer

注册列表字段的字段扩展。有关这些客户端扩展的详细信息，请参阅生成字段定制器教程。

JSON 值

internalName：要对其执行操作的字段的内部名称。
clientSiteComponentId：应用目录中扩展的标识符 (GUID)。可在 manifest.json 文件或 elements.xml 文件中找到此属性值。
clientSiteComponentProperties：一个可选参数，可用于提供字段自定义工具扩展实例的属性。

示例

{
  "verb": "createSPList",
  "listName": "Custom List with Slider Extension",
  "templateType": 100,
  "subactions": [
    {
      "verb": "setDescription",
      "description": "Custom list to illustrate SharePoint site scripting"
    },
    {
      "verb": "addSPField",
      "fieldType": "Text",
      "displayName": "Text Field",
      "isRequired": false,
      "addToDefaultView": true
    },
    {
      "verb": "addSPField",
      "fieldType": "Number",
      "displayName": "Number Field",
      "internalName": "ElectricSlide",
      "addToDefaultView": true,
      "isRequired": true
    },
    {
      "verb": "associateFieldCustomizer",
      "internalName": "ElectricSlide",
      "clientSideComponentId": "35944670-3111-4482-b152-9e9d1sean9f7",
      "clientSideComponentProperties": "{\"sampleText\":\"Yes - added by a site template, what?\"}"
    }
  ]
}

associateListViewCommandSet

将 ListViewCommandSet 关联到列表

JSON 值

title：扩展的标题。
location：一个必需参数，用于指定显示命令的位置。选项包括：ClientSideExtension.ListViewCommandSet.ContextMenu 或 ClientSideExtension.ListViewCommandSet.CommandBar。
clientSideComponentId：应用程序目录中扩展的标识符 (GUID)。可在 manifest.json 文件或 elements.xml 文件中找到此属性值。
clientSideComponentProperties：一个可选参数，可用于提供扩展实例的属性。

示例

{
  "verb": "createSPList",
  "listName": "CustomList",
  "templateType": 100,
  "subactions": [
      {
        "verb": "setDescription",
        "description": "Custom list to illustrate SharePoint site scripting"
      },
      {
        "verb": "addSPField",
        "fieldType": "Text",
        "displayName": "Text Field",
        "isRequired": false,
        "addToDefaultView": true
      },
      {
        "verb": "addSPField",
        "fieldType": "Number",
        "displayName": "Number Field",
        "internalName": "ElectricSlide",
        "addToDefaultView": true,
        "isRequired": true
      },
      {
        "verb": "associateListViewCommandSet",
        "title": "HelloWorld",
        "location": "ClientSideExtension.ListViewCommandSet.CommandBar",
        "clientSideComponentId": "13234283-d6c2-408f-a9ef-31a920c8ae78",
        "clientSideComponentProperties": "{\"sampleText\":\"added by a site template\"}"
      }
  ]
}

setTitle

重命名列表。若要创建具有特定名称的新列表，请使用 CreateSPList 操作中的 listName 参数，而不是使用 setTitle。

注意

使用 setTitle 将重命名列表，以防止在重新应用站点模版时更新列表。

JSON 值

title：新列表的标题。

示例

{
  "verb": "setTitle",
  "title": "Customers and Orders"
}

定义新的网站栏

使用 createSiteColumn 谓词定义一个新的网站栏，然后可以直接或通过使用 addContentType 操作将其关联到列表。

JSON 值

fieldType：要添加的列的类型。支持的值（如 SPField）有 Text、Note、Number、Boolean、User 和 DateTime。有关其他数据类型，请参阅 addSPFieldXml 脚本操作。
internalName：网站栏的内部名称。
displayName：网站栏的显示名称。
isRequired：如果此字段为必填以包含信息，则为 True；否则为 False。
id：可选属性。如果提供，则指定字段的 ID。它需要是一个唯一的、随机生成的 GUID。建议为此字段提供值，以确保重新运行脚本时不会多次添加该字段。
group：用于指定列组的可选属性。
enforceUnique：默认为 False 的可选属性。如果为 True，此字段的所有值必须都是唯一的。

示例

{
  "verb": "createSiteColumn",
  "fieldType": "User",
  "internalName": "siteColumn4User",
  "displayName": "Project Owner",
  "isRequired": false,
  "id": "181c4370-cdae-471b-9499-730046e55b75"
}

使用 createSiteColumnXml 谓词为 createSiteColumn 不支持的复杂数据类型定义新网站列。然后，可以直接或通过使用 addContentType 操作将这些列关联到列表。要防止在脚本多次运行时多次创建字段，在字段 schemaXml 中提供 ID 属性很重要。

JSON 值

schemaXml：用于定义字段的 CAML 块。
pushChanges：指明是否应将此更改推送到已引用此字段的列表。默认值为 True。

示例

{
  "verb": "createSiteColumnXml",
  "schemaXml": "<Field ID=\"{82581bd1-356f-4206-8ff7-a3b6ad1f5553}\" Type=\"Choice\" DisplayName=\"Project Status\" Required=\"FALSE\" Format=\"Dropdown\" StaticName=\"ProjectStatus\" Name=\"ProjectStatus\"><Default>In Progress</Default><CHOICES><CHOICE>In Progress</CHOICE><CHOICE>In Review</CHOICE><CHOICE>Done</CHOICE><CHOICE>Has Issues</CHOICE></CHOICES></Field>"
}

定义新的内容类型

使用 createContentType 定义一个新的内容类型，然后使用 addContentType 操作将其关联到列表。

JSON 值

注意

引用内容类型 ID 时，只需要三个引用中的一个 - ID、parentName 或 parentId。

name：要创建的内容类型的名称。
description：内容类型的可选说明。
parentName：父内容类型的名称。
parentId：父内容类型的 ID。
id：内容类型的 ID。
hidden：指定内容类型是可见还是隐藏。
group：内容类型的组。
subactions：指定要在内容类型上运行的子操作。这些子操作用于指定要添加的网站栏。

示例

{
  "verb": "createContentType",
  "name": "Contoso Projects",
  "description": "custom list content type",
  "parentName": "Item",
  "hidden": false,
  "group": "Contoso",
  "subactions":
    [
      {
        "verb": "addSiteColumn",
        "internalName": "siteColumn1Text"
      },
      {
        "verb": "addSiteColumn",
        "internalName": "siteColumn2Number"
        },
      {
        "verb": "addSiteColumn",
        "internalName": "siteColumn3Note"
      }
    ]
}

addSiteColumn

用于将之前定义的网站栏直接添加到内容类型（现有类型的或通过网站脚本创建的新类型）的子操作。

JSON 值

internalName：要添加的网站栏的内部名称。

示例

 {
  "verb": "addSiteColumn",
  "internalName": "siteColumnUser"
 }

removeSiteColumn

用于从列表或内容类型中删除网站栏的子操作。

JSON 值

internalName：要删除的网站栏的内部名称。

示例

 {
  "verb": "removeSiteColumn",
  "internalName": "siteColumnUser"
 }

使用 addNavLink 谓词向网站快速启动或中心导航中添加新导航链接。

JSON 值

url：要添加的链接的 URL。
displayName：链接的显示名称。
navComponent：要向快速启动、中心或页脚中添加链接的组件。默认值为 QuickLaunch。
isWebRelative：如果为 Web 相对链接，值为 True；否则，值为 False。默认值为 False。
parentDisplayName：使用可选参数。如果你提供此参数，这个导航链接就会成为使用此 displayName 的导航链接的子级（子链接）。如果你同时提供了此参数和 parentUrl，它便会搜索同时都是这两个导航链接的子级的链接。
parentUrl：一个可选参数。如果你提供此参数，这个导航链接就会成为使用此 URL 的导航链接的子级（子链接）。如果你同时提供了此参数和 parentDisplayName，它便会搜索同时都是这两个导航链接的子级的链接。
isParentUrlWebRelative：一个可选参数。如果为 Web 相对链接，值为 True；否则，值为 False。默认值为 False。

示例

注意

如果添加指向嵌套网站项（如列表）的链接，请务必添加相对于根目录的路径引用。

{
  "verb": "addNavLink",
  "url": "/Customer Event Collateral",
  "displayName": "Event Collateral",
  "navComponent":"Hub",
  "isWebRelative": true
},
{
    "verb": "addNavLink",
    "url": "/Lists/Project Activities",
    "displayName": "Project Activities",
    "isWebRelative": true
    },
{
  "verb": "addNavLink",
  "url": "https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-overview",
  "displayName": "SharePoint Site Design Overview",
  "parentDisplayName": "Documents"
},
{
  "verb": "addNavLink",
  "url": "https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema#add-a-navigation-link",
  "displayName": "About Site Footer",
  "navComponent":"Footer"
},
{
  "verb": "addNavLink",
  "url": "",
  "displayName": "Linkless Heading",
  "isWebRelative": false
}

使用 removeNavLink 谓词从网站中删除导航链接。

JSON 值

url：要删除的链接的 URL。
displayName：链接的显示名称。
navComponent：要从快速启动、中心或页脚中删除链接的组件。默认值为 QuickLaunch。
isWebRelative：如果为 Web 相对链接，值为 True；否则，值为 False。

示例

注意

可使用此操作删除协作和通信网站模板添加的网站链接（例如，“主页”、“文档”、“页面”、“对话”）。

{
  "verb": "removeNavLink",
  "displayName": "Home",
  "isWebRelative": true
},
{
  "verb": "removeNavLink",
  "displayName": "Pages",
  "isWebRelative": true
},
{
  "verb": "removeNavLink",
  "displayName": "Conversations",
  "isWebRelative": true
},
{
  "verb": "removeNavLink",
  "url": "/_layouts/15/groupstatus.aspx?Target=TEAM",
  "displayName": "Teams",
  "isWebRelative": true
}

处理特殊字符

以英语以外的其他语言创建的网站可能包含特殊字符。使用 UTF-8 编码读取包含特殊字符的 JSON 内容。

Get-Content '<Folder_location_to_site_script>\site-script.json' -Raw -Encoding UTF8

应用主题

使用 applyTheme 谓词将自定义主题添加到网站。有关如何构造和上传这些主题的详细信息，请参阅 SharePoint 网站主题设置。该网站操作仅适用于应用自定义主题。若要应用我们产品内 SharePoint 主题之一，请将副本创建为自定义副本并引用该副本。

注意

对于频道网站，将自动阻止此操作。

JSON 值

themeName：要应用的主题的名称。

示例

{
  "verb": "applyTheme",
  "themeName": "Blue Yonder"
}

设置品牌属性

使用 setSiteBranding 谓词指定导航布局、页眉布局和页眉背景。

注意

设置导航布局仅适用于通信网站模板和中心导航。对于频道网站，将自动阻止此操作。

JSON 值

navigationLayout：将导航布局指定为“层叠”或“综合菜单”
headerLayout：将页眉布局指定为“标准”或“紧凑”
headerBackground：将页眉背景指定为“无”、“中性”、“柔”或“强”
showFooter：指定是否应显示网站页脚

示例

{
  "verb": "setSiteBranding",
  "navigationLayout": "Megamenu",
  "headerLayout": "Compact",
  "headerBackground": "Strong",
  "showFooter": true
}

设置网站徽标

使用 setSiteLogo 谓词指定网站徽标。

注意

此操作仅适用于通信网站模板 (68)。

JSON 值

url：要使用的徽标图像的 URL。

示例

{
  "verb": "setSiteLogo",
  "url": "/Customer Event Collateral/logo.jpg"
}

加入中心网站

注意

对于频道网站，将自动阻止此操作。

使用 joinHubSite 谓词将网站联接到指定中心网站。

JSON 值

hubSiteId：要加入到的中心网站的 ID。
name：指定中心网站的名称的可选字符串。

示例

注意

要获取 hubSiteId，请使用 Connect-PnPOnline cmdlet 登录到网站，然后运行：

$hubSiteName = "My Hub Site"
Get-PnPHubSite | Where-Object { $_.Title -eq $hubSiteName }

这将返回名为 $hubSiteName 的中心网站的相关信息。 HubSiteId 返回为 SiteId。

{
  "verb": "joinHubSite",
  "hubSiteId": "e337cc17-b355-45d2-8dd4-e056f1bcf6f6"
}

安装加载项或解决方案

使用 installSolution 操作从租户应用程序目录安装部署的加载项或 SharePoint 框架解决方案。

示例

注意

若要获取解决方案 ID，请使用 Connect-PnPOnline cmdlet 登录到网站，然后运行 Get-PnPApp。此操作会返回部署的解决方案的列表。对于多地理位置租户，请在每个地理位置设置解决方案后使用产品 ID。可通过将解决方案上载到应用目录或解决方案定义中来获取产品 ID。

{
  "verb": "installSolution",
  "id": "d40e4edc-a6da-4cd8-b82d-bba970976803"
}

注册扩展

使用 associateExtension 操作从租户应用程序目录注册部署的 SharePoint 框架扩展。

注意

有关如何创建和配置 SharePoint 框架扩展的更多详细信息，请参阅：SharePoint 框架扩展概述。

JSON 值

title：应用程序目录中扩展的标题。
location：用于指定扩展类型。如果用于创建命令，则命令的显示位置为 ;否则，应将其设置为 ClientSideExtension.ApplicationCustomizer。
clientSideComponentId：应用目录中扩展的标识符 (GUID)。可在 manifest.json 文件或 elements.xml 文件中找到此属性值。
clientSideComponentProperties：一个可选参数，可用于提供扩展实例的属性。
registrationId: 一个可选参数，用于指示要关联的扩展的列表类型 (如果是列表扩展)。
registrationType：一个可选参数，如果扩展与列表关联，则应指定该参数。
scope：指示扩展是否与 Web 或 Site 相关联。

示例

{
  "verb": "associateExtension",
  "title": "SPFXApplicationCustomizer Example",
  "location": "ClientSideExtension.ApplicationCustomizer",
  "clientSideComponentId": "40d64749-a6e5-4691-b440-1e32fb6sean5",
  "scope": "Web"
}

激活功能

使用 activateSPFeature 操作激活 SharePoint 功能。

JSON 值

featureId：用于激活的功能的 ID (GUID)。
scope：指示功能是否与 web 或 site 相关联。

示例

要启用允许创建事件列表的 Web 范围的功能（功能 ID 为 00bfea71-ec85-4903-972d-ebe475780106），请执行以下操作：

{
  "verb": "activateSPFeature",
  "featureId": "00bfea71-ec85-4903-972d-ebe475780106",
  "scope": "web"
}

触发流

使用 triggerFlow 谓词启动自定义流。

提示

从网站脚本调用Power Automate 一文中提供了端到端示例。

JSON 值

url：流的触发 URL。
name：流的名称。
parameters：一组要传递到流的可选参数。

示例

 {
  "verb": "triggerFlow",
  "url": "<A trigger URL of the Flow.>",
  "name": "Record and tweet site creation event",
  "parameters": {
    "event": "Microsoft Event",
    "product": "SharePoint"
  }
}

配置区域设置

注意

对于频道网站，将自动阻止此操作。

使用 setRegionalSettings 操作配置网站的区域设置 (/_layouts/15/regionalsetng.aspx)。

JSON 值

timeZone：指定时区的数字。有关允许值的列表，请参阅 SPRegsionalSettings.TimeZones
locale：指定区域性 LCID 的数字。有关允许值的列表，请参阅 Microsoft 区域设置 ID 值
sortOrder：指定排序顺序的数字。有关允许值的列表，请参阅 SPRegionalSettings.Collation
hourFormat：指定网站应使用 12 小时还是 24 小时时间格式。

示例

{
  "verb": "setRegionalSettings",
  "timeZone": 2, /* Greenwich Mean Time */
  "locale": 1050, /* Croatia */
  "sortOrder": 6, /* Croatian */
  "hourFormat": "24"
}

将用户（主体）添加到 SharePoint 组

注意

对于频道网站，将自动阻止此操作。

使用 addPrincipalToSPGroup 操作管理用户和组的添加以选择默认的 SharePoint 组。有关详细信息，请参阅了解 SharePoint 组。此操作可用于授权用户、安全组和 Microsoft 365 组。

JSON 值

principal：一个必需参数，用来指定要添加到 SharePoint 组的主体（用户或组）的名称。
group：一个必需参数，用来指定要添加主体的 SharePoint 组。

示例

注意

此操作当前仅支持访问者（权限级别：读取）、成员（权限级别：参与或编辑，具体取决于网站模板），和所有者（权限级别：完全控制）组。主体必须单独添加。

{
  "verb": "addPrincipalToSPGroup",
  "principal": "sean@contosotravel.onmicrosoft.com", /* user */
  "group": "Owners"
},
{
  "verb": "addPrincipalToSPGroup",
  "principal": "travelops", /* sg */
  "group": "Owners"
},
{
  "verb": "addPrincipalToSPGroup",
  "principal": "itexecutives", /* mail-enabled sg */
  "group": "Members"
},
{
  "verb": "addPrincipalToSPGroup",
  "principal": "Adventure@contosotravel.onmicrosoft.com", /* o365 group */
  "group": "Visitors"
}

管理来宾访问

注意

对于频道网站，将自动阻止此操作。

使用 setSiteExternalSharingCapability 操作管理来宾访问。有关详细信息，请参阅管理 SharePoint Online 环境的外部共享。

JSON 值

capability：一个必需参数，用来指定网站集共享选项。四个选项包括“Disabled”、“ExistingExternalUserSharingOnly”、“ExternalUserSharingOnly”和“ExternalUserAndGuestSharing”。

示例

{
  "verb": "setSiteExternalSharingCapability",
  "capability": "Disabled"
}

另请参阅

SharePoint 网站模板和网站脚本概述

通过

网站模板 JSON 架构

addContentTypesFromHub

JSON 值

示例

新建 SharePoint 列表

JSON 值

示例

setDescription

JSON 值

示例

addSPField

JSON 值

示例

deleteSPField

JSON 值

示例

addSPFieldXml

JSON 值

示例

addSPLookupFieldXml

JSON 值

示例

addSiteColumn

JSON 值

示例

addSPView

JSON 值

示例

removeSPView

JSON 值

示例

addContentType

JSON 值

示例

removeContentType

JSON 值

示例

setSPFieldCustomFormatter

JSON 值

示例

associateFieldCustomizer

JSON 值

示例

associateListViewCommandSet

JSON 值

示例

setTitle

JSON 值

示例

定义新的网站栏

JSON 值

示例

JSON 值

示例

定义新的内容类型

JSON 值

示例

addSiteColumn

JSON 值

示例

removeSiteColumn

JSON 值

示例

添加导航链接

JSON 值

示例

删除导航链接

JSON 值

示例

处理特殊字符

应用主题

JSON 值

示例

设置品牌属性

JSON 值

示例

设置网站徽标

JSON 值

示例