Quickstart: Deploy an event-driven application to Azure Spring Apps

Note

The first 50 vCPU hours and 100 GB hours of memory are free each month. For more information, see Price Reduction - Azure Spring Apps does more, costs less! on the Apps on Azure Blog.

Note

Azure Spring Apps is the new name for the Azure Spring Cloud service. Although the service has a new name, you'll see the old name in some places for a while as we work to update assets such as screenshots, videos, and diagrams.

This article explains how to deploy a Spring Boot event-driven application to Azure Spring Apps.

The sample project is an event-driven application that subscribes to a Service Bus queue named lower-case, and then handles the message and sends another message to another queue named upper-case. To make the app simple, message processing just converts the message to uppercase. The following diagram depicts this process:

Prerequisites

• An Azure subscription. If you don't have a subscription, create a free account before you begin.

• If you're deploying an Azure Spring Apps Enterprise plan instance for the first time in the target subscription, see the Requirements section of Enterprise tier in Azure Marketplace.

• Azure CLI. Version 2.45.0 or greater. Use the following command to install the Azure Spring Apps extension: az extension add --name spring
• Git.
• Java Development Kit (JDK), version 17.

Clone and build the sample project

Use the following steps to prepare the sample locally.

1. The sample project is ready on GitHub. Clone sample project by using the following command:

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

2. Build the sample project by using the following commands:

   cd ASA-Samples-Event-Driven-Application
   ./mvnw clean package -DskipTests
   

Prepare the cloud environment

The main resources you need to run this sample is an Azure Spring Apps instance and an Azure Service Bus instance. Use the following steps to create these resources.

1. Use the following commands to create variables for the names of your resources and for other settings as needed. Resource names in Azure must be unique.

   RESOURCE_GROUP=<event-driven-app-resource-group-name>
   LOCATION=<desired-region>
   SERVICE_BUS_NAME_SPACE=<event-driven-app-service-bus-namespace>
   AZURE_CONTAINER_APPS_ENVIRONMENT=<Azure-Container-Apps-environment-name>
   AZURE_SPRING_APPS_INSTANCE=<Azure-Spring-Apps-instance-name>
   APP_NAME=<event-driven-app-name>
   

1. Use the following commands to create variables for the names of your resources and for other settings as needed. Resource names in Azure must be unique.

   RESOURCE_GROUP=<event-driven-app-resource-group-name>
   LOCATION=<desired-region>
   SERVICE_BUS_NAME_SPACE=<event-driven-app-service-bus-namespace>
   AZURE_SPRING_APPS_INSTANCE=<Azure-Spring-Apps-instance-name>
   APP_NAME=<event-driven-app-name>
   

2. Use the following command to sign in to Azure:

   az login
   

3. Use the following command to set the default location:

   az configure --defaults location=${LOCATION}
   

4. Use the following command to list all available subscriptions, then determine the ID for the subscription you want to use.

   az account list --output table
   

5. Use the following command to set your default subscription:

   az account set --subscription <subscription-ID>
   

6. Use the following command to create a resource group:

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

7. Use the following command to set the newly created resource group as the default resource group.

   az configure --defaults group=${RESOURCE_GROUP}
   

Create a Service Bus instance

Use the following command to create a Service Bus namespace:

az servicebus namespace create --name ${SERVICE_BUS_NAME_SPACE}

Create queues in your Service Bus instance

Use the following commands to create two queues named lower-case and upper-case:

az servicebus queue create \
    --namespace-name ${SERVICE_BUS_NAME_SPACE} \
    --name lower-case
az servicebus queue create \
    --namespace-name ${SERVICE_BUS_NAME_SPACE} \
    --name upper-case

Create an Azure Container Apps environment

The Azure Container Apps environment creates a secure boundary around a group of applications. Apps deployed to the same environment are deployed in the same virtual network and write logs to the same Log Analytics workspace.

Use the following steps to create the environment:

1. Use the following command to install the Azure Container Apps extension for the Azure CLI:

   az extension add --name containerapp --upgrade
   

2. Use the following command to register the Microsoft.App namespace:

   az provider register --namespace Microsoft.App
   

3. If you haven't previously used the Azure Monitor Log Analytics workspace, register the Microsoft.OperationalInsights provider by using the following command:

   az provider register --namespace Microsoft.OperationalInsights
   

4. Use the following command to create the environment:

   az containerapp env create --name ${AZURE_CONTAINER_APPS_ENVIRONMENT} --enable-workload-profiles
   

Create the Azure Spring Apps instance

An Azure Spring Apps service instance hosts the Spring event-driven app. Use the following steps to create the service instance and then create an app inside the instance.

1. Use the following command to install the Azure CLI extension designed for Azure Spring Apps:

   az extension remove --name spring && \
   az extension add --name spring
   

2. Use the following command to register the Microsoft.AppPlatform provider for Azure Spring Apps:

   az provider register --namespace Microsoft.AppPlatform
   

3. Get the Azure Container Apps environment resource ID by using the following command:

   MANAGED_ENV_RESOURCE_ID=$(az containerapp env show \
       --name ${AZURE_CONTAINER_APPS_ENVIRONMENT} \
       --query id \
       --output tsv)
   

4. Use the following command to create your Azure Spring Apps instance, specifying the resource ID of the Azure Container Apps environment you created.

   az spring create \
       --name ${AZURE_SPRING_APPS_INSTANCE} \
       --managed-environment ${MANAGED_ENV_RESOURCE_ID} \
       --sku standardGen2
   

2. Use the following command to create your Azure Spring Apps instance:

   az spring create --name ${AZURE_SPRING_APPS_INSTANCE}
   

2. Use the following command to create your Azure Spring Apps instance:

   az spring create \
       --name ${AZURE_SPRING_APPS_INSTANCE} \
       --sku Enterprise
   

Create an app in your Azure Spring Apps instance

The following sections show you how to create an app in either the standard consumption or dedicated workload profiles.

Important

The Consumption workload profile has a pay-as-you-go billing model, with no starting cost. You're billed for the dedicated workload profile based on the provisioned resources. For more information, see Workload profiles in Consumption + Dedicated plan structure environments in Azure Container Apps (preview) and Azure Spring Apps pricing.

Create an app with the consumption workload profile

Use the following command to create an app in the Azure Spring Apps instance:

az spring app create \
    --service ${AZURE_SPRING_APPS_INSTANCE} \
    --name ${APP_NAME} \
    --cpu 1 \
    --memory 2 \
    --min-replicas 2 \
    --max-replicas 2 \
    --runtime-version Java_17 \
    --assign-endpoint true

Create an app with the dedicated workload profile

Dedicated workload profiles support running apps with customized hardware and increased cost predictability.

Use the following command to create a dedicated workload profile:

az containerapp env workload-profile set \
    --name ${AZURE_CONTAINER_APPS_ENVIRONMENT} \
    --workload-profile-name my-wlp \
    --workload-profile-type D4 \
    --min-nodes 1 \
    --max-nodes 2

Then, use the following command to create an app with the dedicated workload profile:

az spring app create \
    --service ${AZURE_SPRING_APPS_INSTANCE} \
    --name ${APP_NAME} \
    --cpu 1 \
    --memory 2Gi \
    --min-replicas 2 \
    --max-replicas 2 \
    --runtime-version Java_17 \
    --assign-endpoint true \
    --workload-profile my-wlp

Create an app in the Azure Spring Apps instance by using the following command:

az spring app create \
    --service ${AZURE_SPRING_APPS_INSTANCE} \
    --name ${APP_NAME} \
    --runtime-version Java_17 \
    --assign-endpoint true

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

Bind the Service Bus to Azure Spring Apps and deploy the app

You've now created both the Service Bus and the app in Azure Spring Apps, but the app can't connect to the Service Bus. Use the following steps to enable the app to connect to the Service Bus, and then deploy the app.

1. Get the Service Bus's connection string by using the following command:

   SERVICE_BUS_CONNECTION_STRING=$(az servicebus namespace authorization-rule keys list \
       --namespace-name ${SERVICE_BUS_NAME_SPACE} \
       --name RootManageSharedAccessKey \
       --query primaryConnectionString \
       --output tsv)
   

2. Use the following command to provide the connection string to the app through an environment variable.

   az spring app update \
       --service ${AZURE_SPRING_APPS_INSTANCE} \
       --name ${APP_NAME} \
       --env SERVICE_BUS_CONNECTION_STRING=${SERVICE_BUS_CONNECTION_STRING}
   

3. Now the cloud environment is ready. Deploy the app by using the following command.

   az spring app deploy \
       --service ${AZURE_SPRING_APPS_INSTANCE} \
       --name ${APP_NAME} \
       --artifact-path target/simple-event-driven-app-0.0.1-SNAPSHOT.jar
   

Validate the event-driven app

Use the following steps to confirm that the event-driven app works correctly. You can validate the app by sending a message to the lower-case queue, then confirming that there's a message in the upper-case queue.

1. Send a message to lower-case queue with Service Bus Explorer. For more information, see the Send a message to a queue or topic section of Use Service Bus Explorer to run data operations on Service Bus.

2. Confirm that there's a new message sent to the upper-case queue. For more information, see the Peek a message section of Use Service Bus Explorer to run data operations on Service Bus.

Clean up resources

Be sure to delete the resources you created in this article when you no longer need them. To delete the resources, just delete the resource group that contains them. You can delete the resource group using the Azure portal. Alternatively, to delete the resource group by using Azure CLI, use the following commands:

echo "Enter the Resource Group name:" &&
read resourceGroupName &&
az group delete --name $resourceGroupName &&
echo "Press [ENTER] to continue ..."

Next steps

To learn how to use more Azure Spring capabilities, advance to the quickstart series that deploys a sample application to Azure Spring Apps:

Introduction to the sample app

To learn how to set up autoscale for applications in Azure Spring Apps Standard consumption plan, advance to this next quickstart:

Set up autoscale for applications in Azure Spring Apps Standard consumption and dedicated plan

For more information, see the following articles:

• Azure Spring Apps Samples.
• Spring on Azure
• Spring Cloud Azure