Quickstart: Deploy your first 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 applies to: ✔️ Standard consumption and dedicated (Preview) ✔️ Basic/Standard ✔️ Enterprise

This article explains how to deploy a small application to run on Azure Spring Apps.

The application code used in this tutorial is a simple app. When you've completed this example, the application is accessible online, and you can manage it through the Azure portal.

This quickstart explains how to:

• Generate a basic Spring project.
• Provision a service instance.
• Build and deploy an app with a public endpoint.
• Clean up the resources.

At the end of this quickstart, you have a working Spring app running on Azure Spring Apps.

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 plan in Azure Marketplace.

• Apache Maven

• Azure CLI. Install the Azure CLI extension for Azure Spring Apps Standard consumption and dedicated plan by using the following command:

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

• Use the following commands to install the Azure Container Apps extension for the Azure CLI and register these namespaces: Microsoft.App, Microsoft.OperationalInsights, and Microsoft.AppPlatform:

  az extension add --name containerapp --upgrade
  az provider register --namespace Microsoft.App
  az provider register --namespace Microsoft.OperationalInsights
  az provider register --namespace Microsoft.AppPlatform
  

Provision an instance of Azure Spring Apps

Use the following steps to create an Azure Spring Apps service instance.

1. Select Open Cloudshell and sign in to your Azure account in Azure Cloud Shell.

   az account show
   

2. Azure Cloud Shell workspaces are temporary. When first started, the shell prompts you to associate an Azure Storage instance with your subscription to persist files across sessions. For more information, see Introduction to Azure Storage.

   

3. After you sign in successfully, use the following command to display a list of your subscriptions:

   az account list --output table
   

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

   az account set --subscription <subscription-ID>
   

5. Use the following commands to define variables for this quickstart with the names of your resources and desired settings:

   LOCATION="<region>"
   RESOURCE_GROUP="<resource-group-name>"
   MANAGED_ENVIRONMENT="<Azure-Container-Apps-environment-name>"
   SERVICE_NAME="<Azure-Spring-Apps-instance-name>"
   APP_NAME="<Spring-app-name>"
   

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

   az group create \
       --resource-group ${RESOURCE_GROUP} \
       --location ${LOCATION}
   

7. An 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. For more information, see Log Analytics workspace overview. Use the following command to create the environment:

   az containerapp env create \
       --resource-group ${RESOURCE_GROUP} \
       --name ${MANAGED_ENVIRONMENT} \
       --location ${LOCATION} \
       --enable-workload-profiles
   

8. Use the following command to create a variable to store the environment resource ID:

   MANAGED_ENV_RESOURCE_ID=$(az containerapp env show \
       --resource-group ${RESOURCE_GROUP} \
       --name ${MANAGED_ENVIRONMENT} \
       --query id \
       --output tsv)
   

9. Use the following command to create an Azure Spring Apps service instance. An instance of the Azure Spring Apps Standard consumption and dedicated plan is built on top of the Azure Container Apps environment. Create your Azure Spring Apps instance by specifying the resource ID of the environment you created.

   az spring create \
       --resource-group ${RESOURCE_GROUP} \
       --name ${SERVICE_NAME} \
       --managed-environment ${MANAGED_ENV_RESOURCE_ID} \
       --sku standardGen2 \
       --location ${LOCATION}
   

Create an app in your Azure Spring Apps instance

An App is an abstraction of one business app. For more information, see App and deployment in Azure Spring Apps. Apps run in an Azure Spring Apps service instance, as shown in the following diagram.

You can create an app in either 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 consumption workload profile

Use the following command to specify the app name on Azure Spring Apps and to allocate required resources:

az spring app create \
    --resource-group ${RESOURCE_GROUP} \
    --service ${SERVICE_NAME} \
    --name ${APP_NAME} \
    --cpu 1 \
    --memory 2Gi \
    --min-replicas 2 \
    --max-replicas 2 \
    --assign-endpoint true

Azure Spring Apps creates an empty welcome application and provides its URL in the field named properties.url.

Create an app with 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 \
    --resource-group ${RESOURCE_GROUP} \
    --name ${MANAGED_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 \
   --resource-group ${RESOURCE_GROUP} \
   --service ${SERVICE_NAME} \
   --name ${APP_NAME} \
   --cpu 1 \
   --memory 2Gi \
   --min-replicas 2 \
   --max-replicas 2 \
   --assign-endpoint true \
   --workload-profile my-wlp

Clone and build the Spring Boot sample project

Use the following steps to clone the Spring Boot sample project.

1. Use the following command to clone the Spring Boot sample project from GitHub.

   git clone -b boot-2.7 https://github.com/spring-guides/gs-spring-boot.git
   

2. Use the following command to move to the project folder:

   cd gs-spring-boot/complete
   

3. Use the following Maven command to build the project.

   mvn clean package -DskipTests
   

Deploy the local app to Azure Spring Apps

Use the following command to deploy the .jar file for the app:

az spring app deploy \
    --resource-group ${RESOURCE_GROUP} \
    --service ${SERVICE_NAME} \
    --name ${APP_NAME} \
    --artifact-path target/spring-boot-complete-0.0.1-SNAPSHOT.jar \
    --env testEnvKey=testEnvValue \
    --runtime-version Java_11 \
    --jvm-options '-Xms1024m -Xmx2048m'

Deploying the application can take a few minutes.

Azure CLI

• Apache Maven
• Azure CLI. Install the Azure Spring Apps extension with the following command: az extension add --name spring

Provision an instance of Azure Spring Apps

Use the following steps to create an Azure Spring Apps service instance.

1. Select Open Cloudshell and sign in to your Azure account in Azure Cloud Shell.

   az account show
   

2. Azure Cloud Shell workspaces are temporary. When first started, the shell prompts you to associate an Azure Storage instance with your subscription to persist files across sessions. For more information, see Introduction to Azure Storage.

   

3. After you sign in successfully, use the following command to display a list of your subscriptions:

   az account list --output table
   

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

   az account set --subscription <subscription-ID>
   

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

   az group create \
       --resource-group <name-of-resource-group> \
       --location eastus
   

6. Use the following command to create an Azure Spring Apps service instance:

   az spring create \
       --resource-group <name-of-resource-group> \
       --name <Azure-Spring-Apps-instance-name>
   

7. Select Y to install the Azure Spring Apps extension and run it.

Create an app in your Azure Spring Apps instance

An App is an abstraction of one business app. For more information, see App and deployment in Azure Spring Apps. Apps run in an Azure Spring Apps service instance, as shown in the following diagram.

Use the following command to specify the app name on Azure Spring Apps as hellospring:

az spring app create \
    --resource-group <name-of-resource-group> \
    --service <Azure-Spring-Apps-instance-name> \
    --name hellospring \
    --assign-endpoint true

Clone and build the Spring Boot sample project

Use the following steps to clone the Spring Boot sample project.

1. Use the following command to clone the Spring Boot sample project from GitHub.

   git clone -b boot-2.7 https://github.com/spring-guides/gs-spring-boot.git
   

2. Use the following command to move to the project folder:

   cd gs-spring-boot/complete
   

3. Use the following Maven command to build the project.

   mvn clean package -DskipTests
   

Deploy the local app to Azure Spring Apps

Use the following command to deploy the .jar file for the app (target/spring-boot-complete-0.0.1-SNAPSHOT.jar on Windows):

az spring app deploy \
    --resource-group <name-of-resource-group> \
    --service <Azure-Spring-Apps-instance-name> \
    --name hellospring \
    --artifact-path target/spring-boot-complete-0.0.1-SNAPSHOT.jar

Deploying the application can take a few minutes. After deployment, you can access the app at https://<service-instance-name>-hellospring.azuremicroservices.io/.

IntelliJ

• IntelliJ IDEA.
• Azure Toolkit for IntelliJ.

Generate a Spring project

Use the following steps to create the project:

1. Use Spring Initializr to generate a sample project with recommended dependencies for Azure Spring Apps. The following URL provides default settings for you.

   https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.6.10&packaging=jar&jvmVersion=11&groupId=com.example&artifactId=hellospring&name=hellospring&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.hellospring&dependencies=web,cloud-eureka,actuator,cloud-config-client
   

   The following image shows the recommended Initializr settings for the hellospring sample project.

   This example uses Java version 11. To use a different Java version, change the Java version setting under Project Metadata.

   

2. When all dependencies are set, select Generate.

3. Download and unpack the package, and then create a web controller for your web application by adding the file src/main/java/com/example/hellospring/HelloController.java with the following contents:

   package com.example.hellospring;
   
   import org.springframework.web.bind.annotation.RestController;
   import org.springframework.web.bind.annotation.RequestMapping;
   
   @RestController
   public class HelloController {
   
       @RequestMapping("/")
       public String index() {
           return "Greetings from Azure Spring Apps!";
        }
   }
   

Create an instance of Azure Spring Apps

Use the following steps to create an instance of Azure Spring Apps using the Azure portal.

1. In a new tab, open the Azure portal.

2. From the top search box, search for Azure Spring Apps.

3. Select Azure Spring Apps from the results.

   

4. On the Azure Spring Apps page, select Create.

   

5. Fill out the form on the Azure Spring Apps Create page. Consider the following guidelines:

   • Subscription: Select the subscription you want to be billed for this resource.
   • Resource group: Creating new resource groups for new resources is a best practice.
   • Service Name: Specify the service instance name. You use this name later in this article where the <Azure-Spring-Apps-instance-name> placeholder appears. The name must be between 4 and 32 characters long and can contain only lowercase letters, numbers, and hyphens. The first character of the service name must be a letter and the last character must be either a letter or a number.
   • Region: Select the region for your service instance.

   

6. Select Review and create.

Import the project

Use the following steps to import the project.

1. Open IntelliJ IDEA, and then select Open.

2. In the Open File or Project dialog box, select the hellospring folder.

   

Build and deploy your app

Note

To run the project locally, add spring.config.import=optional:configserver: to the project's application.properties file.

Use the following steps to build and deploy your app.

1. If you haven't already installed the Azure Toolkit for IntelliJ, follow the steps in Install the Azure Toolkit for IntelliJ.

2. Right-click your project in the IntelliJ Project window, and then select Azure -> Deploy to Azure Spring Apps.

   

3. Accept the name for the app in the Name field. Name refers to the configuration, not the app name. You don't usually need to change it.

4. In the Artifact textbox, select Maven:com.example:hellospring-0.0.1-SNAPSHOT.

5. In the Subscription textbox, verify that your subscription is correct.

6. In the Service textbox, select the instance of Azure Spring Apps that you created in the Provision an instance of Azure Spring Apps section.

7. In the App textbox, select the plus sign (+) to create a new app.

   

8. In the App name: textbox under App Basics, enter hellospring, and then select the More settings check box.

9. Select the Enable button next to Public endpoint. The button changes to Disable <to be enabled>.

10. If you're using Java 11, select Java 11 for the Runtime option.

11. Select OK.

    

12. Under Before launch, select Run Maven Goal 'hellospring:package', and then select the pencil icon to edit the command line.

    

13. In the Command line textbox, enter -DskipTests after package, and then select OK.

    

14. To start the deployment, select the Run button at the bottom of the Deploy Azure Spring Apps app dialog box. The plug-in runs the command mvn package -DskipTests on the hellospring app and deploys the .jar file generated by the package command.

Deploying the application can take a few minutes. After deployment, you can access the app at https://<service-instance-name>-hellospring.azuremicroservices.io/.

Visual Studio Code

Note

To deploy a Spring Boot web app to Azure Spring Apps by using Visual Studio Code, follow the steps in Java on Azure Spring Apps.

Clean up resources

If you plan to continue working with subsequent quickstarts and tutorials, you might want to leave these resources in place. When you no longer need the resources, delete them by deleting the resource group. Use the following commands to delete the resource group:

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

Next steps

In this quickstart, you learned how to build and deploy a Spring app in an Azure Spring Apps service instance. You also learned how to deploy an app with a public endpoint, and how to clean up resources.

You have access to powerful logs, metrics, and distributed tracing capability from the Azure portal. For more information, see Quickstart: Monitoring Azure Spring Apps apps with logs, metrics, and tracing.

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 create a Standard consumption and dedicated plan in Azure Spring Apps for app deployment, advance to the Standard consumption and dedicated quickstart series:

Provision an Azure Spring Apps Standard consumption and dedicated plan service instance

For a packaged app template with Azure Spring Apps infrastructure provisioned using Bicep, see Spring Boot PetClinic Microservices Application Deployed to Azure Spring Apps.

More samples are available on GitHub: Azure Spring Apps Samples.