Краткое руководство. Развертывание приложения API RESTful в Azure Spring Apps

Примечание.

Первые 50 виртуальных ЦП и 100 ГБ памяти освобождаются каждый месяц. Дополнительные сведения см. в статье "Сокращение цен" — Azure Spring Apps делает больше, затраты меньше! в приложениях в блоге Azure.

Примечание.

Azure Spring Apps — это новое название службы Azure Spring Cloud. Старое название будет еще некоторое время встречаться в наших материалах, пока мы не обновим ресурсы, такие как снимки экрана, видео и схемы.

В этой статье описывается, как развернуть приложение API RESTful, защищенное идентификатором Microsoft Entra в Azure Spring Apps. Пример проекта — это упрощенная версия на основе простого веб-приложения Todo , который предоставляет только серверную службу и использует идентификатор Microsoft Entra для защиты API RESTful.

Эти API RESTful защищены путем применения управления доступом на основе ролей (RBAC). Анонимные пользователи не могут получить доступ к данным и не могут управлять доступом для разных пользователей. Анонимные пользователи имеют только следующие три разрешения:

• Чтение. С этим разрешением пользователь может считывать данные ToDo.
• Запись. С помощью этого разрешения пользователь может добавлять или обновлять данные ToDo.
• Удаление: с этим разрешением пользователь может удалить данные ToDo.

После успешного развертывания можно просматривать и тестировать API с помощью пользовательского интерфейса Swagger.

На следующей схеме показана архитектура системы:

В этой статье описаны следующие варианты создания ресурсов и их развертывания в Azure Spring Apps:

• Параметр подключаемого модуля портал Azure + Maven предоставляет более обычный способ создания ресурсов и развертывания приложений пошаговые инструкции. Этот вариант подходит для разработчиков Spring с помощью облачных служб Azure впервые.
• Вариант командной строки разработчика Azure — это более эффективный способ автоматического создания ресурсов и развертывания приложений с помощью простых команд. Azure Developer CLI использует шаблон для подготовки необходимых ресурсов Azure и развертывания кода приложения. Этот вариант подходит для разработчиков Spring, знакомых с облачными службами Azure.

В этой статье описаны следующие варианты создания ресурсов и их развертывания в Azure Spring Apps:

• Параметр подключаемого модуля портал Azure + Maven предоставляет более обычный способ создания ресурсов и развертывания приложений пошаговые инструкции. Этот вариант подходит для разработчиков Spring с помощью облачных служб Azure впервые.
• Параметр Azure CLI использует мощное средство командной строки для управления ресурсами Azure. Этот вариант подходит для разработчиков Spring, знакомых с облачными службами Azure.

1. Предварительные требования

портал Azure + подключаемый модуль Maven

• Подписка Azure. Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.

• Одна из следующих ролей:

  • Глобальный администратор или Администратор привилегированных ролей для предоставления согласия для приложений, запрашивающих любое разрешение для любого API.
  • Cloud Application Администратор istrator или Application Администратор istrator для предоставления согласия для приложений, запрашивающих любое разрешение для любого API, кроме ролей приложений Microsoft Graph (разрешений приложения).
  • Настраиваемая роль каталога, которая включает разрешение на предоставление приложениям разрешений для разрешений, необходимых приложению.

  Дополнительные сведения см. в разделе Предоставление согласия администратора на уровне клиента приложению.

• Если вы развертываете экземпляр плана Azure Spring Apps Enterprise впервые в целевой подписке, см. раздел "Требования" плана Enterprise в Azure Marketplace.

• Git.

• Пакет средств разработки Java (JDK) версии 17.

• Клиент Microsoft Entra. Инструкции по созданию объекта см. в кратком руководстве по созданию нового клиента в идентификаторе Microsoft Entra.

Azure CLI

• Подписка Azure, если у вас нет подписки Azure, создайте бесплатную учетную запись Azure перед началом работы.

• Одна из следующих ролей:

  • Глобальный администратор или Администратор привилегированных ролей для предоставления согласия для приложений, запрашивающих любое разрешение для любого API.
  • Cloud Application Администратор istrator или Application Администратор istrator для предоставления согласия для приложений, запрашивающих любое разрешение для любого API, кроме ролей приложений Microsoft Graph (разрешений приложения).
  • Настраиваемая роль каталога, которая включает разрешение на предоставление приложениям разрешений для разрешений, необходимых приложению.

  Дополнительные сведения см. в разделе Предоставление согласия администратора на уровне клиента приложению.

• Если вы развертываете экземпляр плана Azure Spring Apps Enterprise впервые в целевой подписке, см. раздел "Требования" плана Enterprise в Azure Marketplace.

• Git.

• Пакет средств разработки Java (JDK) версии 17.

• Клиент Microsoft Entra. Инструкции по созданию объекта см. в кратком руководстве по созданию нового клиента в идентификаторе Microsoft Entra.

• Azure CLI версии 2.53.1 или более поздней.

портал Azure + подключаемый модуль Maven

• Подписка Azure, если у вас нет подписки Azure, создайте бесплатную учетную запись Azure перед началом работы.

• Одна из следующих ролей:

  • Глобальный администратор или Администратор привилегированных ролей для предоставления согласия для приложений, запрашивающих любое разрешение для любого API.
  • Cloud Application Администратор istrator или Application Администратор istrator для предоставления согласия для приложений, запрашивающих любое разрешение для любого API, кроме ролей приложений Microsoft Graph (разрешений приложения).
  • Настраиваемая роль каталога, которая включает разрешение на предоставление приложениям разрешений для разрешений, необходимых приложению.

  Дополнительные сведения см. в разделе Предоставление согласия администратора на уровне клиента приложению.

• Git.

• Пакет средств разработки Java (JDK) версии 17.

• Клиент Microsoft Entra. Инструкции по созданию объекта см. в кратком руководстве по созданию нового клиента в идентификаторе Microsoft Entra.

Интерфейс командной строки разработчика Azure

• Подписка Azure, если у вас нет подписки Azure, создайте бесплатную учетную запись Azure перед началом работы.

• Одна из следующих ролей:

  • Глобальный администратор или Администратор привилегированных ролей для предоставления согласия для приложений, запрашивающих любое разрешение для любого API.
  • Cloud Application Администратор istrator или Application Администратор istrator для предоставления согласия для приложений, запрашивающих любое разрешение для любого API, кроме ролей приложений Microsoft Graph (разрешений приложения).
  • Настраиваемая роль каталога, которая включает разрешение на предоставление приложениям разрешений для разрешений, необходимых приложению.

  Дополнительные сведения см. в разделе "Предоставление согласия администратора".

• Git.

• Пакет средств разработки Java (JDK) версии 17.

• Клиент Microsoft Entra. Инструкции по созданию объекта см. в кратком руководстве по созданию нового клиента в идентификаторе Microsoft Entra.

• Azure Developer CLI (AZD), версия 1.0.2 или более поздняя.

2. Подготовка проекта Spring

Чтобы развернуть приложение API RESTful, сначала необходимо подготовить проект Spring для локального запуска.

Выполните следующие действия, чтобы клонировать и запустить приложение локально:

1. Используйте следующую команду, чтобы клонировать пример проекта из GitHub:

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

2. Если вы хотите локально запустить приложение, выполните действия, описанные в разделах "Предоставление API RESTful" и обновление разделов конфигурации приложения, а затем выполните следующую команду, чтобы запустить пример приложения с Maven:

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

3. Подготовка облачной среды

Основными ресурсами, необходимыми для запуска этого примера приложения, являются экземпляр Azure Spring Apps и экземпляр База данных Azure для PostgreSQL. В следующих разделах описывается создание этих ресурсов.

портал Azure + подключаемый модуль Maven

3.1. Войдите на портал Azure

Перейдите к портал Azure и введите учетные данные для входа на портал. Панель мониторинга службы является представлением по умолчанию.

3.2. Создание экземпляра Azure Spring Apps

Чтобы создать экземпляр службы Azure Spring Apps, выполните следующие действия.

1. Выберите "Создать ресурс" в углу портал Azure.

2. Выберите Compute>Azure Spring Apps.

3. Заполните форму Основные данные , указав следующую информацию:

   Параметр	Предлагаемое значение	Description
   Подписка	Имя подписки.	Подписка Azure, которую вы хотите использовать для сервера. Если у вас есть несколько подписок, выберите ту, через которую вы предпочитаете оплачивать этот ресурс.
   Группа ресурсов	myresourcegroup	Новое имя группы ресурсов или уже имеющееся из подписки.
   Имя	myasa	Уникальное имя, определяющее службу Azure Spring Apps. Его длина должна быть от 4 до 32 знаков. Имя может содержать только строчные буквы, цифры и дефисы. Первым символом в имени службы должна быть буква, а последним — буква или цифра.
   План	Функции корпоративного уровня	План ценообразования, определяющий ресурс и затраты, связанные с экземпляром.
   Регион	Регион, ближайший к вашим пользователям.	Ближайшее к пользователям расположение.
   Избыточность между зонами	Флажок снят	Параметр создания службы Azure Spring Apps в зоне доступности Azure. Эта функция в настоящее время не поддерживается во всех регионах.
   План IP-адресов программного обеспечения	Оплата по мере использования	План ценообразования, который позволяет платить по мере использования Azure Spring Apps.
   Terms	Выбрано	Соглашение проверка box, связанное с предложением Marketplace. Вам потребуется выбрать этот проверка box.
   Развертывание примера проекта	Флажок снят	Параметр для использования встроенного примера приложения.

4. Выберите "Рецензирование" и " Создать ", чтобы просмотреть выбранные варианты. Затем выберите "Создать ", чтобы подготовить экземпляр Azure Spring Apps.

5. На панели инструментов щелкните значок Уведомления (колокольчик), чтобы отслеживать процесс развертывания. После завершения развертывания можно выбрать "Закрепить на панели мониторинга", которая создает плитку для этой службы на панели мониторинга портал Azure в качестве ярлыка на странице обзора службы.

   

6. Выберите "Перейти к ресурсу", чтобы перейти на страницу обзора Azure Spring Apps.

3.3. Подготовка экземпляра PostgreSQL

Чтобы создать сервер База данных Azure для PostgreSQL, выполните следующие действия.

1. Перейдите к портал Azure и нажмите кнопку "Создать ресурс".

2. Выберите Базы данных>База данных Azure для PostgreSQL.

3. Выберите вариант развертывания Гибкий сервер.

   

4. Заполните вкладку "Основные сведения" следующими сведениями :

   • Имя сервера: my-demo-pgsql
   • Регион: восточная часть США
   • Версия PostgreSQL: 14
   • Тип рабочей нагрузки: разработка
   • Включение высокой доступности: не выбрано
   • Метод проверки подлинности: только проверка подлинности PostgreSQL
   • имя пользователя Администратор: myadmin
   • Пароль и подтверждение пароля: введите пароль.

5. Чтобы настроить вкладку "Сеть" , используйте следующие сведения:

   • метод Подключение ivity: общедоступный доступ (разрешенные IP-адреса)
   • Разрешить общедоступный доступ из любой службы Azure в Azure на этот сервер: выбрано:

6. Выберите "Проверка и создание ", чтобы просмотреть выбранные элементы, и нажмите кнопку "Создать ", чтобы подготовить сервер. Эта операция может занять несколько минут.

7. Перейдите на сервер PostgreSQL в портал Azure. На странице обзора найдите значение имени сервера и запишите его для последующего использования. Необходимо настроить переменные среды для приложения в Azure Spring Apps.

8. Выберите базы данных из меню навигации, чтобы создать базу данных, например todo.

   

3.4. Подключение экземпляр приложения в экземпляр PostgreSQL

Чтобы подключить экземпляры службы, выполните следующие действия.

1. Перейдите к экземпляру своей службы Azure Spring Apps на портале Azure.

2. В меню навигации откройте приложения и нажмите кнопку "Создать приложение".

3. На странице "Создание приложения" введите имя приложения simple-todo-api и выберите артефакты Java в качестве типа развертывания.

4. Нажмите кнопку "Создать ", чтобы завершить создание приложения, а затем выберите приложение для просмотра сведений.

5. Перейдите к приложению, созданному в портал Azure. На странице "Обзор" выберите "Назначить конечную точку", чтобы предоставить общедоступную конечную точку для приложения. Сохраните URL-адрес для доступа к приложению после развертывания.

6. Выберите службу Подключение из области навигации, а затем нажмите кнопку "Создать", чтобы создать подключение к службе.

   

7. Заполните вкладку "Основные сведения" следующими сведениями :

   • Тип службы: гибкий сервер базы данных для PostgreSQL
   • Подключение имя: заполняется автоматически созданное имя, которое также можно изменить.
   • Подписка. Выберите нужную подписку.
   • Гибкий сервер PostgreSQL: my-demo-pgsql
   • База данных PostgreSQL: выберите созданную базу данных.
   • Тип клиента: SpringBoot

   

8. Настройте вкладку "Далее: проверка подлинности " со следующими сведениями:

   • Выберите тип проверки подлинности, который вы хотите использовать между вычислительной службой и целевой службой. Выберите строку Подключение ion.
   • Продолжить с...: выбор учетных данных базы данных
   • Имя пользователя: myadmin
   • Пароль. Введите пароль.

   

9. Выберите Далее: сеть. Используйте параметр по умолчанию Настройка правил брандмауэра для включения доступа к целевой службе.

10. Нажмите кнопку "Далее" и "Создать ", чтобы просмотреть выбранные элементы, а затем нажмите кнопку "Создать ", чтобы создать подключение.

3.5. Предоставление API RESTful

Чтобы предоставить API RESTful в идентификаторе Microsoft Entra, выполните следующие действия.

1. Войдите на портал Azure.

2. Если у вас есть доступ к нескольким клиентам, используйте фильтр каталогов и подписок ( ) для выбора клиента, в котором требуется зарегистрировать приложение.

3. Найдите и выберите Microsoft Entra ID.

4. В разделе Управление выберите Регистрация приложений>Создать регистрацию.

5. Введите имя приложения в поле "Имя ", например Todo. Пользователи приложения могут видеть это имя. Вы можете изменить его позже.

6. Для поддерживаемых типов учетных записей выберите учетные записи в любом каталоге организации (любой каталог Microsoft Entra — Multitenant) и личных учетных записей Майкрософт.

7. Выберите Зарегистрировать, чтобы создать приложение.

8. На странице приложения Обзор найдите идентификатор приложения (клиента) и запишите его, чтобы использовать позже. Вам потребуется настроить файл конфигурации YAML для этого проекта.

9. В разделе "Управление" выберите "Предоставить API", найдите URI идентификатора приложения в начале страницы и нажмите кнопку "Добавить".

10. На странице "Изменение идентификатора приложения" примите предлагаемый URI идентификатора приложения (api://{client ID}) или используйте понятное имя вместо идентификатора клиента, например api://simple-todo, а затем нажмите кнопку "Сохранить".

11. В разделе "Управление" выберите "Предоставить API>Добавить область", а затем введите следующие сведения:

    • В поле "Имя области" введите ToDo.Read.
    • Для Кто может быть предоставлено согласие, выберите только Администратор.
    • Для отображаемого имени согласия Администратор введите данные ToDo.
    • В поле Администратор описание согласия введите "Разрешить пользователям, прошедшим проверку подлинности", считывать данные ToDo.
    • Для состояния оставьте его включенным.
    • Выберите Добавить область.

12. Повторите предыдущие шаги, чтобы добавить два других область: ToDo.Write и ToDo.Delete.

    

3.6. Обновление конфигурации приложения

Чтобы обновить YAML-файл, чтобы использовать сведения о зарегистрированном приложении Microsoft Entra, выполните следующие действия, чтобы установить связь с приложением API RESTful:

1. Найдите файл src/main/resources/application.yml для simple-todo-api приложения. Обновите конфигурацию в 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>
   

   Примечание.

   В маркерах версии 1.0 конфигурация требует идентификатор клиента API, а в маркерах версии 2.0 можно использовать идентификатор клиента или URI идентификатора приложения в запросе. Вы можете настроить оба способа правильного завершения проверки аудитории.

   Допустимые значенияtenant-id: common, organizationsconsumersили идентификатор клиента. Дополнительные сведения об этих значениях см. в разделе "Использована неправильная конечная точка (личные и учетные записи организации) в разделе "Ошибка" AADSTS50020 . Учетная запись пользователя от поставщика удостоверений не существует в клиенте. Сведения о преобразовании приложения с одним клиентом см. в разделе "Преобразование однотенантного приложения в мультитенантный" в идентификатор Microsoft Entra.

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. Используйте следующую команду, чтобы получить список всех доступных подписок, чтобы определить идентификатор подписки для использования:

   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 Spring Apps для Azure CLI и зарегистрировать Microsoft.SaaS пространство имен:

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

3.4. Создание экземпляра Azure Spring Apps

Выполните следующие действия, чтобы создать экземпляр службы и приложение в экземпляре:

1. Используйте следующую команду, чтобы принять юридические условия и заявления о конфиденциальности для плана Enterprise:

   Примечание.

   Этот шаг необходим, только если подписка никогда не использовалась для создания экземпляра плана Enterprise в Azure Spring Apps.

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

2. Чтобы создать экземпляр службы "Приложения Azure Spring", используйте следующую команду:

   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 использует H2 для базы данных в localhost и База данных Azure для 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. Предоставление API RESTful

Чтобы предоставить API RESTful, выполните следующие действия.

1. Чтобы создать приложение идентификатора Microsoft Entra, используйте следующую команду:

   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. Используйте следующую команду для создания идентификаторов разрешений:

   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. Используйте следующую команду, чтобы получить идентификатор клиента для использования на следующем шаге:

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

7. Используйте следующую команду, чтобы получить идентификатор приложения для использования в следующих шагах:

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

3.8. Обновление конфигурации приложения

Чтобы обновить YAML-файл, чтобы использовать сведения о зарегистрированном приложении Microsoft Entra, выполните следующие действия, чтобы установить связь с приложением API RESTful:

1. Найдите файл src/main/resources/application.yml для simple-todo-api приложения. Обновите конфигурацию в 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>
   

   Примечание.

   В маркерах версии 1.0 конфигурация требует идентификатор клиента API, а в маркерах версии 2.0 можно использовать идентификатор клиента или URI идентификатора приложения в запросе. Вы можете настроить оба способа правильного завершения проверки аудитории.

   Допустимые значенияtenant-id: common, organizationsconsumersили идентификатор клиента. Дополнительные сведения об этих значениях см. в разделе "Использована неправильная конечная точка (личные и учетные записи организации) в разделе "Ошибка" AADSTS50020 . Учетная запись пользователя от поставщика удостоверений не существует в клиенте. Сведения о преобразовании приложения с одним клиентом см. в разделе "Преобразование однотенантного приложения в мультитенантный" в идентификатор Microsoft Entra.

2. Чтобы перестроить пример проекта, используйте следующую команду:

   ./mvnw clean package
   

4. Развертывание приложения в Azure Spring Apps

портал Azure + подключаемый модуль Maven

Теперь вы можете развернуть приложение в Azure Spring Apps.

Выполните следующие действия, чтобы развернуть с помощью подключаемого модуля Maven для Azure Spring Apps:

1. Перейдите к полному каталогу и выполните следующую команду, чтобы настроить приложение в Azure Spring Apps:

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

   В следующем списке описаны взаимодействия с командами:

   • Вход OAuth2: необходимо авторизовать вход в Azure на основе протокола OAuth2.
   • Выберите подписку: выберите номер списка подписок созданного экземпляра Azure Spring Apps, который по умолчанию соответствует первой подписке в списке. Если вы используете номер по умолчанию, нажмите клавишу ВВОД напрямую.
   • Используйте существующие Azure Spring Apps в Azure: нажмите y , чтобы использовать существующий экземпляр Azure Spring Apps.
   • Выберите Azure Spring Apps для развертывания: выберите номер созданного экземпляра Azure Spring Apps. Если вы используете номер по умолчанию, нажмите клавишу ВВОД напрямую.
   • Используйте существующее приложение в Azure Spring Apps <с именем> экземпляра: нажмите клавишу Y , чтобы использовать созданное приложение.
   • Подтвердите сохранение всех указанных выше конфигураций: нажмите клавишу Y. Если нажать клавишу N, конфигурация не сохраняется в POM-файлах.

2. Чтобы развернуть приложение, используйте следующую команду:

   ./mvnw azure-spring-apps:deploy
   

   В следующем списке описывается взаимодействие с командой:

   • Вход OAuth2: необходимо авторизовать вход в Azure на основе протокола OAuth2.

   После выполнения команды можно увидеть в следующих сообщениях журнала, что развертывание выполнено успешно:

[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

Теперь вы можете получить доступ к API RESTful, чтобы узнать, работает ли он.

5.1. Запросите маркер доступа

API RESTful действуют как сервер ресурсов, защищенный идентификатором Microsoft Entra. Перед получением маркера доступа необходимо зарегистрировать другое приложение в идентификаторе Microsoft Entra и предоставить разрешения клиентскому приложению, которое называется ToDoWeb.

Регистрация клиентского приложения

Чтобы зарегистрировать приложение в идентификаторе Microsoft Entra, которое используется для добавления разрешений для ToDo приложения, выполните следующие действия.

1. Войдите на портал Azure.

2. Если у вас есть доступ к нескольким клиентам, используйте фильтр каталогов и подписок ( ) для выбора клиента, в котором требуется зарегистрировать приложение.

3. Найдите и выберите Microsoft Entra ID.

4. В разделе Управление выберите Регистрация приложений>Создать регистрацию.

5. Введите имя приложения в поле "Имя ", например ToDoWeb. Пользователи приложения могут видеть это имя. Вы можете изменить его позже.

6. Для поддерживаемых типов учетных записей используйте только учетные записи по умолчанию в этом каталоге организации.

7. Выберите Зарегистрировать, чтобы создать приложение.

8. На странице приложения Обзор найдите идентификатор приложения (клиента) и запишите его, чтобы использовать позже. Он необходим для получения маркера доступа.

9. Выберите Разрешения API>Добавить разрешение>Мои API. ToDo Выберите приложение, зарегистрированное ранее, и выберите разрешения ToDo.Read, ToDo.Write и ToDo.Delete. Выберите Добавить разрешения.

10. Выберите "Предоставить согласие администратора" для имени> клиента, <чтобы предоставить согласие администратора для добавленных разрешений.

    

Добавление пользователя для доступа к API RESTful

Выполните следующие действия, чтобы создать пользователя-участника в клиенте Microsoft Entra. Затем пользователь может управлять данными ToDo приложения с помощью API RESTful.

1. В разделе "Управление" выберите "Пользователи>" Создать пользователя.>

2. На странице "Создание нового пользователя" введите следующие сведения:

   • Имя участника-пользователя: введите имя пользователя.
   • Отображаемое имя: введите отображаемое имя пользователя.
   • Пароль. Скопируйте автоматически созданный пароль, указанный в поле "Пароль".

   Примечание.

   Новые пользователи должны завершить проверку подлинности первого входа и обновить пароли, в противном случае при получении маркера доступа возникает AADSTS50055: The password is expired ошибка.

   Когда новый пользователь входит в систему, он получает запрос на обязательное действие. Они могут выбрать запрос позже , чтобы пропустить проверку.

3. Выберите Просмотр и создание , чтобы просмотреть выбранные элементы. Нажмите кнопку "Создать" , чтобы создать пользователя.

Обновление конфигурации OAuth2 для авторизации пользовательского интерфейса Swagger

Чтобы обновить конфигурацию OAuth2 для авторизации пользовательского интерфейса Swagger, выполните следующие действия. Затем вы можете авторизовать пользователей для получения маркеров доступа через ToDoWeb приложение.

1. Откройте клиент Идентификатора Microsoft Entra в портал Azure и перейдите в зарегистрированное ToDoWeb приложение.

2. В разделе "Управление" выберите "Проверка подлинности", выберите "Добавить платформу" и выберите одностраничные приложения.

3. Используйте формат <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html в качестве URL-адреса перенаправления OAuth2 в поле URI перенаправления и нажмите кнопку "Настроить".

   

Azure CLI

Теперь вы можете получить доступ к API RESTful, чтобы узнать, работает ли он.

5.1. Запросите маркер доступа

API RESTful действуют как сервер ресурсов, защищенный идентификатором Microsoft Entra. Перед получением маркера доступа необходимо зарегистрировать другое приложение в идентификаторе Microsoft Entra и предоставить разрешения клиентскому приложению, которое называется ToDoWeb.

Регистрация клиентского приложения

Чтобы зарегистрировать клиентское приложение, выполните следующие действия.

1. Используйте следующую команду, чтобы создать приложение идентификатора Microsoft Entra, которое используется для добавления разрешений для 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 на шаге получения маркера доступа:

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

Добавление пользователя для доступа к API RESTful

Используйте следующую команду, чтобы создать пользователя-участника в клиенте Microsoft Entra. Затем пользователь может управлять данными ToDo приложения с помощью API RESTful:

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

Обновление конфигурации OAuth2 для авторизации пользовательского интерфейса Swagger

Чтобы обновить конфигурацию OAuth2, выполните следующие действия.

1. Чтобы получить идентификатор ToDoWeb объекта приложения, используйте следующую команду:

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

2. Чтобы получить URL-адрес simple-todo-api приложения, используйте следующую команду:

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

3. Используйте следующую команду, чтобы обновить конфигурацию OAuth2 для авторизации пользовательского интерфейса Swagger, заменив <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

Чтобы развернуть приложение API RESTful, сначала необходимо подготовить проект Spring для локального запуска.

портал Azure + подключаемый модуль Maven

Выполните следующие действия, чтобы клонировать и запустить приложение локально:

1. Используйте следующую команду, чтобы клонировать пример проекта из GitHub:

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

2. Если вы хотите локально запустить приложение, выполните действия, описанные в разделах "Предоставление API RESTful" и обновление разделов конфигурации приложения, а затем выполните следующую команду, чтобы запустить пример приложения с Maven:

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

Интерфейс командной строки разработчика Azure

Выполните следующие действия, чтобы инициализировать веб-приложение из шаблонов Azure Developer CLI:

1. Откройте терминал, создайте пустую папку и измените его.

2. Выполните следующую команду, чтобы инициализировать проект:

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

   В следующем списке описаны взаимодействия с командами:

   • Вход OAuth2: необходимо авторизовать вход в Azure на основе протокола OAuth2.
   • Введите новое имя среды: укажите имя среды. Это имя используется в качестве суффикса для группы ресурсов, созданной для хранения всех ресурсов 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 для PostgreSQL. В следующих разделах описывается создание этих ресурсов.

портал Azure + подключаемый модуль Maven

3.1. Войдите на портал Azure

Перейдите к портал Azure и введите учетные данные для входа на портал. Панель мониторинга службы является представлением по умолчанию.

3.2. Создание экземпляра Azure Spring Apps

Чтобы создать экземпляр службы, выполните следующие действия.

1. Выберите " Создать ресурс " в углу портала.

2. Выберите Compute>Azure Spring Apps.

3. Заполните форму Основные сведения. Используйте следующую таблицу в качестве руководства для завершения формы. Рекомендуемое значение плана — "Стандартный" и "Стандартный" (предварительная версия).

   Параметр	Предлагаемое значение	Description
   Подписка	Имя подписки.	Подписка Azure, которую вы хотите использовать для сервера. Если у вас есть несколько подписок, выберите ту, через которую вы предпочитаете оплачивать этот ресурс.
   Группа ресурсов	myresourcegroup	Новое имя группы ресурсов или уже имеющееся из подписки.
   Имя	myasa	Уникальное имя, определяющее службу Azure Spring Apps. Его длина должна быть от 4 до 32 знаков. Имя может содержать только строчные буквы, цифры и дефисы. Первым символом в имени службы должна быть буква, а последним — буква или цифра.
   План	Стандартное потребление и выделенное (предварительная версия)	План ценообразования определяет ресурсы и затраты, связанные с вашим экземпляром.
   Регион	Регион, ближайший к вашим пользователям.	Ближайшее к пользователям расположение.
   Среда приложений-контейнеров	myenvironment	Параметр выбора экземпляра среды "Приложения контейнеров" для совместного использования одной виртуальной сети с другими службами и ресурсами.

   Используйте следующую таблицу в качестве руководства по созданию среды приложений контейнеров:

   Параметр	Предлагаемое значение	Description
   Имя среды	myenvironment	Уникальное имя, определяющее службу среды приложений контейнеров Azure.
   План	Потребление	План ценообразования определяет ресурсы и затраты, связанные с вашим экземпляром.
   Избыточность между зонами	Выключено	Параметр создания службы "Среда приложений контейнеров" в зоне доступности Azure.

4. Выберите "Рецензирование" и " Создать ", чтобы просмотреть выбранные варианты. Затем выберите "Создать ", чтобы подготовить экземпляр Azure Spring Apps.

5. На панели инструментов щелкните значок Уведомления (колокольчик), чтобы отслеживать процесс развертывания. После завершения развертывания можно выбрать "Закрепить на панели мониторинга", которая создает плитку для этой службы на панели мониторинга портал Azure в качестве ярлыка на странице обзора службы.

6. Выберите "Перейти к ресурсу", чтобы открыть страницу обзора службы.

   

Важно!

Профиль рабочей нагрузки потребления имеет модель выставления счетов по мере использования без начальной стоимости. Плата за выделенный профиль рабочей нагрузки взимается на основе подготовленных ресурсов. Дополнительные сведения см. в разделе "Профили рабочей нагрузки" в службах контейнеров Azure и ценах на Azure Spring Apps.

3.3. Подготовка экземпляра PostgreSQL

Чтобы создать сервер База данных Azure для PostgreSQL, выполните следующие действия.

1. Перейдите к портал Azure и нажмите кнопку "Создать ресурс".

2. Выберите Базы данных>База данных Azure для PostgreSQL.

3. Выберите вариант развертывания Гибкий сервер.

   

4. Заполните вкладку "Основные сведения" следующими сведениями :

   • Имя сервера: my-demo-pgsql
   • Регион: восточная часть США
   • Версия PostgreSQL: 14
   • Тип рабочей нагрузки: разработка
   • Включение высокой доступности: не выбрано
   • Метод проверки подлинности: только проверка подлинности PostgreSQL
   • имя пользователя Администратор: myadmin
   • Пароль и подтверждение пароля: введите пароль.

5. Чтобы настроить вкладку "Сеть" , используйте следующие сведения:

   • метод Подключение ivity: общедоступный доступ (разрешенные IP-адреса)
   • Разрешить общедоступный доступ из любой службы Azure в Azure на этот сервер: выбрано:

6. Выберите "Проверка и создание ", чтобы просмотреть выбранные элементы, и нажмите кнопку "Создать ", чтобы подготовить сервер. Эта операция может занять несколько минут.

7. Перейдите на сервер PostgreSQL в портал Azure. На странице обзора найдите значение имени сервера и запишите его для последующего использования. Необходимо настроить переменные среды для приложения в Azure Spring Apps.

8. Выберите базы данных из меню навигации, чтобы создать базу данных, например todo.

   

3.4. Подключение экземпляр приложения в экземпляр PostgreSQL

Чтобы подключить экземпляры службы, выполните следующие действия.

1. Перейдите к экземпляру своей службы Azure Spring Apps на портале Azure.

2. В меню навигации откройте приложения и нажмите кнопку "Создать приложение".

3. На странице "Создание приложения" введите имя приложения simple-todo-api и выберите артефакты Java в качестве типа развертывания.

4. Нажмите кнопку "Создать ", чтобы завершить создание приложения и выбрать приложение для просмотра сведений.

5. Перейдите к приложению, созданному в портал Azure. На странице "Обзор" выберите "Назначить конечную точку", чтобы предоставить общедоступную конечную точку для приложения. Сохраните URL-адрес для доступа к приложению после развертывания.

6. Перейдите к созданному приложению, разверните Параметры и выберите "Конфигурация" в меню навигации, а затем выберите переменные среды, чтобы задать переменные среды.

7. Добавьте следующие переменные среды для подключения PostgreSQL и нажмите кнопку "Сохранить ", чтобы завершить обновление конфигурации приложения. Обязательно замените заполнители собственными значениями, созданными ранее.

   Переменная среды	Значение
   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. Предоставление API RESTful

Чтобы предоставить API RESTful в идентификаторе Microsoft Entra, выполните следующие действия.

1. Войдите на портал Azure.

2. Если у вас есть доступ к нескольким клиентам, используйте фильтр каталогов и подписок ( ) для выбора клиента, в котором требуется зарегистрировать приложение.

3. Найдите и выберите Microsoft Entra ID.

4. В разделе Управление выберите Регистрация приложений>Создать регистрацию.

5. Введите имя приложения в поле "Имя ", например Todo. Пользователи приложения могут видеть это имя. Вы можете изменить его позже.

6. Для поддерживаемых типов учетных записей выберите учетные записи в любом каталоге организации (любой каталог Microsoft Entra — Multitenant) и личных учетных записей Майкрософт.

7. Выберите Зарегистрировать, чтобы создать приложение.

8. На странице приложения Обзор найдите идентификатор приложения (клиента) и запишите его, чтобы использовать позже. Вам потребуется настроить файл конфигурации YAML для этого проекта.

9. В разделе "Управление" выберите "Предоставить API", найдите URI идентификатора приложения в начале страницы и нажмите кнопку "Добавить".

10. На странице "Изменение идентификатора приложения" примите предлагаемый URI идентификатора приложения (api://{client ID}) или используйте понятное имя вместо идентификатора клиента, например api://simple-todo, а затем нажмите кнопку "Сохранить".

11. В разделе "Управление" выберите "Предоставить API>Добавить область", а затем введите следующие сведения:

    • В поле "Имя области" введите ToDo.Read.
    • Для Кто может быть предоставлено согласие, выберите только Администратор.
    • Для отображаемого имени согласия Администратор введите данные ToDo.
    • В поле Администратор описание согласия введите "Разрешить пользователям, прошедшим проверку подлинности", считывать данные ToDo.
    • Для состояния оставьте его включенным.
    • Выберите Добавить область.

12. Повторите предыдущие шаги, чтобы добавить два других область: ToDo.Write и ToDo.Delete.

    

3.6. Обновление конфигурации приложения

Чтобы обновить YAML-файл, чтобы использовать сведения о зарегистрированном приложении Microsoft Entra, выполните следующие действия, чтобы установить связь с приложением API RESTful:

1. Найдите файл src/main/resources/application.yml для simple-todo-api приложения. Обновите конфигурацию в 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>
   

   Примечание.

   В маркерах версии 1.0 конфигурация требует идентификатор клиента API, а в маркерах версии 2.0 можно использовать идентификатор клиента или URI идентификатора приложения в запросе. Вы можете настроить оба способа правильного завершения проверки аудитории.

   Допустимые значенияtenant-id: common, organizationsconsumersили идентификатор клиента. Дополнительные сведения об этих значениях см. в разделе "Использована неправильная конечная точка (личные и учетные записи организации) в разделе "Ошибка" AADSTS50020 . Учетная запись пользователя от поставщика удостоверений не существует в клиенте. Сведения о преобразовании приложения с одним клиентом см. в разделе "Преобразование однотенантного приложения в мультитенантный" в идентификатор Microsoft Entra.

2. Чтобы перестроить пример проекта, используйте следующую команду:

   ./mvnw clean package
   

Интерфейс командной строки разработчика Azure

3.1. Подготовка ресурсов Azure

Чтобы подготовить необходимые ресурсы Azure, выполните следующие действия.

1. Выполните следующую команду, чтобы войти в Azure с помощью OAuth2. Пропустить этот шаг, если вы уже вошли в систему.

   azd auth login
   

2. Выполните следующую команду, чтобы включить функцию Azure Spring Apps:

   azd config set alpha.springapp on
   

3. Выполните следующую команду, чтобы упаковать развертываемую копию приложения, подготовить инфраструктуру шаблона в Azure и развернуть код приложения в этих недавно подготовленных ресурсах:

   azd provision
   

   В следующем списке описаны взаимодействия с командами:

   • Выберите подписку Azure для использования: используйте стрелки для перемещения, введите для фильтрации и нажмите клавишу ВВОД.
   • Выберите расположение Azure для использования: используйте стрелки для перемещения, введите для фильтрации, а затем нажмите клавишу ВВОД.

   Консоль выводит сообщения, аналогичные следующему примеру:

   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. Предоставление API RESTful

Чтобы предоставить API RESTful в идентификаторе Microsoft Entra, выполните следующие действия.

1. Войдите на портал Azure.

2. Если у вас есть доступ к нескольким клиентам, используйте фильтр каталогов и подписок ( ) для выбора клиента, в котором требуется зарегистрировать приложение.

3. Найдите и выберите Microsoft Entra ID.

4. В разделе Управление выберите Регистрация приложений>Создать регистрацию.

5. Введите имя приложения в поле "Имя ", например Todo. Пользователи приложения могут видеть это имя. Вы можете изменить его позже.

6. Для поддерживаемых типов учетных записей выберите учетные записи в любом каталоге организации (любой каталог Microsoft Entra — Multitenant) и личных учетных записей Майкрософт.

7. Выберите Зарегистрировать, чтобы создать приложение.

8. На странице приложения Обзор найдите идентификатор приложения (клиента) и запишите его, чтобы использовать позже. Вам потребуется настроить файл конфигурации YAML для этого проекта.

9. В разделе "Управление" выберите "Предоставить API", найдите URI идентификатора приложения в начале страницы и нажмите кнопку "Добавить".

10. На странице "Изменение идентификатора приложения" примите предлагаемый URI идентификатора приложения (api://{client ID}) или используйте понятное имя вместо идентификатора клиента, например api://simple-todo, а затем нажмите кнопку "Сохранить".

11. В разделе "Управление" выберите "Предоставить API>Добавить область", а затем введите следующие сведения:

    • В поле "Имя области" введите ToDo.Read.
    • Для Кто может быть предоставлено согласие, выберите только Администратор.
    • Для отображаемого имени согласия Администратор введите данные ToDo.
    • В поле Администратор описание согласия введите "Разрешить пользователям, прошедшим проверку подлинности", считывать данные ToDo.
    • Для состояния оставьте его включенным.
    • Выберите Добавить область.

12. Повторите предыдущие шаги, чтобы добавить два других область: ToDo.Write и ToDo.Delete.

    

3.3. Обновление конфигурации приложения

Чтобы обновить YAML-файл, чтобы использовать сведения о зарегистрированном приложении Microsoft Entra, выполните следующие действия, чтобы установить связь с приложением API RESTful:

1. Найдите файл src/main/resources/application.yml для simple-todo-api приложения. Обновите конфигурацию в 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>
   

   Примечание.

   В маркерах версии 1.0 конфигурация требует идентификатор клиента API, а в маркерах версии 2.0 можно использовать идентификатор клиента или URI идентификатора приложения в запросе. Вы можете настроить оба способа правильного завершения проверки аудитории.

   Допустимые значенияtenant-id: common, organizationsconsumersили идентификатор клиента. Дополнительные сведения об этих значениях см. в разделе "Использована неправильная конечная точка (личные и учетные записи организации) в разделе "Ошибка" AADSTS50020 . Учетная запись пользователя от поставщика удостоверений не существует в клиенте. Сведения о преобразовании приложения с одним клиентом см. в разделе "Преобразование однотенантного приложения в мультитенантный" в идентификатор Microsoft Entra.

2. Чтобы перестроить пример проекта, используйте следующую команду:

   ./mvnw clean package
   

4. Развертывание приложения в Azure Spring Apps

Теперь вы можете развернуть приложение в Azure Spring Apps.

портал Azure + подключаемый модуль Maven

Выполните следующие действия, чтобы развернуть с помощью подключаемого модуля Maven для Azure Spring Apps:

1. Перейдите к полному каталогу и выполните следующую команду, чтобы настроить приложение в Azure Spring Apps:

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

   В следующем списке описаны взаимодействия с командами:

   • Вход OAuth2: необходимо авторизовать вход в Azure на основе протокола OAuth2.
   • Выберите подписку: выберите номер списка подписок созданного экземпляра Azure Spring Apps, который по умолчанию соответствует первой подписке в списке. Если вы используете номер по умолчанию, нажмите клавишу ВВОД напрямую.
   • Используйте существующие Azure Spring Apps в Azure: нажмите y , чтобы использовать существующий экземпляр Azure Spring Apps.
   • Выберите Azure Spring Apps для развертывания: выберите номер созданного экземпляра Azure Spring Apps. Если вы используете номер по умолчанию, нажмите клавишу ВВОД напрямую.
   • Используйте существующее приложение в Azure Spring Apps <с именем> экземпляра: нажмите клавишу Y , чтобы использовать созданное приложение.
   • Подтвердите сохранение всех указанных выше конфигураций: нажмите клавишу Y. Если нажать клавишу N, конфигурация не сохраняется в POM-файлах.

2. Чтобы развернуть приложение, используйте следующую команду:

   ./mvnw azure-spring-apps:deploy
   

   В следующем списке описывается взаимодействие с командой:

   • Вход OAuth2: необходимо авторизовать вход в Azure на основе протокола OAuth2.

   После выполнения команды можно увидеть в следующих сообщениях журнала, что развертывание выполнено успешно:

[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

Выполните следующие действия, чтобы упаковать приложение, подготовить ресурсы 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 ToDo.

Примечание.

Можно также использовать azd up для объединения предыдущих трех команд: azd provision (подготавливает ресурсы Azure), azd package (упаковывает развертываемую копию приложения) и azd deploy (развертывает код приложения). Дополнительные сведения см. в статье Azure-Samples/ASA-Samples-Restful-Application.

5. Проверка приложения

Теперь вы можете получить доступ к API RESTful, чтобы узнать, работает ли он.

5.1. Запросите маркер доступа

API RESTful действуют как сервер ресурсов, защищенный идентификатором Microsoft Entra. Перед получением маркера доступа необходимо зарегистрировать другое приложение в идентификаторе Microsoft Entra и предоставить разрешения клиентскому приложению, которое называется ToDoWeb.

Регистрация клиентского приложения

Чтобы зарегистрировать приложение в идентификаторе Microsoft Entra, которое используется для добавления разрешений для ToDo приложения, выполните следующие действия.

1. Войдите на портал Azure.

2. Если у вас есть доступ к нескольким клиентам, используйте фильтр каталогов и подписок ( ) для выбора клиента, в котором требуется зарегистрировать приложение.

3. Найдите и выберите Microsoft Entra ID.

4. В разделе Управление выберите Регистрация приложений>Создать регистрацию.

5. Введите имя приложения в поле "Имя ", например ToDoWeb. Пользователи приложения могут видеть это имя. Вы можете изменить его позже.

6. Для поддерживаемых типов учетных записей используйте только учетные записи по умолчанию в этом каталоге организации.

7. Выберите Зарегистрировать, чтобы создать приложение.

8. На странице приложения Обзор найдите идентификатор приложения (клиента) и запишите его, чтобы использовать позже. Он необходим для получения маркера доступа.

9. Выберите Разрешения API>Добавить разрешение>Мои API. ToDo Выберите приложение, зарегистрированное ранее, и выберите разрешения ToDo.Read, ToDo.Write и ToDo.Delete. Выберите Добавить разрешения.

10. Выберите "Предоставить согласие администратора" для имени> клиента, <чтобы предоставить согласие администратора для добавленных разрешений.

    

Добавление пользователя для доступа к API RESTful

Выполните следующие действия, чтобы создать пользователя-участника в клиенте Microsoft Entra. Затем пользователь может управлять данными ToDo приложения с помощью API RESTful.

1. В разделе "Управление" выберите "Пользователи>" Создать пользователя.>

2. На странице "Создание нового пользователя" введите следующие сведения:

   • Имя участника-пользователя: введите имя пользователя.
   • Отображаемое имя: введите отображаемое имя пользователя.
   • Пароль. Скопируйте автоматически созданный пароль, указанный в поле "Пароль".

   Примечание.

   Новые пользователи должны завершить проверку подлинности первого входа и обновить пароли, в противном случае при получении маркера доступа возникает AADSTS50055: The password is expired ошибка.

   Когда новый пользователь входит в систему, он получает запрос на обязательное действие. Они могут выбрать запрос позже , чтобы пропустить проверку.

3. Выберите Просмотр и создание , чтобы просмотреть выбранные элементы. Нажмите кнопку "Создать" , чтобы создать пользователя.

Обновление конфигурации OAuth2 для авторизации пользовательского интерфейса Swagger

Чтобы обновить конфигурацию OAuth2 для авторизации пользовательского интерфейса Swagger, выполните следующие действия. Затем вы можете авторизовать пользователей для получения маркеров доступа через ToDoWeb приложение.

1. Откройте клиент Идентификатора Microsoft Entra в портал Azure и перейдите в зарегистрированное ToDoWeb приложение.

2. В разделе "Управление" выберите "Проверка подлинности", выберите "Добавить платформу" и выберите одностраничные приложения.

3. Используйте формат <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html в качестве URL-адреса перенаправления OAuth2 в поле URI перенаправления и нажмите кнопку "Настроить".

   

Получение маркера доступа

Выполните следующие действия, чтобы использовать метод потока кода авторизации OAuth 2.0 для получения маркера доступа с идентификатором Microsoft Entra ID, а затем получить доступ к API ToDo RESTful приложения:

1. Откройте URL-адрес, предоставляемый приложением, а затем выберите "Авторизовать ", чтобы подготовить проверку подлинности OAuth2.

2. В окне "Доступные авторизации" введите идентификатор ToDoWeb клиента приложения в поле client_id, выберите все поля область для областей, пропустите поле client_secret, а затем выберите "Авторизовать" для перенаправления на страницу входа Microsoft Entra.

Завершив вход с предыдущим пользователем, вы вернеесь в окно "Доступные авторизации".

5.2. Доступ к API RESTful

Чтобы получить доступ к API ToDo RESTful приложения в пользовательском интерфейсе Swagger, выполните следующие действия.

1. Выберите API POST /api/simple-todo/lists , а затем нажмите кнопку "Попробовать". Введите следующий текст запроса и нажмите кнопку "Выполнить ", чтобы создать список toDo.

   {
     "name": "My List"
   }
   

   После завершения выполнения отобразится следующий текст ответа:

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

2. Выберите API POST /api/simple-todo/list/{listId}/items , а затем нажмите кнопку "Попробовать". В поле listId введите созданный ранее идентификатор списка ToDo, введите следующий текст запроса, а затем нажмите кнопку "Выполнить ", чтобы создать элемент ToDo.

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

   Это действие возвращает следующий элемент 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 , а затем выберите "Выполнить " для запроса списков ToDo. Это действие возвращает следующие списки ToDo:

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

4. Выберите API GET /api/simple-todo/list/{listId}/items , а затем нажмите кнопку "Попробовать". В поле listId введите созданный ранее идентификатор списка ToDo, а затем нажмите кнопку "Выполнить ", чтобы запросить элементы ToDo. Это действие возвращает следующий элемент 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.903307+08:00",
       "completedDate": null
     }
   ]
   

5. Выберите API PUT /api/simple-todo/lists/{listId}/items/{itemId}, а затем нажмите кнопку "Попробовать". В поле listId введите идентификатор списка ToDo. Для itemId введите идентификатор элемента ToDo, введите следующий текст запроса, а затем нажмите кнопку "Выполнить ", чтобы обновить элемент ToDo.

   {
     "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"
   }
   

   Это действие возвращает следующий обновленный элемент ToDo:

   {
     "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 введите идентификатор списка ToDo. В поле itemId введите идентификатор элемента ToDo и выберите "Выполнить ", чтобы удалить элемент ToDo. Вы должны увидеть, что код ответа сервера — 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

Используйте следующую команду, чтобы удалить все ресурсы Azure, используемые в этом примере приложения:

azd down

В следующем списке описывается взаимодействие с командой:

• Общий объем ресурсов для удаления: [итог ресурсов], вы уверены, что хотите продолжить?: нажмите кнопку 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

Использование CI/CD Azure Spring Apps с помощью GitHub Actions

Автоматизация развертываний приложений в Azure Spring Apps

Дополнительные сведения см. в следующих статьях:

• Примеры Azure Spring Apps.
• Spring в Azure
• Spring Cloud Azure