SharePoint Embedded Visual Studio Code扩展可帮助开发人员免费开始使用 SharePoint Embedded 应用程序开发。
重要
若要开始使用 SharePoint Embedded 进行生成，需要对 Microsoft 365 租户具有管理访问权限。 如果还没有租户，可以使用 Microsoft 365 开发人员计划获取自己的租户，Microsoft客户数字体验，或创建Microsoft 365 E3许可证的免费试用版。
安装 SharePoint Embedded for Visual Studio Code
- 在 Visual Studio Code 中打开一个新窗口，然后导航到活动栏上的“扩展”。
- 在“扩展”视图中搜索“SharePoint Embedded”。 还可以在 Visual Studio 市场中查看扩展。
- 选择 “安装” ，SharePoint Embedded 图标将显示在活动栏上。
- 如果已安装，请更新到最新版本（如果有）。
- 选择图标以打开 SharePoint Embedded 视图，并使用试用配置创建容器类型。
使用管理员凭据登录
若要使用该扩展，必须使用管理员帐户登录到 Microsoft 365 租户。
身份验证会在外部浏览器中打开一个新选项卡以授予权限
仔细查看请求的权限，然后在提示管理员同意的弹出窗口中选择“接受”
成功授权后，在要重定向到 VSCode 的对话框中选择“打开”：
使用试用配置创建容器类型
登录后，系统会提示使用 试用版配置创建容器类型。 使用容器类型，可以开始使用 SharePoint Embedded 调用 SharePoint Embedded API 并生成概念证明应用程序。 详细了解 容器类型。
- 选择“创建试用容器类型”
- 按照提示命名容器类型。 稍后可以更改容器类型名称。
注意
SharePoint Embedded for Visual Studio Code 目前仅支持具有试用版配置的容器类型。 必须使用 SharePoint Online PowerShell 模块创建具有标准或直通计费配置的其他容器类型。
创建Microsoft Entra ID应用
每个容器类型都归Microsoft Entra ID应用程序所有。 创建免费试用版容器类型时，第一步是创建新的或选择现有Microsoft Entra ID应用程序作为拥有应用程序。 可以指定新应用程序的名称，也可以选择现有应用程序之一。 详细了解 SharePoint Embedded 应用体系结构
- 按照提示为新的 Entra 应用程序命名，或选择现有的应用程序 ID：
注意
如果选择现有应用程序，扩展将更新该应用程序的配置设置，使其适用于 SharePoint Embedded 和此扩展。 不建议在生产应用程序上执行此作。
创建容器类型并配置应用程序后，可以在左侧导航栏中以树的形式查看本地租户注册。
注册容器类型
创建容器类型后，需要在本地租户上注册该容器类型。 详细了解容器类型 注册。
按照提示作，选择“VS Code”窗口右下角的“ 在本地租户上注册 ”
如果未看到提示，可以右键单击，
<container-type-name>然后从菜单中选择“ 注册 ”
授予权限
查看权限并按照提示授予管理员同意
此时会弹出一个外部浏览器窗口，供你登录并授予管理员同意
创建第一个容器
注册容器类型后，现在可以创建第一个容器。 只能创建五个容器类型的容器来上传和管理内容。
- 右键单击左侧导航栏中树中的“容器”下拉列表，然后选择“创建容器”
- 输入要创建的容器的名称
回收容器
还可以回收和恢复扩展中的容器。
加载示例应用
创建免费试用版容器类型后，可以使用扩展加载 SharePoint Embedded 示例应用程序之一，并使用Microsoft Entra ID应用程序和容器类型的详细信息自动填充运行时配置文件。
加载示例应用程序时，系统会通知你将创建纯文本机密以在本地计算机上进行身份验证。
如果在应用程序上找不到客户端密码，则会询问你是否要创建一个。 按“确定”继续。
重要
这不适用于生产环境。 在此处详细了解如何为生产环境设置应用程序注册。
使用示例应用
在终端中运行以下命令，这将启动示例应用程序，它由 2 个部分组成：
- React客户端应用程序 - 在端口 8080 上运行的前端用户界面
- Azure Function Application Server - 处理 SharePoint Embedded作的后端 API 服务器
# Navigate to your sample application directory
cd [your-path]\SharePoint-Embedded-Samples\Samples\spe-typescript-react-azurefunction
# Install dependencies and start the application
npm run start
注意
初始启动可能需要几分钟时间，因为安装了依赖项并生成了这两个应用程序。 在导航到应用程序之前，请等待这两个控制台输出出现。
这将安装依赖项并运行服务器和客户端应用程序，运行后，你将在终端中看到以下内容，之后可以导航到 http://localhost:8080 以访问应用程序。
成功运行两个应用程序后：
- 打开 Web 浏览器并导航到 http://localhost:8080
- 使用 Microsoft 365 管理员帐户 (VS Code 扩展) 中使用的同一帐户登录
- 在主页上，选择 “容器” 开始创建容器并上传文件
- 按照屏幕上的提示与 SharePoint Embedded 容器进行交互
重要
此示例应用程序以纯文本形式存储身份验证机密，仅用于开发目的。 切勿在生产环境中使用此配置。
疑难解答
如果遇到问题：
- 端口已在使用中：如果端口 8080 已在使用中，应用程序将自动尝试下一个可用端口
-
未安装的依赖项：尝试在之前手动运行
npm installnpm run start - 身份验证错误：确保Microsoft Entra ID应用正确配置了正确的重定向 URI
导出 Postman 环境
SharePoint Embedded Postman 集合允许您浏览和调用 SharePoint Embedded API。 集合需要一个环境文件，其中包含用于身份验证的变量和各种标识符。 此扩展自动生成此填充的环境文件，以便您可以将其导入邮政辅助角色并立即调用 SharePoint Embedded API。
