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

快速入门：将 RESTful API 应用程序部署到 Azure Spring Apps

注意

从 2025 年 3 月中旬开始，基本、标准和企业计划将弃用，停用期为三年。 建议过渡到 Azure 容器应用。 有关详细信息，请参阅 Azure Spring Apps 停用公告。

从 2024 年 9 月 30 日开始，标准消耗和专用计划将弃用，六个月后将完全关闭。 建议过渡到 Azure 容器应用。 有关详细信息，请参阅将 Azure Spring Apps 标准消耗和专用计划迁移到 Azure 容器应用。

本文介绍如何将受 Microsoft Entra ID 保护的 RESTful API 应用程序部署到 Azure Spring Apps。 示例项目是基于简单待办事项 Web 应用程序的简化版本，它只提供后端服务并使用 Microsoft Entra ID 来保护 RESTful API。

这些 RESTful API 通过应用基于角色的访问控制 (RBAC) 获得保护。 匿名用户无法访问任何数据，也不允许控制不同用户的访问。 匿名用户只有以下三个权限：

• 读取：通过此权限，用户可以读取待办事项数据。
• 写入：通过此权限，用户可以添加或更新待办事项数据。
• 删除：通过此权限，用户可以删除待办事项数据。

部署成功后，可以通过 Swagger UI 查看和测试 API。

下图显示了系统的体系结构：

本文介绍以下用于创建资源并将其部署到 Azure Spring Apps 的选项：

• “Azure 门户 + Maven 插件”选项提供了一种更为传统的方法，可用于分步创建资源和部署应用程序。 此选项适合首次使用 Azure 云服务的 Spring 开发人员。
• “Azure Developer CLI”选项是一种更高效的方法，可通过简单的命令自动创建资源和部署应用程序。 Azure Developer CLI 使用模板来预配所需的 Azure 资源并部署应用程序代码。 此选项适合熟悉 Azure 云服务的 Spring 开发人员。

本文介绍以下用于创建资源并将其部署到 Azure Spring Apps 的选项：

• “Azure 门户 + Maven 插件”选项提供了一种更为传统的方法，可用于分步创建资源和部署应用程序。 此选项适合首次使用 Azure 云服务的 Spring 开发人员。
• “Azure CLI”选项使用功能强大的命令行工具管理 Azure 资源。 此选项适合熟悉 Azure 云服务的 Spring 开发人员。

1.先决条件

Azure 门户 + Maven 插件

• Azure 订阅。 如果没有 Azure 订阅，请在开始之前创建一个 Azure 免费帐户。

• 以下角色之一：

  • 全局管理员或特权角色管理员，用于为请求任何 API 的任何权限的应用授予同意 。
  • 云应用程序管理员或应用程序管理员，用于为请求任何 API 的任何权限的应用授予同意，除了 Microsoft Graph 应用角色（应用程序权限）。
  • 自定义目录角色，包含向应用程序授予权限的权限，用于应用程序所需的权限。

  有关详细信息，请参阅向应用程序授予租户范围的管理员同意。

• 如果你是首次在目标订阅中部署 Azure Spring Apps 企业计划实例，请参阅 Azure 市场中的企业计划的要求部分。

• Git。

• Java 开发工具包 (JDK)，版本 17。

• 一个 Microsoft Entra 租户。 如需创建租户的说明，请参阅快速入门：在 Microsoft Entra ID 中创建新租户。

Azure CLI

• 一个 Azure 订阅，如果你没有 Azure 订阅，请在开始之前创建一个免费 Azure 帐户。

• 以下角色之一：

  • 全局管理员或特权角色管理员，用于为请求任何 API 的任何权限的应用授予同意 。
  • 云应用程序管理员或应用程序管理员，用于为请求任何 API 的任何权限的应用授予同意，除了 Microsoft Graph 应用角色（应用程序权限）。
  • 自定义目录角色，包含向应用程序授予权限的权限，用于应用程序所需的权限。

  有关详细信息，请参阅向应用程序授予租户范围的管理员同意。

• 如果你是首次在目标订阅中部署 Azure Spring Apps 企业计划实例，请参阅 Azure 市场中的企业计划的要求部分。

• Git。

• Java 开发工具包 (JDK)，版本 17。

• 一个 Microsoft Entra 租户。 如需创建租户的说明，请参阅快速入门：在 Microsoft Entra ID 中创建新租户。

• Azure CLI 2.53.1 或更高版本。

Azure 门户 + Maven 插件

• 一个 Azure 订阅，如果你没有 Azure 订阅，请在开始之前创建一个免费 Azure 帐户。

• 以下角色之一：

  • 全局管理员或特权角色管理员，用于为请求任何 API 的任何权限的应用授予同意 。
  • 云应用程序管理员或应用程序管理员，用于为请求任何 API 的任何权限的应用授予同意，除了 Microsoft Graph 应用角色（应用程序权限）。
  • 自定义目录角色，包含向应用程序授予权限的权限，用于应用程序所需的权限。

  有关详细信息，请参阅向应用程序授予租户范围的管理员同意。

• Git。

• Java 开发工具包 (JDK)，版本 17。

• 一个 Microsoft Entra 租户。 如需创建租户的说明，请参阅快速入门：在 Microsoft Entra ID 中创建新租户。

Azure 开发人员 CLI

• 一个 Azure 订阅，如果你没有 Azure 订阅，请在开始之前创建一个免费 Azure 帐户。

• 以下角色之一：

  • 全局管理员或特权角色管理员，用于为请求任何 API 的任何权限的应用授予同意 。
  • 云应用程序管理员或应用程序管理员，用于为请求任何 API 的任何权限的应用授予同意，除了 Microsoft Graph 应用角色（应用程序权限）。
  • 自定义目录角色，包含向应用程序授予权限的权限，用于应用程序所需的权限。

  有关详细信息，请参阅授予管理员同意。

• Git。

• Java 开发工具包 (JDK)，版本 17。

• 一个 Microsoft Entra 租户。 如需创建租户的说明，请参阅快速入门：在 Microsoft Entra ID 中创建新租户。

• Azure Developer CLI (AZD) 版本 1.0.2 或更高版本。

2. 准备 Spring 项目

若要部署 RESTful API 应用，第一步是准备在本地运行的 Spring 项目。

使用以下步骤在本地克隆和运行该应用：

1. 使用以下命令从 GitHub 克隆示例项目：

   git clone https://github.com/Azure-Samples/ASA-Samples-Restful-Application.git
   

2. 若要在本地运行应用，请先完成“公开 RESTful API”中的步骤并更新应用程序配置部分，然后使用以下命令通过 Maven 运行示例应用程序：

   cd ASA-Samples-Restful-Application
   ./mvnw spring-boot:run
   

3. 准备云环境

运行此示例应用所需的主要资源是 Azure Spring Apps 实例和 Azure Database for PostgreSQL 实例。 以下部分介绍如何创建这些资源。

Azure 门户 + Maven 插件

3.1. 登录到 Azure 门户

转到 Azure 门户，输入登录到门户所需的凭据。 默认视图是服务仪表板。

3.2. 创建 Azure Spring Apps 实例

使用以下步骤创建 Azure Spring Apps 服务实例：

1. 在 Azure 门户一角选择“创建资源”。

2. 选择“计算>Azure Spring Apps”。

3. 填写“基本”表单，其中包含以下信息：

   设置	建议值	描述
   订阅	你的订阅名称。	要用于服务器的 Azure 订阅。 如果你有多个订阅，请选择要计费的资源所在的订阅。
   资源组	myresourcegroup	新的资源组名称，或订阅中的现有资源组。
   名称	myasa	用于标识 Azure Spring Apps 服务的唯一名称。 该名称必须为 4 到 32 个字符，只能包含小写字母、数字及连字符。 服务名称的第一个字符必须是字母，最后一个字符必须是字母或数字。
   计划	企业	定价计划确定与实例关联的资源和成本。
   区域	离用户最近的区域。	最靠近用户的位置。
   区域冗余	未选定	在 Azure 可用性区域中创建 Azure Spring Apps 服务的选项。 此功能目前在所有区域都不受支持。
   软件 IP 计划	即用即付	使用 Azure Spring Apps 进行即用即付的定价计划。
   Terms	已选择	与市场产品/服务关联的协议复选框。 需要选中此复选框。
   部署示例项目	未选定	使用内置示例应用程序的选项。

4. 选择“查看 + 创建”，查看所选内容。 然后，选择“创建”以预配 Azure Spring Apps 实例。

5. 在工具栏上选择“通知”图标（铃铛）以监视部署过程。 完成部署后，可以选择“固定到仪表板”，以便在 Azure 门户仪表板上为此服务创建磁贴作为前往此服务的“概述”页的快捷方式。

   

6. 选择“转到资源”，转到“Azure Spring Apps 概述”页面。

3.3. 准备 PostgreSQL 实例

执行以下步骤以创建 Azure Database for PostgreSQL 服务器：

1. 转到 Azure 门户，然后选择“创建资源”。

2. 选择“数据库”>“用于 PostgreSQL 的 Azure 数据库”。

3. 选择“灵活服务器”部署选项。

   

4. 在“基本信息”选项卡中填写以下信息：

   • 服务器名称：my-demo-pgsql
   • 区域：美国东部
   • PostgreSQL 版本：14
   • 工作负载类型：开发
   • 启用高可用性：未选中
   • 身份验证方法：仅限 PostgreSQL 身份验证
   • 管理员用户名：myadmin
   • 密码和确认密码：输入密码。

5. 使用以下信息配置“网络”选项卡：

   • 连接方法：公共访问（允许的 IP 地址）
   • 允许从 Azure 内的任何 Azure 服务公开访问此服务器：已选中

6. 选择“查看 + 创建”来查看选择，然后选择“创建”以预配服务器。 此操作可能需要几分钟时间。

7. 在 Azure 门户中转到 PostgreSQL 服务器。 在“概述”页上，查找“服务器名称”值，然后记录下来以供将来使用。 需要该值来为 Azure Spring Apps 中的应用配置环境变量。

8. 从导航菜单中选择“数据库”以创建数据库，例如 Todo。

   

3.4. 将应用实例连接到 PostgreSQL 实例

遵循以下步骤连接服务实例：

1. 在 Azure 门户中转到 Azure Spring Apps 实例。

2. 在导航菜单中，打开“应用”，然后选择“创建应用”。

3. 在“创建应用”页上，填写应用名称 simple-todo-api，然后选择“Java 项目”作为部署类型。

4. 选择“创建”以完成应用创建，然后选择该应用以查看详细信息。

5. 转到在 Microsoft Azure 门户中创建的应用。 在“概述”页上，选择“分配终结点”以公开应用的公共终结点。 保存 URL 以在部署后访问应用。

6. 从导航窗格中选择“服务连接器”，然后选择“创建”以创建新的服务连接。

   

7. 在“基本信息”选项卡中填写以下信息：

   • 服务类型：DB for PostgreSQL 灵活服务器
   • 连接名称：填充自动生成的名称，也可以对其进行修改。
   • 订阅：选择订阅。
   • PostgreSQL 灵活服务器：my-demo-pgsql
   • PostgreSQL 数据库：选择创建的数据库。
   • 客户端类型：SpringBoot

   

8. 使用以下信息配置配置“下一步: 身份验证”选项卡：

   • 选择要在计算服务和目标服务之间使用的身份验证类型：选择“连接字符串”。
   • 使用...以继续：选择“数据库凭据”
   • 用户名：myadmin
   • 密码：输入密码。

   

9. 选择“下一页:网络”。 使用默认选项“配置防火墙规则以启用对目标服务的访问权限”。

10. 选择“下一步: 查看并创建”以查看选择，然后选择“创建”以创建连接。

3.5. 公开 RESTful API

使用以下步骤以在 Microsoft Entra ID 中公开 RESTful API：

1. 登录 Azure 门户。

2. 如果有权访问多个租户，请使用“目录 + 订阅”筛选器 ()，选择要在其中注册应用程序的租户。

3. 搜索并选择 Microsoft Entra ID。

4. 在“管理”下，选择“应用注册”>“新建注册” 。

5. 在“名称”字段中输入应用程序的名称 - 例如“待办事项”。 应用的用户可能会看到此名称，你稍后可对其进行更改。

6. 对于“支持的帐户类型”，选择“任何组织目录（任何 Microsoft Entra 目录 - 多租户）中的帐户和个人 Microsoft 帐户（例如 Skype、Xbox）”。

7. 选择“注册”以创建应用程序。

8. 在应用的“概述”页上，找到“应用程序(客户端) ID”值，然后记下该值以供后续使用 。 需要该值来为此项目配置 YAML 配置文件。

9. 在“管理”下，选择“公开 API”，在页面开头找到“应用程序 ID URI”，然后选择“添加”。

10. 在“编辑应用程序 ID URI”页面，接受建议的应用程序 ID URI (api://{client ID}) 或使用有意义的名称而不是客户端 ID（例如 api://simple-todo），然后选择“保存”。

11. 在“管理”下，选择“公开 API”>添加作用域”，然后输入以下信息：

    • 对于“作用域名称”，请输入“ToDo.Read”。
    • 对于“需要获取谁的同意”，请选择“仅管理员”。
    • 对于“管理员同意显示名”，请输入“读取待办事项数据”。
    • 对于“管理员同意说明”，请输入“允许经过身份验证的用户读取待办事项数据”。
    • 对于“状态”，请保持启用状态。
    • 选择“添加作用域”。

12. 重复上述步骤以添加其他两个作用域：ToDo.Write 和 ToDo.Delete。

    

3.6. 更新应用程序配置

使用以下步骤更新 YAML 文件，以通过 Microsoft Entra 注册的应用程序信息与 RESTful API 应用程序建立关系：

1. 找到 simple-todo-api 应用的 src/main/resources/application.yml 文件。 更新 spring.cloud.azure.active-directory 部分中的配置以匹配以下示例。 请务必将占位符替换为之前创建的值。

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   注意

   在 v1.0 令牌中，配置需要 API 的客户端 ID，而在 v2.0 令牌中，可以在请求中使用客户端 ID 或应用程序 ID URI。 可以同时配置这两项以正确完成受众验证。

   tenant-id 允许的值包括：common、organizations、consumers或租户 ID。 有关这些值的详细信息，请参阅错误 AADSTS50020 - 来自标识提供者的用户帐户不存在于租户中部分中的使用了错误的终结点（个人和组织帐户）部分。 有关转换单租户应用的信息，请参阅将单租户应用转换为 Microsoft Entra ID 上的多租户。

2. 使用以下命令重新生成示例项目：

   ./mvnw clean package
   

Azure CLI

3.1. 提供每个资源的名称

使用以下命令创建变量以保存资源名称。 请务必将占位符替换为你自己的值。

export RESOURCE_GROUP=myresourcegroup
export LOCATION=<location>
export POSTGRESQL_SERVER=my-demo-pgsql
export POSTGRESQL_DB=Todo
export POSTGRESQL_ADMIN_USERNAME=<admin-username>
export POSTGRESQL_ADMIN_PASSWORD=<admin-password>
export AZURE_SPRING_APPS_NAME=myasa
export APP_NAME=simple-todo-api
export TODO_APP_NAME=Todo
export TODO_APP_URL=api://simple-todo
export TODOWEB_APP_NAME=TodoWeb
export TODOWEB_APP_URL=api://simple-todoweb
export NEW_MEMBER_USERNAME=<new-member-username>
export NEW_MEMBER_PASSWORD=<new-member-password>
export USER_PRINCIPAL_NAME=<user-principal-name>

3.2. 创建新的资源组

按照以下步骤创建新的资源组：

1. 使用以下命令登录到 Azure CLI：

   az login
   

2. 使用以下命令设置默认位置：

   az configure --defaults location=${LOCATION}
   

3. 使用以下命令列出所有可用的订阅，以确定要使用的订阅 ID：

   az account list --output table
   

4. 使用以下命令设置默认订阅：

   az account set --subscription <subscription-ID>
   

5. 使用以下命令来创建资源组：

   az group create --resource-group ${RESOURCE_GROUP}
   

6. 使用以下命令将新创建的资源组设置为默认资源组：

   az configure --defaults group=${RESOURCE_GROUP}
   

3.3. 安装扩展并注册命名空间

使用以下命令安装适用于 Azure CLI 的 Azure Spring Apps 扩展并注册 Microsoft.SaaS 命名空间：

az extension add --name spring --upgrade
az provider register --namespace Microsoft.SaaS

3.4. 创建 Azure Spring Apps 实例

使用以下步骤在实例中创建服务实例和应用程序：

1. 使用以下命令接受企业计划的法律条款和隐私声明：

   注意

   仅当订阅从未用于创建 Azure Spring Apps 企业计划实例时，才需要执行此步骤。

   az term accept \
       --publisher vmware-inc \
       --product azure-spring-cloud-vmware-tanzu-2 \
       --plan asa-ent-hr-mtr
   

2. 使用以下命令创建 Azure Spring Apps 服务实例：

   az spring create --name ${AZURE_SPRING_APPS_NAME} --sku enterprise
   

3. 使用以下命令在 Azure Spring Apps 实例中创建应用程序：

   az spring app create \
       --service ${AZURE_SPRING_APPS_NAME} \
       --name ${APP_NAME} \
       --assign-endpoint true
   

3.5. 准备 PostgreSQL 实例

Spring Web 应用将 H2 用于 localhost 中的数据库，将 Azure Database for PostgreSQL 用于 Azure 中的数据库。

使用以下命令创建 PostgreSQL 实例：

az postgres flexible-server create \
    --name ${POSTGRESQL_SERVER} \
    --database-name ${POSTGRESQL_DB} \
    --admin-user ${POSTGRESQL_ADMIN_USERNAME} \
    --admin-password ${POSTGRESQL_ADMIN_PASSWORD} \
    --public-access 0.0.0.0

指定 0.0.0.0 将允许从 Azure 中部署的任何资源进行公共访问以访问服务器。

3.6. 将应用实例连接到 PostgreSQL 实例

创建应用程序实例和 PostgreSQL 实例后，应用程序实例无法直接访问 PostgreSQL 实例。 使用以下步骤使应用程序能够连接到 PostgreSQL 实例：

1. 使用以下命令获取 PostgreSQL 实例的完全限定域名：

   export PSQL_FQDN=$(az postgres flexible-server show \
       --name ${POSTGRESQL_SERVER} \
       --query fullyQualifiedDomainName \
       --output tsv)
   

2. 使用以下命令通过环境变量向应用程序提供 spring.datasource. 属性：

   az spring app update \
       --service ${AZURE_SPRING_APPS_NAME} \
       --name ${APP_NAME} \
       --env SPRING_DATASOURCE_URL="jdbc:postgresql://${PSQL_FQDN}:5432/${POSTGRESQL_DB}?sslmode=require" \
             SPRING_DATASOURCE_USERNAME="${POSTGRESQL_ADMIN_USERNAME}" \
             SPRING_DATASOURCE_PASSWORD="${POSTGRESQL_ADMIN_PASSWORD}"
   

3.7. 公开 RESTful API

使用以下步骤公开 RESTful API：

1. 使用以下命令创建 Microsoft Entra ID 应用程序：

   az ad app create \
       --display-name ${TODO_APP_NAME} \
       --sign-in-audience AzureADandPersonalMicrosoftAccount \
       --identifier-uris ${TODO_APP_URL}
   

2. 使用以下命令为应用程序创建服务主体：

   az ad sp create --id ${TODO_APP_URL}
   

3. 使用以下命令生成权限 ID：

   permissionid1=$(uuidgen);permissionid2=$(uuidgen);permissionid3=$(uuidgen)
   

4. 将以下范围添加为 JSON：

   api=$(echo '{
    "oauth2PermissionScopes": [
        {
            "adminConsentDescription": "Allows authenticated users to delete the ToDo data",
            "adminConsentDisplayName": "Delete the ToDo data",
            "id": "'$permissionid1'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Delete"
        },
   
        {
            "adminConsentDescription": "Allows authenticated users to write the ToDo data",
            "adminConsentDisplayName": "Write the ToDo data",
            "id": "'$permissionid2'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Write"
        },
        {
            "adminConsentDescription": "Allows authenticated users to read the ToDo data",
            "adminConsentDisplayName": "Read the ToDo data",
            "id": "'$permissionid3'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Read"
        }
    ]}')
   

5. 使用以下命令添加范围：

   az ad app update \
       --id ${TODO_APP_URL} \
       --set api="$api"
   

6. 使用以下命令获取要在下一步中使用的租户 ID：

   az account show --query "tenantId" --output tsv
   

7. 使用以下命令获取要在后续步骤中使用的应用程序 ID：

   appid=$(az ad app show \
       --id ${TODO_APP_URL} \
       --query appId \
       --output tsv);
   echo $appid
   

3.8. 更新应用程序配置

使用以下步骤更新 YAML 文件，以通过 Microsoft Entra 注册的应用程序信息与 RESTful API 应用程序建立关系：

1. 找到 simple-todo-api 应用的 src/main/resources/application.yml 文件。 更新 spring.cloud.azure.active-directory 部分中的配置以匹配以下示例。 请务必将占位符替换为之前创建的值。

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   注意

   在 v1.0 令牌中，配置需要 API 的客户端 ID，而在 v2.0 令牌中，可以在请求中使用客户端 ID 或应用程序 ID URI。 可以同时配置这两项以正确完成受众验证。

   tenant-id 允许的值包括：common、organizations、consumers或租户 ID。 有关这些值的详细信息，请参阅错误 AADSTS50020 - 来自标识提供者的用户帐户不存在于租户中部分中的使用了错误的终结点（个人和组织帐户）部分。 有关转换单租户应用的信息，请参阅将单租户应用转换为 Microsoft Entra ID 上的多租户。

2. 使用以下命令重新生成示例项目：

   ./mvnw clean package
   

4. 将应用部署到 Azure Spring Apps

Azure 门户 + Maven 插件

现在可以将应用部署到 Azure Spring Apps。

按照以下步骤，使用适用于 Azure Spring Apps 的 Maven 插件进行部署：

1. 导航到完整目录，然后运行以下命令以在 Azure Spring Apps 中配置应用：

   ./mvnw com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config
   

   以下列表描述了命令交互：

   • OAuth2 登录：你需要根据 OAuth2 协议授权到 Azure 的登录。
   • 选择订阅：选择所创建的 Azure Spring Apps 实例的订阅列表编号，它默认为列表中的第一个订阅。 如果使用默认编号，请直接按 Enter。
   • 使用 Azure 中的现有 Azure Spring Apps：按 y 使用现有的 Azure Spring Apps 实例。
   • 选择要部署的 Azure Spring Apps：选择创建的 Azure Spring Apps 实例的编号。 如果使用默认编号，请直接按 Enter。
   • 在 Azure Spring Apps 中使用现有应用 <your-instance-name>：按 y 使用已创建的应用。
   • 确认保存上述所有配置：按 y。 如果按 n，则配置不会保存在 POM 文件中。

2. 使用以下命令部署应用：

   ./mvnw azure-spring-apps:deploy
   

   以下列表描述了命令交互：

   • OAuth2 登录：你需要根据 OAuth2 协议授权到 Azure 的登录。

   执行命令后，你会从以下日志消息中看到部署已成功：

[INFO] Deployment Status: Running
[INFO]   InstanceName:simple-todo-api-default-15-xxxxxxxxx-xxxxx  Status:Running Reason:null       DiscoverStatus:N/A       
[INFO] Getting public url of app(simple-todo-api)...
[INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-simple-todo-api.azuremicroservices.io

Azure CLI

使用以下命令以基于源代码部署应用：

az spring app deploy \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${APP_NAME} \
    --build-env BP_JVM_VERSION=17 \
    --source-path .

5. 验证应用

Azure 门户 + Maven 插件

现在可以访问 RESTful API 以查看它是否正常工作。

5.1. 请求访问令牌

RESTful API 作用是资源服务器，它受到 Microsoft Entra ID 的保护。 在获取访问令牌之前，必须在 Microsoft Entra ID 中注册另一个应用程序，然后将权限授予名为“ToDoWeb”的客户端应用程序。

注册客户端应用程序

使用以下步骤在 Microsoft Entra ID 中注册应用程序，该应用程序用于向 ToDo 应用添加权限：

1. 登录 Azure 门户。

2. 如果有权访问多个租户，请使用“目录 + 订阅”筛选器 ()，选择要在其中注册应用程序的租户。

3. 搜索并选择 Microsoft Entra ID。

4. 在“管理”下，选择“应用注册”>“新建注册” 。

5. 在“名称”字段中输入应用程序的名称 - 例如“ToDoWeb”。 应用的用户可能会看到此名称，你稍后可对其进行更改。

6. 对于“支持的帐户类型”，请使用默认值“仅限此组织目录中的帐户”。

7. 选择“注册”以创建应用程序。

8. 在应用的“概述”页上，找到“应用程序(客户端) ID”值，然后记下该值以供后续使用 。 需要该值来获取访问令牌。

9. 选择“API 权限”>“添加权限”>“我的 API”。 选择之前注册的 ToDo 应用程序，然后选择“ToDo.Read”、“ToDo.Write”和“ToDo.Delete”权限。 选择“添加权限”。

10. 选择“为 <your-tenant-name> 授予管理员同意”，为添加的权限授予管理员同意。

    

添加用户以访问 RESTful API

使用以下步骤在 Microsoft Entra 租户中创建成员用户。 然后，用户可以通过 RESTful API 管理 ToDo 应用程序的数据。

1. 在“管理”下 ，选择“用户”>“新用户”>“创建新用户”。

2. 在“创建新用户”页上输入以下信息：

   • 用户主体名称：输入用户的名称。
   • 显示名称：输入用户的显示名称。
   • 密码复制“密码”框中提供的自动生成的密码。

   注意

   新用户必须完成首次登录身份验证并更新密码，否则，在获取访问令牌时会收到以下错误 AADSTS50055: The password is expired。

   新用户在登录时会收到“需要用户操作”的提示。 用户可以选择“稍后询问”以跳过验证。

3. 选择“查看 + 创建”，查看所选内容。 选择“创建”以创建用户。

为 Swagger UI 授权更新 OAuth2 配置

使用以下步骤为 Swagger UI 授权更新 OAuth2 配置。 然后，就可以授权用户通过 ToDoWeb 应用获取访问令牌。

1. 在 Azure 门户中打开“Microsoft Entra ID”租户，并转到已注册的 ToDoWeb 应用。

2. 在“管理”下，选择“身份验证”，选择“添加平台”，然后选择“单页应用程序”。

3. 使用 <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html 格式作为“重定向 URI”字段中的 OAuth2 重定向 URL，然后选择“配置”。

   

Azure CLI

现在可以访问 RESTful API 以查看它是否正常工作。

5.1. 请求访问令牌

RESTful API 作用是资源服务器，它受到 Microsoft Entra ID 的保护。 在获取访问令牌之前，需要在 Microsoft Entra ID 中注册另一个应用程序，然后将权限授予名为“ToDoWeb”的客户端应用程序。

注册客户端应用程序

使用以下步骤注册客户端应用程序：

1. 使用以下命令创建 Microsoft Entra ID 应用程序，其用于添加 ToDo 应用的权限：

   az ad app create \
       --display-name ${TODOWEB_APP_NAME} \
       --sign-in-audience AzureADMyOrg \
       --identifier-uris ${TODOWEB_APP_URL}
   

2. 使用以下命令添加权限：

   az ad app permission add \
       --id api://simple-todowebtest2 \
       --api $appid \
       --api-permissions $permissionid1=Scope $permissionid2=Scope $permissionid3=Scope
   

3. 使用以下命令为添加的权限授予管理员同意：

   az ad app permission admin-consent --id ${TODOWEB_APP_URL}
   

4. 使用以下命令获取“获取访问令牌”步骤中使用的 ToDoWeb 应用的客户端 ID：

   az ad app show \
       --id ${TODOWEB_APP_URL} \
       --query appId \
       --output tsv
   

添加用户以访问 RESTful API

使用以下命令在 Microsoft Entra 租户中创建成员用户。 然后，用户可以通过 RESTful API 管理 ToDo 应用程序的数据：

az ad user create \
    --display-name ${NEW_MEMBER_USERNAME} \
    --password ${NEW_MEMBER_PASSWORD} \
    --user-principal-name ${USER_PRINCIPAL_NAME}

为 Swagger UI 授权更新 OAuth2 配置

使用以下步骤更新 OAuth2 配置：

1. 使用以下命令获取 ToDoWeb 应用的对象 ID：

   az ad app show --id ${TODOWEB_APP_URL} --query id
   

2. 运行以下命令以获取 simple-todo-api 应用的 URL：

   az spring app show \
       --name ${APP_NAME} \
       --service ${AZURE_SPRING_APPS_NAME} \
       --query properties.url
   

3. 使用以下命令更新 Swagger UI 授权的 OAuth2 配置，将 <object-id> 和 <URL> 占位符替换为你获取的参数值。 然后，就可以授权用户通过 ToDoWeb 应用获取访问令牌。

   az rest \
       --method PATCH \
       --uri "https://graph.microsoft.com/v1.0/applications/<object-id>" \
       --headers 'Content-Type=application/json' \
       --body '{"spa":{"redirectUris":["<URL>/swagger-ui/oauth2-redirect.html"]}}'
   

2. 准备 Spring 项目

若要部署 RESTful API 应用，第一步是准备在本地运行的 Spring 项目。

Azure 门户 + Maven 插件

使用以下步骤在本地克隆和运行该应用：

1. 使用以下命令从 GitHub 克隆示例项目：

   git clone https://github.com/Azure-Samples/ASA-Samples-Restful-Application.git
   

2. 若要在本地运行应用，请先完成“公开 RESTful API”中的步骤并更新应用程序配置部分，然后使用以下命令通过 Maven 运行示例应用程序：

   cd ASA-Samples-Restful-Application
   ./mvnw spring-boot:run
   

Azure 开发人员 CLI

使用以下步骤从 Azure Developer CLI 模板初始化 Web 应用程序：

1. 打开终端，创建新的空文件夹，然后将目录更改为该文件夹。

2. 运行以下命令来初始化项目：

   azd init --template Azure-Samples/ASA-Samples-Restful-Application
   

   以下列表描述了命令交互：

   • OAuth2 登录：你需要根据 OAuth2 协议授权到 Azure 的登录。
   • 请输入新的环境名称：提供一个环境名称。 此名称用作为容纳所有 Azure 资源而创建的资源组的后缀。 此名称应在 Azure 订阅中具有唯一性。

   控制台输出类似于以下示例的消息：

   Initializing a new project (azd init)
   
   Downloading template code to: <your-local-path>
   (✓) Done: Initialized git repository
   
   Enter a new environment name: <your-env-name>
   
   SUCCESS: New project initialized!
   You can view the template code in your directory: <your-local-path>
   Learn more about running 3rd party code on our DevHub: https://aka.ms/azd-third-party-code-notice
   

3. 准备云环境

运行此示例应用所需的主要资源是 Azure Spring Apps 实例和 Azure Database for PostgreSQL 实例。 以下部分介绍如何创建这些资源。

Azure 门户 + Maven 插件

3.1. 登录到 Azure 门户

转到 Azure 门户，输入登录到门户所需的凭据。 默认视图是服务仪表板。

3.2. 创建 Azure Spring Apps 实例

遵循以下步骤来创建服务实例：

1. 在门户的角落选择“创建资源”。

2. 选择“计算>Azure Spring Apps”。

3. 填写“基本”窗体。 以下表为指南来填写窗体。 建议的“Plan”值为“标准消耗和专用资源（预览版）”。

   设置	建议值	描述
   订阅	你的订阅名称。	要用于服务器的 Azure 订阅。 如果你有多个订阅，请选择要计费的资源所在的订阅。
   资源组	myresourcegroup	新的资源组名称，或订阅中的现有资源组。
   名称	myasa	用于标识 Azure Spring Apps 服务的唯一名称。 该名称必须为 4 到 32 个字符，只能包含小写字母、数字及连字符。 服务名称的第一个字符必须是字母，最后一个字符必须是字母或数字。
   计划	标准消耗和专用型（预览版）	定价层会确定与实例关联的资源和成本。
   区域	离用户最近的区域。	最靠近用户的位置。
   容器应用环境	myenvironment	用于选择哪个 Azure 容器应用环境实例与其他服务和资源共享相同的虚拟网络的选项。

   使用下表作为容器应用环境创建的指南：

   设置	建议值	说明
   环境名称	myenvironment	识别 Azure 容器应用环境服务的唯一名称。
   计划	消耗	定价层会确定与实例关联的资源和成本。
   区域冗余	已禁用	用于在 Azure 可用性区域中创建容器应用环境服务的选项。

4. 选择“查看 + 创建”，查看所选内容。 然后，选择“创建”以预配 Azure Spring Apps 实例。

5. 在工具栏上选择“通知”图标（铃铛）以监视部署过程。 完成部署后，可以选择“固定到仪表板”，以便在 Azure 门户仪表板上为此服务创建磁贴作为前往此服务的“概述”页的快捷方式。

6. 选择“转到资源”以打开服务的“概述”页。

   

重要

消耗工作负荷配置文件有一个没有初始成本的即用即付计费模型。 系统会根据预配的资源对专用工作负荷配置文件收费。 有关详细信息，请参阅 Azure 容器应用中的工作负载配置文件和 Azure Spring Apps 定价。

3.3. 准备 PostgreSQL 实例

执行以下步骤以创建 Azure Database for PostgreSQL 服务器：

1. 转到 Azure 门户，然后选择“创建资源”。

2. 选择“数据库”>“用于 PostgreSQL 的 Azure 数据库”。

3. 选择“灵活服务器”部署选项。

   

4. 在“基本信息”选项卡中填写以下信息：

   • 服务器名称：my-demo-pgsql
   • 区域：美国东部
   • PostgreSQL 版本：14
   • 工作负载类型：开发
   • 启用高可用性：未选中
   • 身份验证方法：仅限 PostgreSQL 身份验证
   • 管理员用户名：myadmin
   • 密码和确认密码：输入密码。

5. 使用以下信息配置“网络”选项卡：

   • 连接方法：公共访问（允许的 IP 地址）
   • 允许从 Azure 内的任何 Azure 服务公开访问此服务器：已选中

6. 选择“查看 + 创建”来查看选择，然后选择“创建”以预配服务器。 此操作可能需要几分钟时间。

7. 在 Azure 门户中转到 PostgreSQL 服务器。 在“概述”页上，查找“服务器名称”值，然后记录下来以供将来使用。 需要该值来为 Azure Spring Apps 中的应用配置环境变量。

8. 从导航菜单中选择“数据库”以创建数据库，例如 Todo。

   

3.4. 将应用实例连接到 PostgreSQL 实例

遵循以下步骤连接服务实例：

1. 在 Azure 门户中转到 Azure Spring Apps 实例。

2. 在导航菜单中，打开“应用”，然后选择“创建应用”。

3. 在“创建应用”页上，填写应用名称“simple-todo-api”，并选择“Java 项目”作为部署类型。

4. 选择“创建”以完成应用创建，然后选择该应用以查看详细信息。

5. 转到在 Microsoft Azure 门户中创建的应用。 在“概述”页上，选择“分配终结点”以公开应用的公共终结点。 保存 URL 以在部署后访问应用。

6. 转到已创建的应用，展开“设置”，从导航菜单中选择“配置”，然后选择“环境变量”以设置环境变量。

7. 为 PostgreSQL 连接添加以下环境变量，然后选择“保存”以完成应用配置更新。 请确保将占位符替换为之前自己创建的值。

   环境变量	Value
   SPRING_DATASOURCE_URL	jdbc:postgresql://<your-PostgreSQL-server-name>:5432/<your-PostgreSQL-database-name>
   SPRING_DATASOURCE_USERNAME	<your-PostgreSQL-admin-user>
   SPRING_DATASOURCE_PASSWORD	<your-PostgreSQL-admin-password>

   

3.5. 公开 RESTful API

使用以下步骤以在 Microsoft Entra ID 中公开 RESTful API：

1. 登录 Azure 门户。

2. 如果有权访问多个租户，请使用“目录 + 订阅”筛选器 ()，选择要在其中注册应用程序的租户。

3. 搜索并选择 Microsoft Entra ID。

4. 在“管理”下，选择“应用注册”>“新建注册” 。

5. 在“名称”字段中输入应用程序的名称 - 例如“待办事项”。 应用的用户可能会看到此名称，你稍后可对其进行更改。

6. 对于“支持的帐户类型”，选择“任何组织目录（任何 Microsoft Entra 目录 - 多租户）中的帐户和个人 Microsoft 帐户（例如 Skype、Xbox）”。

7. 选择“注册”以创建应用程序。

8. 在应用的“概述”页上，找到“应用程序(客户端) ID”值，然后记下该值以供后续使用 。 需要该值来为此项目配置 YAML 配置文件。

9. 在“管理”下，选择“公开 API”，在页面开头找到“应用程序 ID URI”，然后选择“添加”。

10. 在“编辑应用程序 ID URI”页面，接受建议的应用程序 ID URI (api://{client ID}) 或使用有意义的名称而不是客户端 ID（例如 api://simple-todo），然后选择“保存”。

11. 在“管理”下，选择“公开 API”>添加作用域”，然后输入以下信息：

    • 对于“作用域名称”，请输入“ToDo.Read”。
    • 对于“需要获取谁的同意”，请选择“仅管理员”。
    • 对于“管理员同意显示名”，请输入“读取待办事项数据”。
    • 对于“管理员同意说明”，请输入“允许经过身份验证的用户读取待办事项数据”。
    • 对于“状态”，请保持启用状态。
    • 选择“添加作用域”。

12. 重复上述步骤以添加其他两个作用域：ToDo.Write 和 ToDo.Delete。

    

3.6. 更新应用程序配置

使用以下步骤更新 YAML 文件，以通过 Microsoft Entra 注册的应用程序信息与 RESTful API 应用程序建立关系：

1. 找到 simple-todo-api 应用的 src/main/resources/application.yml 文件。 更新 spring.cloud.azure.active-directory 部分中的配置以匹配以下示例。 请务必将占位符替换为之前创建的值。

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   注意

   在 v1.0 令牌中，配置需要 API 的客户端 ID，而在 v2.0 令牌中，可以在请求中使用客户端 ID 或应用程序 ID URI。 可以同时配置这两项以正确完成受众验证。

   tenant-id 允许的值包括：common、organizations、consumers或租户 ID。 有关这些值的详细信息，请参阅错误 AADSTS50020 - 来自标识提供者的用户帐户不存在于租户中部分中的使用了错误的终结点（个人和组织帐户）部分。 有关转换单租户应用的信息，请参阅将单租户应用转换为 Microsoft Entra ID 上的多租户。

2. 使用以下命令重新生成示例项目：

   ./mvnw clean package
   

Azure 开发人员 CLI

3.1. 准备 Azure 资源

使用以下步骤预配所需的 Azure 资源：

1. 运行以下命令以通过 OAuth2 登录到 Azure。 如果已登录，请忽略此步。

   azd auth login
   

2. 运行以下命令以启用 Azure Spring Apps 功能：

   azd config set alpha.springapp on
   

3. 运行以下命令将应用程序的可部署副本打包，预配模板的基础结构到 Azure，并将应用程序代码部署到这些新预配的资源：

   azd provision
   

   以下列表描述了命令交互：

   • 选择要使用的 Azure 订阅：使用箭头移动，键入以进行筛选，然后按 Enter。
   • 选择要使用的 Azure 位置：使用箭头移动，键入以进行筛选，然后按 Enter。

   控制台输出类似于以下示例的消息：

   SUCCESS: Your application was provisioned in Azure in xx minutes xx seconds.
   You can view the resources created under the resource group rg-<your-environment-name>> in Azure Portal:
   https://portal.azure.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>/overview
   

   注意

   此命令可能需要一段时间才能完成。 预配 Azure 资源时，系统会显示进度指示器。

3.2. 公开 RESTful API

使用以下步骤以在 Microsoft Entra ID 中公开 RESTful API：

1. 登录 Azure 门户。

2. 如果有权访问多个租户，请使用“目录 + 订阅”筛选器 ()，选择要在其中注册应用程序的租户。

3. 搜索并选择 Microsoft Entra ID。

4. 在“管理”下，选择“应用注册”>“新建注册” 。

5. 在“名称”字段中输入应用程序的名称 - 例如“待办事项”。 应用的用户可能会看到此名称，你稍后可对其进行更改。

6. 对于“支持的帐户类型”，选择“任何组织目录（任何 Microsoft Entra 目录 - 多租户）中的帐户和个人 Microsoft 帐户（例如 Skype、Xbox）”。

7. 选择“注册”以创建应用程序。

8. 在应用的“概述”页上，找到“应用程序(客户端) ID”值，然后记下该值以供后续使用 。 需要该值来为此项目配置 YAML 配置文件。

9. 在“管理”下，选择“公开 API”，在页面开头找到“应用程序 ID URI”，然后选择“添加”。

10. 在“编辑应用程序 ID URI”页面，接受建议的应用程序 ID URI (api://{client ID}) 或使用有意义的名称而不是客户端 ID（例如 api://simple-todo），然后选择“保存”。

11. 在“管理”下，选择“公开 API”>添加作用域”，然后输入以下信息：

    • 对于“作用域名称”，请输入“ToDo.Read”。
    • 对于“需要获取谁的同意”，请选择“仅管理员”。
    • 对于“管理员同意显示名”，请输入“读取待办事项数据”。
    • 对于“管理员同意说明”，请输入“允许经过身份验证的用户读取待办事项数据”。
    • 对于“状态”，请保持启用状态。
    • 选择“添加作用域”。

12. 重复上述步骤以添加其他两个作用域：ToDo.Write 和 ToDo.Delete。

    

3.3. 更新应用程序配置

使用以下步骤更新 YAML 文件，以通过 Microsoft Entra 注册的应用程序信息与 RESTful API 应用程序建立关系：

1. 找到 simple-todo-api 应用的 src/main/resources/application.yml 文件。 更新 spring.cloud.azure.active-directory 部分中的配置以匹配以下示例。 请务必将占位符替换为之前创建的值。

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   注意

   在 v1.0 令牌中，配置需要 API 的客户端 ID，而在 v2.0 令牌中，可以在请求中使用客户端 ID 或应用程序 ID URI。 可以同时配置这两项以正确完成受众验证。

   tenant-id 允许的值包括：common、organizations、consumers或租户 ID。 有关这些值的详细信息，请参阅错误 AADSTS50020 - 来自标识提供者的用户帐户不存在于租户中部分中的使用了错误的终结点（个人和组织帐户）部分。 有关转换单租户应用的信息，请参阅将单租户应用转换为 Microsoft Entra ID 上的多租户。

2. 使用以下命令重新生成示例项目：

   ./mvnw clean package
   

4. 将应用部署到 Azure Spring Apps

现在可以将应用部署到 Azure Spring Apps。

Azure 门户 + Maven 插件

按照以下步骤，使用适用于 Azure Spring Apps 的 Maven 插件进行部署：

1. 导航到完整目录，然后运行以下命令以在 Azure Spring Apps 中配置应用：

   ./mvnw com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config
   

   以下列表描述了命令交互：

   • OAuth2 登录：你需要根据 OAuth2 协议授权到 Azure 的登录。
   • 选择订阅：选择所创建的 Azure Spring Apps 实例的订阅列表编号，它默认为列表中的第一个订阅。 如果使用默认编号，请直接按 Enter。
   • 使用 Azure 中的现有 Azure Spring Apps：按 y 使用现有的 Azure Spring Apps 实例。
   • 选择要部署的 Azure Spring Apps：选择创建的 Azure Spring Apps 实例的编号。 如果使用默认编号，请直接按 Enter。
   • 在 Azure Spring Apps 中使用现有应用 <your-instance-name>：按 y 使用已创建的应用。
   • 确认保存上述所有配置：按 y。 如果按 n，则配置不会保存在 POM 文件中。

2. 使用以下命令部署应用：

   ./mvnw azure-spring-apps:deploy
   

   以下列表描述了命令交互：

   • OAuth2 登录：你需要根据 OAuth2 协议授权到 Azure 的登录。

   执行命令后，你会从以下日志消息中看到部署已成功：

[INFO] Deployment(default) is successfully created
[INFO] Starting Spring App after deploying artifacts...
[INFO] Deployment Status: Running
[INFO]   InstanceName:demo--default-xxxxxxx-xxxxxxxxx-xxxxx  Status:Running Reason:null       DiscoverStatus:NONE
[INFO] Getting public url of app(demo)...
[INFO] Application url: https://demo.<unique-identifier>.<region-name>.azurecontainerapps.io

Azure 开发人员 CLI

按照以下步骤打包应用，需要 Web 应用程序以预配 Azure 资源，然后才能部署到 Azure Spring Apps。

1. 运行以下命令，打包应用程序的可部署副本：

   azd package
   

2. 运行以下命令，将应用程序代码部署到这些新预配的资源：

   azd deploy
   

   控制台输出类似于以下示例的消息：

   Deploying services (azd deploy)
   
   WARNING: Feature 'springapp' is in alpha stage.
   To learn more about alpha features and their support, visit https://aka.ms/azd-feature-stages.
   
   ...
   
   Deploying service simple-todo-api (Fetching endpoints for spring app service)
   - Endpoint: https://simple-todo-api.xxxxxxxx-xxxxxxxx.xxxxxx.azurecontainerapps.io
   
   
   SUCCESS: Your application was deployed to Azure in xx minutes xx seconds.
   You can view the resources created under the resource group rg-<your-environment-name> in Azure Portal:
   https://portal.azure.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview
   

   输出“终结点”是用于访问待办事项 API 应用程序的基础终结点。

注意

还可使用 azd up 来组合上述三个命令：azd provision（预配 Azure 资源）、azd package（打包应用程序的可部署副本）和 azd deploy（部署应用程序代码）。 有关详细信息，请参阅 Azure-Samples/ASA-Samples-Restful-Application。

5. 验证应用

现在可以访问 RESTful API 以查看它是否正常工作。

5.1. 请求访问令牌

RESTful API 作用是资源服务器，它受到 Microsoft Entra ID 的保护。 在获取访问令牌之前，必须在 Microsoft Entra ID 中注册另一个应用程序，然后将权限授予名为“ToDoWeb”的客户端应用程序。

注册客户端应用程序

使用以下步骤在 Microsoft Entra ID 中注册应用程序，该应用程序用于向 ToDo 应用添加权限：

1. 登录 Azure 门户。

2. 如果有权访问多个租户，请使用“目录 + 订阅”筛选器 ()，选择要在其中注册应用程序的租户。

3. 搜索并选择 Microsoft Entra ID。

4. 在“管理”下，选择“应用注册”>“新建注册” 。

5. 在“名称”字段中输入应用程序的名称 - 例如“ToDoWeb”。 应用的用户可能会看到此名称，你稍后可对其进行更改。

6. 对于“支持的帐户类型”，请使用默认值“仅限此组织目录中的帐户”。

7. 选择“注册”以创建应用程序。

8. 在应用的“概述”页上，找到“应用程序(客户端) ID”值，然后记下该值以供后续使用 。 需要该值来获取访问令牌。

9. 选择“API 权限”>“添加权限”>“我的 API”。 选择之前注册的 ToDo 应用程序，然后选择“ToDo.Read”、“ToDo.Write”和“ToDo.Delete”权限。 选择“添加权限”。

10. 选择“为 <your-tenant-name> 授予管理员同意”，为添加的权限授予管理员同意。

    

添加用户以访问 RESTful API

使用以下步骤在 Microsoft Entra 租户中创建成员用户。 然后，用户可以通过 RESTful API 管理 ToDo 应用程序的数据。

1. 在“管理”下 ，选择“用户”>“新用户”>“创建新用户”。

2. 在“创建新用户”页上输入以下信息：

   • 用户主体名称：输入用户的名称。
   • 显示名称：输入用户的显示名称。
   • 密码复制“密码”框中提供的自动生成的密码。

   注意

   新用户必须完成首次登录身份验证并更新密码，否则，在获取访问令牌时会收到以下错误 AADSTS50055: The password is expired。

   新用户在登录时会收到“需要用户操作”的提示。 用户可以选择“稍后询问”以跳过验证。

3. 选择“查看 + 创建”，查看所选内容。 选择“创建”以创建用户。

为 Swagger UI 授权更新 OAuth2 配置

使用以下步骤为 Swagger UI 授权更新 OAuth2 配置。 然后，就可以授权用户通过 ToDoWeb 应用获取访问令牌。

1. 在 Azure 门户中打开“Microsoft Entra ID”租户，并转到已注册的 ToDoWeb 应用。

2. 在“管理”下，选择“身份验证”，选择“添加平台”，然后选择“单页应用程序”。

3. 使用 <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html 格式作为“重定向 URI”字段中的 OAuth2 重定向 URL，然后选择“配置”。

   

获取访问令牌

通过以下步骤使用 OAuth 2.0 授权代码流方法来获取具有 Microsoft Entra ID 的访问令牌，然后访问 ToDo 应用的 RESTful API：

1. 打开应用公开的 URL，然后选择“授权”以准备进行 OAuth2 身份验证。

2. 在“可用授权”窗口中，在“client_id”字段中输入 ToDoWeb 应用的客户端 ID，选择“作用域”字段的所有作用域，忽略“client_secret”字段，然后选择“授权”以重定向到 Microsoft Entra 登录页。

完成上一个用户的登录后，将返回到“可用授权”窗口。

5.2. 访问 RESTful API

通过以下步骤访问 Swagger UI 中 ToDo 应用的 RESTful API：

1. 选择 API“POST /api/simple-todo/lists”，然后选择“试用”。输入以下请求正文，然后选择“执行”以创建待办事项列表。

   {
     "name": "My List"
   }
   

   执行完成后，会看到以下“响应正文”：

   {
     "id": "<ID-of-the-ToDo-list>",
     "name": "My List",
     "description": null
   }
   

2. 选择 API“POST /api/simple-todo/lists/{listId}/items”，然后选择“试用”。对于“listId”，输入之前创建的待办事项列表 ID，输入以下请求正文，然后选择“执行”以创建待办事项项目。

   {
     "name": "My first ToDo item", 
     "listId": "<ID-of-the-ToDo-list>",
     "state": "todo"
   }
   

   此操作返回以下待办事项项目：

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": null,
     "state": "todo",
     "dueDate": "2023-07-11T13:59:24.9033069+08:00",
     "completedDate": null
   }
   

3. 选择 API“GET /api/simple-todo/lists”，然后选择“执行”以查询待办事项列表。 此操作返回以下待办事项列表：

   [
     {
       "id": "<ID-of-the-ToDo-list>",
       "name": "My List",
       "description": null
     }
   ]
   

4. 选择 API“GET /api/simple-todo/lists/{listId}/items”，然后选择“试用”。对于“listId”，输入之前创建的待办事项列表 ID，然后选择“执行”以查询待办事项项目。 此操作返回以下待办事项项目：

   [
     {
       "id": "<ID-of-the-ToDo-item>",
       "listId": "<ID-of-the-ToDo-list>",
       "name": "My first ToDo item",
       "description": null,
       "state": "todo",
       "dueDate": "2023-07-11T13:59:24.903307+08:00",
       "completedDate": null
     }
   ]
   

5. 选择 API“PUT /api/simple-todo/lists/{listId}/items/{itemId}”，然后选择“试用”。对于“listId”，请输入待办事项列表 ID。 对于“itemId”，输入待办事项 ID，输入以下请求正文，然后选择“执行”以更新待办事项项目。

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": "Updated description.",
     "dueDate": "2023-07-11T13:59:24.903307+08:00",
     "state": "inprogress"
   }
   

   此操作返回以下更新的待办事项项目：

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": "Updated description.",
     "state": "inprogress",
     "dueDate": "2023-07-11T05:59:24.903307Z",
     "completedDate": null
   }
   

6. 选择 API“DELETE /api/simple-todo/lists/{listId}/items/{itemId}”，然后选择“试用”。对于“listId”，请输入待办事项列表 ID。 对于“itemId”，输入待办事项 ID，然后选择“执行”以删除待办事项项目。 这时会看到服务器响应代码为 204。

6.清理资源

可以删除 Azure 资源组，其中包括资源组中的所有资源。

Azure 门户 + Maven 插件

按照以下步骤删除整个资源组（包括新创建的服务器）：

1. 在 Azure 门户中查找资源组。

2. 在导航菜单上，选择“资源组”。 然后选择资源组的名称 - 例如 myresourcegroup。

3. 在资源组页上，选择“删除”。 在文本框中输入资源组的名称（例如 myresourcegroup）以确认删除。 然后选择“删除”。

Azure CLI

使用以下命令删除整个资源组，包括新创建的服务：

az group delete --name ${RESOURCE_GROUP}

Azure 门户 + Maven 插件

按照以下步骤删除整个资源组（包括新创建的服务器）：

1. 在 Azure 门户中查找资源组。

2. 在导航菜单上，选择“资源组”。 然后选择资源组的名称 - 例如 myresourcegroup。

3. 在资源组页上，选择“删除”。 在文本框中输入资源组的名称（例如 myresourcegroup）以确认删除。 然后选择“删除”。

Azure 开发人员 CLI

使用以下命令删除此示例应用程序中使用的所有 Azure 资源：

azd down

以下列表描述了命令交互：

• 要删除的资源总数：[your-resources-total]，是否确实要继续？：按 y。

控制台输出类似于以下示例的消息：

SUCCESS: Your application was removed from Azure in xx minutes xx seconds.

7. 后续步骤

快速入门：将事件驱动的应用程序部署到 Azure Spring Apps

快速入门：将微服务应用程序部署到 Azure Spring Apps

Azure Spring Apps 的结构化应用程序日志

将现有自定义域映射到 Azure Spring Apps

将 Azure Spring Apps CI/CD 与 GitHub Actions 配合使用

自动将应用程序部署到 Azure Spring Apps

有关详细信息，请参阅以下文章：

• Azure Spring Apps 示例。
• Azure 上的 Spring
• Spring Cloud Azure