Quickstart: Create a Java app on Azure App Service

Azure App Service provides a highly scalable, self-patching web hosting service. This quickstart shows how to use the Azure CLI with the Azure Web App Plugin for Maven to deploy a .jar file, or .war file. Use the tabs to switch between Java SE and Tomcat instructions.

Java SE

Tomcat

JBoss EAP

JBoss EAP is only available on the Linux version of App Service. Select the Linux button at the top of this article to view the quickstart instructions for JBoss EAP.

If Maven isn't your preferred development tool, check out our similar tutorials for Java developers:

• Gradle
• IntelliJ IDEA
• Eclipse
• Visual Studio Code

If you don't have an Azure subscription, create an Azure free account before you begin.

Use Azure Cloud Shell

Azure hosts Azure Cloud Shell, an interactive shell environment that you can use through your browser. You can use either Bash or PowerShell with Cloud Shell to work with Azure services. You can use the Cloud Shell preinstalled commands to run the code in this article, without having to install anything on your local environment.

To start Azure Cloud Shell:

Option	Example/Link
Select Try It in the upper-right corner of a code block. Selecting Try It doesn't automatically copy the code to Cloud Shell.
Go to https://shell.azure.com, or select the Launch Cloud Shell button to open Cloud Shell in your browser.
Select the Cloud Shell button on the menu bar at the upper right in the Azure portal.

To run the code in this article in Azure Cloud Shell:

1. Start Cloud Shell.

2. Select the Copy button on a code block to copy the code.

3. Paste the code into the Cloud Shell session by selecting Ctrl+Shift+V on Windows and Linux, or by selecting Cmd+Shift+V on macOS.

4. Select Enter to run the code.

Create a Java app

Java SE

Clone the Spring Boot Getting Started sample project.

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

Change directory to the completed project.

cd gs-spring-boot/complete

Tomcat

Execute the following Maven command in the Cloud Shell prompt to create a new app named helloworld:

mvn archetype:generate "-DgroupId=example.demo" "-DartifactId=helloworld" "-DarchetypeArtifactId=maven-archetype-webapp" "-Dversion=1.0-SNAPSHOT"

Then change your working directory to the project folder:

cd helloworld

JBoss EAP

JBoss EAP is only available on the Linux version of App Service. Select the Linux button at the top of this article to view the quickstart instructions for JBoss EAP.

Clone the Pet Store demo application.

git clone https://github.com/agoncal/agoncal-application-petstore-ee7.git

Change directory to the cloned project.

cd agoncal-application-petstore-ee7

Configure the Maven plugin

Tip

The Maven plugin supports Java 17 and Tomcat 10.0. For more information about latest support, see Java 17 and Tomcat 10.0 are available on Azure App Service.

The deployment process to Azure App Service will use your Azure credentials from the Azure CLI automatically. If the Azure CLI is not installed locally, then the Maven plugin will authenticate with Oauth or device login. For more information, see authentication with Maven plugins.

Run the Maven command below to configure the deployment. This command will help you to set up the App Service operating system, Java version, and Tomcat version.

mvn com.microsoft.azure:azure-webapp-maven-plugin:2.5.0:config

Java SE

1. If prompted with Subscription option, select the proper Subscription by entering the number printed at the line start.

2. When prompted with Web App option, select the default option, <create>, by pressing enter.

3. When prompted with OS option, select Windows by entering 1.

4. When prompted with javaVersion option, select Java 11 by entering 2.

5. When prompted with Pricing Tier option, select P1v2 by entering 10.

6. Finally, press enter on the last prompt to confirm your selections.

   Your summary output will look similar to the snippet shown below.

   Please confirm webapp properties
   Subscription Id : ********-****-****-****-************
   AppName : spring-boot-1599007390755
   ResourceGroup : spring-boot-1599007390755-rg
   Region : centralus
   PricingTier : P1v2
   OS : Windows
   Java : Java 11
   Web server stack : Java SE
   Deploy to slot : false
   Confirm (Y/N)? : Y
   [INFO] Saving configuration to pom.
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 41.118 s
   [INFO] Finished at: 2020-09-01T17:43:45-07:00
   [INFO] ------------------------------------------------------------------------
   

Tomcat

1. If prompted with Subscription option, select the proper Subscription by entering the number printed at the line start.

2. When prompted with Web App option, select the default option, <create>, by pressing enter.

3. When prompted with OS option, select Windows by entering 1.

4. When prompted with javaVersion option, select Java 11 by entering 2.

5. When prompted with webContainer option, select Tomcat 8.5 by entering 1.

6. When prompted with Pricing Tier option, select P1v2 by entering 10.

7. Finally, press enter on the last prompt to confirm your selections.

   Your summary output will look similar to the snippet shown below.

   Please confirm webapp properties
   Subscription Id : ********-****-****-****-************
   AppName : helloworld-1599003152123
   ResourceGroup : helloworld-1599003152123-rg
   Region : centralus
   PricingTier : P1v2
   OS : Windows
   Java : Java 11
   Web server stack : Tomcat 8.5
   Deploy to slot : false
   Confirm (Y/N)? : Y
   [INFO] Saving configuration to pom.
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 03:03 min
   [INFO] Finished at: 2020-09-01T16:35:30-07:00
   [INFO] ------------------------------------------------------------------------
   

JBoss EAP

JBoss EAP is only available on the Linux version of App Service. Select the Linux button at the top of this article to view the quickstart instructions for JBoss EAP.

Java SE

1. When prompted with Subscription option, select the proper Subscription by entering the number printed at the line start.

2. When prompted with Web App option, select the default option, <create>, by pressing enter.

3. When prompted with OS option, select Linux by pressing enter.

4. When prompted with javaVersion option, select Java 11 by entering 2.

5. When prompted with Pricing Tier option, select P1v2 by entering 9.

6. Finally, press enter on the last prompt to confirm your selections.

   Please confirm webapp properties
   Subscription Id : ********-****-****-****-************
   AppName : spring-boot-1599007116351
   ResourceGroup : spring-boot-1599007116351-rg
   Region : centralus
   PricingTier : P1v2
   OS : Linux
   Web server stack : Java SE
   Deploy to slot : false
   Confirm (Y/N)? : Y
   [INFO] Saving configuration to pom.
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 20.925 s
   [INFO] Finished at: 2020-09-01T17:38:51-07:00
   [INFO] ------------------------------------------------------------------------
   

Tomcat

1. When prompted with Subscription option, select the proper Subscription by entering the number printed at the line start.

2. When prompted with Web App option, select the default option, <create>, by pressing enter.

3. When prompted with OS option, select Linux by pressing enter.

4. When prompted with javaVersion option, select Java 11 by entering 2.

5. When prompted with webcontainer option, select Tomcat 8.5 by entering 2.

6. When prompted with Pricing Tier option, select P1v2 by entering 9.

7. Finally, press enter on the last prompt to confirm your selections.

   Please confirm webapp properties
   Subscription Id : ********-****-****-****-************
   AppName : helloworld-1599003744223
   ResourceGroup : helloworld-1599003744223-rg
   Region : centralus
   PricingTier : P1v2
   OS : Linux
   Web server stack : Tomcat 8.5
   Deploy to slot : false
   Confirm (Y/N)? : Y
   [INFO] Saving configuration to pom.
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 50.785 s
   [INFO] Finished at: 2020-09-01T16:43:09-07:00
   [INFO] ------------------------------------------------------------------------
   

JBoss EAP

1. If prompted with Subscription option, select the proper Subscription by entering the number printed at the line start.

2. When prompted with Web App option, accept the default option <create> by pressing enter.

3. When prompted with OS option, select Linux by pressing enter.

4. When prompted with javaVersion option, select Java 11 by entering 2.

5. When prompted with webContainer option, select Jbosseap 7 by entering 1

6. When prompted with pricingTier option, select P1v3 by entering 1

7. Finally, press enter on the last prompt to confirm your selections.

   Please confirm webapp properties
   Subscription Id : ********-****-****-****-************
   AppName : petstoreee7-1623451825408
   ResourceGroup : petstoreee7-1623451825408-rg
   Region : centralus
   PricingTier : P1v3
   OS : Linux
   Java : Java 11
   Web server stack: Jbosseap 7
   Deploy to slot : false
   Confirm (Y/N) [Y]: y
   [INFO] Saving configuration to pom.
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 01:01 min
   [INFO] Finished at: 2021-06-11T15:52:25-07:00
   [INFO] ------------------------------------------------------------------------
   

You can modify the configurations for App Service directly in your pom.xml. Some common configurations are listed below:

Property	Required	Description	Version
<schemaVersion>	false	Specify the version of the configuration schema. Supported values are: v1, v2.	1.5.2
<subscriptionId>	false	Specify the subscription ID.	0.1.0+
<resourceGroup>	true	Azure Resource Group for your Web App.	0.1.0+
<appName>	true	The name of your Web App.	0.1.0+
<region>	false	Specifies the region where your Web App will be hosted; the default value is centralus. All valid regions at Supported Regions section.	0.1.0+
<pricingTier>	false	The pricing tier for your Web App. The default value is P1v2 for production workload, while B2 is the recommended minimum for Java dev/test. For more information, see App Service Pricing	0.1.0+
<runtime>	false	The runtime environment configuration. For more information, see Configuration Details.	0.1.0+
<deployment>	false	The deployment configuration. For more information, see Configuration Details.	0.1.0+

Be careful about the values of <appName> and <resourceGroup> (helloworld-1590394316693 and helloworld-1590394316693-rg accordingly in the demo), they'll be used later.

I ran into an issue

Deploy the app

With all the configuration ready in your pom file, you can deploy your Java app to Azure with one single command.

Java SE

mvn package azure-webapp:deploy

Tomcat

mvn package azure-webapp:deploy

JBoss EAP

JBoss EAP is only available on the Linux version of App Service. Select the Linux button at the top of this article to view the quickstart instructions for JBoss EAP.

# Disable testing, as it requires Wildfly to be installed locally.
mvn package azure-webapp:deploy -DskipTests

Once deployment is completed, your application will be ready at http://<appName>.azurewebsites.net/ (http://helloworld-1590394316693.azurewebsites.net in the demo). Open the url with your local web browser, you should see

Java SE

Tomcat

JBoss EAP

JBoss EAP is only available on the Linux version of App Service. Select the Linux button at the top of this article to view the quickstart instructions for JBoss EAP.

Congratulations! You've deployed your first Java app to App Service.

I ran into an issue

Clean up resources

In the preceding steps, you created Azure resources in a resource group. If you don't need the resources in the future, delete the resource group from portal, or by running the following command in the Cloud Shell:

az group delete --name <your resource group name; for example: helloworld-1558400876966-rg> --yes

This command may take a minute to run.

Next steps

Connect to Azure DB for PostgreSQL with Java

Set up CI/CD

Pricing Information

Aggregate Logs and Metrics

Scale up

Azure for Java Developers Resources

Configure your Java app