你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

快速入门:使用自定义项创建开发箱

在本快速入门中,你将使用 Microsoft Dev Box 团队自定义项创建开发箱。 此功能使用映像定义文件,以便为开发团队创建一致的自定义开发箱,并为项目提供定制的环境。

先决条件

产品 要求
Microsoft Dev Box - 使用开发框池和开发框项目设置开发人员中心 ,以便你可以创建开发框。
- 将目录附加到开发人员中心,其中包含可在映像定义文件中使用的任务。 如果没有目录,请参阅 从 GitHub 或 Azure Repos 添加和配置目录
-权限
- 创建开发框: 至少一个项目加入 Dev Box 用户安全组。
- 若要为开发人员中心启用项目级目录,请执行以下作: 订阅上具有写入访问权限的平台工程师。
- 若要为项目启用目录同步设置,请执行以下作: 订阅上具有写入访问权限的平台工程师。
- 若要将目录附加到项目,请执行以下作: 开发人员中心项目管理员或项目参与者权限。
- 若要创建自定义文件,请执行以下作: 未指定任何内容。 任何人都可以创建自定义文件。
- 若要在开发框创建过程中使用开发人员门户上传并应用 YAML 文件,请执行以下作: Dev Box 用户。
- 若要将任务添加到目录,请执行以下作: 添加到托管目录的存储库的权限。
Visual Studio Code - 安装最新版本

创建映像定义

若要创建具有自定义项的开发框,必须创建映像定义文件。 映像定义文件是一个 YAML 文件,其中包含要应用于开发框的自定义项。 在本快速入门中,可以使用示例映像定义文件作为起点。

启用项目级目录

必须先在开发中心级别启用项目级别目录,然后才能将目录添加到项目。

  1. Azure 门户中转到你的开发人员中心。

  2. 在服务菜单上的 “设置”下,选择 开发人员中心设置

  3. “项目”级别目录下,选择“ 为每个项目启用目录”,然后选择“ 应用”。

    显示开发中心设置的屏幕截图,其中已选中并突出显示了“启用每项目目录”选项。

向项目添加目录

以下部分将引导你完成以下任务:

  1. 为示例目录存储库创建分支到 GitHub 组织。
  2. 配置同步设置以将目录与项目同步。
  3. 将存储库作为目录添加。

对示例目录存储库创建分支

  1. 打开示例目录存储库

  2. 选择 “分>叉”创建一个新的分支 ,将存储库分支到 GitHub 组织。

    显示 GitHub 中的 eShop 存储库的屏幕截图,其中突出显示了“创建新分叉”。

配置目录同步设置

  1. 切换回 Azure 门户

  2. 在搜索框中输入“项目”。 在结果列表中,选择“项目”

  3. 选择要向其添加目录的项目。

  4. 在左侧菜单中,选择 “设置>目录”。

  5. 选择“同步设置”。

    Azure 门户中“目录”窗格的屏幕截图,其中突出显示了用于同步设置的按钮。

  6. “同步设置 ”窗格中:

    • 如果清除 映像定义 ,请选择它,然后选择“ 保存”。
    • 如果已选择 映像定义 ,请选择“ 取消”。

    Azure 门户中同步设置窗格的屏幕截图,其中突出显示了映像定义对应的复选框。

将存储库作为目录添加

  1. 在“目录”页上,选择“ 添加”。

  2. 在“添加目录”窗格中,输入或选择以下值:

    字段
    名称 输入目录的名称。
    目录源 选择“GitHub”。
    身份验证类型 选择“GitHub 应用”。
  3. 选择“配置存储库”链接。

    屏幕截图:Azure 门户,其中显示了已选择添加目录,并突出显示了用于配置存储库的链接。

  4. 如果系统提示你向 GitHub 进行身份验证,请进行身份验证。

  5. 在“Microsoft DevCenter”页上,选择“配置”。

    屏幕截图:Microsoft 开发人员中心应用页,其中突出显示了“配置”按钮。

  6. 选择包含要添加为目录的存储库的 GitHub 组织。 你必须是组织的所有者才能安装此应用。

    “安装 Microsoft DevCenter”页的屏幕截图,其中突出显示了一个 GitHub 组织。

  7. 在“ 安装Microsoft DevCenter ”页上, 选择“仅选择存储库”,选择要添加为目录的存储库,然后选择“ 保存”。

    “安装 Microsoft DevCenter”页的屏幕截图,其中已选中并突出显示了一个存储库。

    可以选择多个要添加为目录的存储库。 你必须将每个存储库添加为单独的目录,如本快速入门下一部分所述

  8. 切换回 Azure 门户

  9. “添加目录 ”窗格中,选择“ 使用 GitHub 登录”。

  10. 在“添加目录”窗格中,输入以下信息,然后选择“添加”:

    字段
    存储库 选择包含映像定义的存储库。
    示例: eShop
    分支 选择分支。
    示例: main
    文件夹路径 选择包含保存映像定义的子文件夹的文件夹。
    示例: .devcenter/catalog/image-definitions
  11. 在“ 目录 ”窗格中,验证目录是否显示。 连接成功后,“状态”列会显示为“同步成功”。

    “目录”页的屏幕截图,其中显示了具有同步成功状态的目录。

  12. 验证映像定义是否正确同步。 在左侧菜单中,选择“ 管理>映像定义”。 在此示例中,你将看到两个映像定义:

    • backend-dev - 此映像是适用于 eShop 后端 工程环境的 Windows 11 上的 Microsoft Visual Studio + 工具映像。
    • frontend-dev - 此映像是适用于 eShop 前端 工程环境的 Windows 11 上的 Microsoft Visual Studio + 工具映像。

    “图像定义”页的屏幕截图,其中显示了从目录中导入的图像定义。

为映像定义创建开发箱池

若要在创建开发箱时使自定义文件 imagedefintion.yaml 可访问,请将其指定为池的定义。

若要创建与项目关联的开发框池,请执行以下作:

  1. Azure 门户中

  2. 在搜索框中输入“项目”。 在结果列表中,选择“项目”

  3. 打开要在其中创建开发箱池的项目。

  4. 在左侧菜单中,选择“ 管理>开发”框池

  5. “开发框池 ”页上,选择“ 创建”。

  6. 在“创建开发箱池”页上,输入以下值:

    设置
    名称 输入池的描述性名称。 开发人员在创建开发框时选择池名称可见,因此请包含池的用途和区域。 名称在项目中必须唯一。
    示例: contoso-frontend-westUS
    定义 从列表的映像定义部分,选择一个映像定义。
    示例: contoso-catalog/frontend-dev
    计算 选择池中开发框的计算资源。
    示例: 8 vCPU、32 GB RAM
    存储 选择池中开发框的存储选项。
    示例: 256 GB SSD
    冬眠 当源映像和计算大小都兼容休眠时,支持休眠。
    网络连接 1.选择“部署到 Microsoft 托管的网络”
    2. 选择开发框的部署区域。 选择靠近开发箱用户的区域,以获得最佳的用户体验。
    示例: 美国西部
    许可 选中此复选框即表示确认组织具有要应用于此池中的开发箱的 Azure 混合权益许可证。

    用于创建新的开发框池的“基本信息”窗格的屏幕截图。

  7. 选择“创建”。

  8. 验证新的开发箱池是否显示在列表中。 可能需要刷新屏幕。

Azure 门户会部署开发箱池并运行状况检查,以确保映像和网络符合开发箱的验证标准。

从开发箱池创建开发箱

从开发箱池创建开发箱时,映像定义将应用于开发箱。 开发箱是使用映像定义文件中指定的自定义项创建的。

若要在 Microsoft Dev Box 开发人员门户中创建开发箱,请执行以下操作:

  1. 登录到 Microsoft Dev Box 开发人员门户

  2. 选择“新建”“新建开发箱”。>

  3. 在“添加开发箱”中,输入以下值:

    设置
    名称 输入开发箱的名称。 开发框名称在项目中必须唯一。
    示例: contoso-frontend-dev-box
    项目 开发人员门户列出了你有权访问的项目。 从列表中选择所需的项目。
    开发箱池 开发人员门户列出了所选项目的所有开发框池。 为工作选择适当的池。 选择附近的开发箱池,以获得最低延迟。
    应用自定义项 将此复选框保留为清除。 它用于应用用户自定义。 在本文中,你已配置团队自定义项。

    选择后,页面会显示以下信息:

    • 是否支持休眠。
    • 开发箱创建过程可能需要 25 分钟或更长时间才能完成的通知。
  4. 选择“创建”开始创建开发箱。

  5. 若要跟踪创建进度,请在开发人员门户中使用开发箱磁贴。

验证是否应用了自定义项

Dev Box 将自定义项应用为创建过程的最后阶段。 开发箱准备就绪后,Dev Box 会向你发送电子邮件。 然后,可以检查是否应用了自定义项。

  1. 等待开发框创建。

  2. 在开发人员门户中的“开发框”磁贴上,选择“操作”“自定义项”。>

    屏幕截图:开发箱磁贴,其中突出显示了“操作”菜单中的“自定义项”命令。

  3. 在“自定义项详细信息”窗格中,确认应用于开发箱的自定义项。

    屏幕截图:“自定义项详细信息”窗格,其中显示了应用于开发箱的自定义项。

清理资源

  1. 登录到开发人员门户

  2. 对于要删除的开发箱,请从“操作”菜单中选择“删除”。

    带有“删除”命令的开发箱“操作”菜单的屏幕截图。

  3. 若要确认删除,请选择“删除”。

    屏幕截图显示有关删除开发箱的确认消息。