通过

SharePoint Online 租户属性

  • 项目

租户属性允许租户管理员在应用程序目录中添加可使用 SharePoint REST API 读取的属性。

用于使用租户属性的选项

租户属性由租户管理员使用以下其中一个选项进行管理:

SharePoint REST API

在此处了解详细信息: SharePoint REST API

Microsoft SharePoint Online 命令行管理程序

租户属性由租户管理员使用 Microsoft SharePoint Online 命令行管理程序 进行管理，该管理程序为 Microsoft 的 PowerShell 模块，用于在 Office 365 中管理 SharePoint Online 订阅。

在使用 Microsoft SharePoint Online 命令行管理程序模块中的 cmdlet 之前，必须先使用 Connect-SPOService cmdlet 连接到 SharePoint Online。 所有租户属性都使用 *-SPOStorageEntity cmdlet 进行管理。

在此处了解详细信息: Microsoft SharePoint Online 命令行管理程序

PnP PowerShell

PnP PowerShell 的优点是无需租户管理员权限即可设置这些属性。 应用程序目录网站的“所有者”组中的任何成员都可以执行此操作。 这适用于租户应用程序目录网站和 网站集应用程序目录。

在使用 PnP PowerShell 模块中的 cmdlet 之前，必须先使用 Connect-PnPOnline cmdlet 连接到 SharePoint Online。 所有租户属性都使用 *-PnPStorageEntity cmdlet 进行管理。

在此处了解详细信息: PnP PowerShell

重要

可以使用 Connect-PnPOnline cmdlet 连接到任何网站。 当省略 -Scope 参数或将其设置为 Tenant(默认值)时，所有 cmdlet 都将应用于租户应用程序目录，无论你连接到哪个网站。 如果将 -Scope 参数设置为 Site，则所有 cmdlet 都将应用于已连接网站的网站集应用程序目录。

注意

PnP PowerShell 是一种开放源代码解决方案，其中包含为其提供支持的活动社区。 没有用于 Microsoft 开放源代码工具支持的 SLA。

Microsoft 365 专属 CLI

Microsoft 365 专属 CLI 可用于管理租户属性。 Microsoft 365 专属 CLI 为跨平台命令行接口，可用于 Windows、MacOS、Linux 等所有平台。

在使用 Microsoft 365 专属 CLI 的命令之前，必须先使用 m365 login 命令连接到 Microsoft 365 租户。 所有 SharePoint Online 租户属性都使用 spo storageentity 命令进行管理。

在此处了解详细信息: Microsoft 365 专属 CLI

重要

租户属性存储在与相应租户关联的应用程序目录网站中。 若要设置或删除属性，必须指定应用程序目录网站的绝对 URL。 如果指定的不是应用程序目录网站 URL，将会看到拒绝访问错误。

注意

CLI for Microsoft 365是一种开放源代码解决方案，其中包含为其提供支持的活动社区。 没有用于 Microsoft 开放源代码工具支持的 SLA。

列出租户属性

以下选项演示了如何从 SharePoint Online 列出租户属性。

请求

GET https://tenant.sharepoint.com/sites/site/_api/web/AllProperties?$select=storageentitiesindex

响应

HTTP/1.1 200 OK
Content-Type: application/json
{
  "key": {
    "Comment":"Tenant property comment.",
    "Description":"Tenant property description",
    "Value":"Tenant property key value"
  }
}

获取/读取租户属性

以下选项演示了如何从 SharePoint Online 获取租户属性。

请求

GET https://tenant.sharepoint.com/sites/site/_api/web/GetStorageEntity('key')

响应

HTTP/1.1 200 OK
Content-Type: application/json
{
  "Comment":"Tenant property comment.",
  "Description":"Tenant property description",
  "Value":"Tenant property key value"
}

设置/写入租户属性

以下选项演示了如何从 SharePoint Online 写入租户属性。

不支持

删除租户属性

以下选项演示了如何从 SharePoint Online 删除租户属性。

不支持

自定义脚本和网站集应用程序目录

仅允许在启用了自定义脚本的网站中的网站集应用程序目录上设置租户属性。 当尝试在“无脚本网站”中设置租户属性时，将显示以下错误:

Access denied. You do not have permission to perform this action or access this resource.

可以在此处了解有关自定义脚本的详细信息: 允许或阻止自定义脚本。

如果你不是网站的所有者或网站集管理员，错误消息也会显示。

另请参阅