创建和管理容器

适用于: 开发 人员

创建、注册并授权容器类型后,创建和管理容器。 容器是 SharePoint Embedded 中的基本存储单元。

在调用容器 API 之前完成 配置身份验证和授权

了解容器

所有 SharePoint Embedded 文件和文档都存储在容器中。

容器:

  • 属于消耗Microsoft 365 租户。
  • 具有不可变容器类型 ID。
  • 存储应用程序的内容。
  • 定义成员身份和权限的边界。
  • 通过 Microsoft Graph 访问。

有关体系结构概述,请参阅 SharePoint Embedded 应用体系结构

了解生命周期

典型的容器生命周期包括:

  1. 创建容器。
  2. 添加或确认成员。
  3. 上传和管理文件。
  4. 读取或更新容器元数据。
  5. 在容器不再处于活动状态时回收该容器。
  6. 在需要时还原已回收的容器。
  7. 在清理过程中永久删除容器。

继续 上传、下载和管理 内容操作的文件。

先决条件

创建容器之前,请确保:

  • 容器类型存在。
  • 容器类型已在使用租户中注册。
  • 应用已Microsoft Graph FileStorageContainer.Selected 同意。
  • 应用具有操作的容器类型权限。
  • 对于委托调用,已登录用户可以接收所需的容器角色。
  • 对于试用容器类型,你在试用限制内。

重要

试用容器类型最多可以创建五个容器,包括活动容器和回收站中的容器。

选择委托创建或仅应用创建

当用户启动创建、用户应负责或创建用户应成为容器所有者时,请使用委托访问权限。

当服务预配容器、不存在用户且应用有权创建容器时,请使用仅限应用的访问权限。

注意

通过委托调用创建新容器的用户将自动分配“所有者”角色。

创建容器

使用 Microsoft Graph 为已注册的容器类型创建文件存储容器。

有关规范 API 形状,请参阅 创建 fileStorageContainer

实现步骤:

  1. 获取有效的 Microsoft Graph 令牌。
  2. 包括 API 所需的目标容器类型信息。
  3. 发送创建请求。
  4. 存储返回的容器 ID。
  5. 存储应用所需的显示元数据。
  6. 为委派方案分配或确认成员身份。

提示

将容器 ID 存储在应用程序数据库中,作为业务对象与 SharePoint Embedded 容器之间的持久链接。

在 Visual Studio Code 中创建容器

对于试用开发,Visual Studio Code扩展可以创建容器。

  1. 打开 SharePoint Embedded 视图。

  2. 展开已注册的试用容器类型。

  3. 右键单击“ 容器”。

  4. 选择“ 创建容器”。

  5. 输入名称。

  6. 确认容器显示在容器类型下。

有关扩展流,请参阅 快速入门:使用 VS Code 生成第一个应用

列出容器

列出用于显示可用容器、验证预配或运行维护的容器。

有关规范 API 形状,请参阅 列出容器

列出容器时:

  • 对服务清单方案使用仅限应用的访问权限。
  • 仅当用户上下文合适时,才使用委托访问。
  • 处理分页。
  • 将结果映射到应用程序数据。

注意

如果用户没有 OneDrive, 403 Forbidden 则委托列表容器当前返回。 此依赖项不适用于仅应用列表调用。

获取容器

在操作前需要最新元数据时获取容器。

使用此操作可以确认容器是否存在、读取显示属性、验证容器类型、在文件操作之前检查状态,以及确认还原。

将实现链接到 fileStorageContainer 资源类型

更新容器元数据

在支持的属性更改时更新元数据。

更新之前:

  1. 确认应用具有容器类型 Write 权限。
  2. 确认委派用户具有适当的角色。
  3. 读取当前容器状态。
  4. 仅应用预期的更改。
  5. 验证响应。

删除或回收容器

当容器不再处于活动状态时,请使用删除行为。

删除前:

  • 确认调用方具有权限。
  • 确认应用已存档业务参考。
  • 确定是否应先回收容器。
  • 说明还原选项。

Visual Studio Code扩展包括用于试用开发的回收和恢复功能。

还原回收的容器

还原流应:

  1. 标识回收的容器。
  2. 确认调用方具有权限。
  3. 还原容器。
  4. 刷新应用程序状态。
  5. 确认文件和元数据可用。
  6. 通知用户。

重要

对于试用容器类型,回收站中的容器仍计入五个容器限制。

永久删除容器

仅当确定不再需要容器时才永久删除。

在删除容器类型本身之前,必须删除容器类型的所有容器,包括已删除的容器。

将永久删除用于试用清理、测试数据删除、停用容器类型或满足生命周期要求。

验证生命周期操作

创建冒烟测试:

  1. 创建测试容器。
  2. 按 ID 检索它。
  3. 列出容器并确认它出现。
  4. 更新支持的元数据值。
  5. 上传小文件。
  6. 回收或删除容器。
  7. 如果支持,请还原它。
  8. 在清理过程中永久删除它。

排查生命周期问题

症状 支票
创建失败 注册和 Create 权限。
委托创建失败 用户同意和角色分配行为。
委托用户的列表失败 身份验证文章中记录了 OneDrive 依赖项。
删除失败 Delete 权限和用户所有者角色。
试用创建失败 活动加回收容器可能已达到限制。
容器类型删除失败 必须先删除所有活动和已删除的容器。

后续步骤

上传、下载和管理文件中添加文件操作。