Exercise: Deploy a web app to Azure App Service

7 minutes

Now that you have your "Hello, Java on Azure!" app running locally, you can deploy it to Azure App Service.

There are multiple ways to deploy your app to Azure App Service. This module describes the following two approaches:

Use the Maven Plugin for Azure Web Apps to deploy your web app to Azure App Service.
Use the Azure CLI to manually create required resources and then deploy.

Using the Maven Plugin for Azure Web Apps is an easier way to get started. Select the relevant button at the start of this unit, based on your preference.

Use the Maven Plugin for Azure Web Apps

Microsoft provides the Maven Plugin for Azure Web Apps to make it easier for Java developers to deploy applications to Azure. By using this plug-in, you can easily configure and deploy your application to Azure.

Configure the Maven Plugin for Azure Web Apps

To configure the Maven Plugin for Azure Web Apps, use the following command:

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

After the command, some questions appear at the prompt, so enter and select the appropriate items and set them. Enter the following options:

Item	Input value
Subscription	Choose your Azure subscription
Define value for OS	Linux
Define value for pricing tier	B1
Define value for Java version	Java 17
Confirm (Y/N)	Y

[INFO] Scanning for projects...
[INFO]
[INFO] --------------------< com.example:hello-java-azure >--------------------
[INFO] Building hello-java-azure 1.0-SNAPSHOT
[INFO]   from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- azure-webapp:2.14.1:config (default-cli) @ hello-java-azure ---
Downloading from ossrh: https://oss.sonatype.org/content/repositories/snapshots/net/minidev/json-smart/maven-metadata.xml
Downloading from central: https://repo.maven.apache.org/maven2/net/minidev/json-smart/maven-metadata.xml
Downloading from shibboleth-repo: https://build.shibboleth.net/nexus/content/repositories/releases/net/minidev/json-smart/maven-metadata.xml
Downloaded from central: https://repo.maven.apache.org/maven2/net/minidev/json-smart/maven-metadata.xml (1.3 kB at 6.2 kB/s)
Create new run configuration (Y/N) [Y]: Y
Define value for OS [Linux]:
  1: Windows
* 2: Linux
  3: Docker
Enter your choice: 2
Define value for javaVersion [Java 21]:
  1: Java 21
* 2: Java 17
Enter your choice: 2
Define value for pricingTier [P1v2]:
   1: B1
   2: B2
   3: B3
   4: D1
   5: EP1
   6: EP2
   7: EP3
   8: F1
*  9: P1v2
  10: P1v3
  11: P2v2
  12: P2v3
  13: P3v2
  14: P3v3
  15: S1
  16: S2
  17: S3
  18: Y1
Enter your choice: 1
Please confirm webapp properties
AppName : hello-java-azure-1731367782304
ResourceGroup : hello-java-azure-1731367782304-rg
Region : centralus
PricingTier : B1
OS : Linux
Java Version: Java 17
Web server stack: Java SE
Deploy to slot : false
Confirm (Y/N) [Y]: Y
[INFO] Saving configuration to pom.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:02 min
[INFO] Finished at: 2024-11-11T15:30:21-08:00
[INFO] ------------------------------------------------------------------------

You should see a new section in the <plugins> section in your pom.xml file.

If you want to change the resource group name, instance name, and deployment location, change <resourceGroup>, <appName>, and <region>.

<plugin>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure-webapp-maven-plugin</artifactId>
    <version>2.14.1</version>
    <configuration>
        <schemaVersion>v2</schemaVersion>
        <resourceGroup>hello-java-azure-1731367782304-rg</resourceGroup>
        <appName>hello-java-azure-1731367782304</appName>
        <pricingTier>B1</pricingTier>
        <region>centralus</region>
        <runtime>
            <os>Linux</os>
            <javaVersion>Java 17</javaVersion>
            <webContainer>Java SE</webContainer>
        </runtime>
        <deployment>
            <resources>
                <resource>
                    <type>jar</type>
                    <directory>${project.basedir}/target</directory>
                    <includes>
                        <include>hello-java-azure-1.0-SNAPSHOT.jar</include>
                    </includes>
                </resource>
            </resources>
        </deployment>
    </configuration>
</plugin>

If the generated configuration uses <include>*.jar</include>, replace it with <include>hello-java-azure-1.0-SNAPSHOT.jar</include>. This change deploys the executable JAR and avoids deploying the original-hello-java-azure-1.0-SNAPSHOT.jar file that Maven creates during packaging.

Compile and deploy to Azure App Service

Now that the settings for deploying to Azure App Service are complete, package and deploy the application by using the following command:

mvn package azure-webapp:deploy

After deployment, you should see the following output:

[INFO] Successfully deployed the artifact to https://hello-java-azure-1731367782304.azurewebsites.net
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  02:47 min
[INFO] Finished at: 2024-11-11T15:39:47-08:00
[INFO] ------------------------------------------------------------------------

The public URL of the deployed application displays in the output message, as shown in the following example: Successfully deployed the artifact to https://hello-java-azure-1731367782304.azurewebsites.net

Confirm the log stream from the command line

If you haven't already signed in to the Azure CLI, sign in now. Use the same Azure account and subscription that the Maven plugin used to deploy:

az login

In the az webapp log config and az webapp log tail commands that follow, replace <resource-group-name> and <app-name> with the <resourceGroup> and <appName> values that the Maven plugin saved into your pom.xml.

Before you start the log stream, enable container logging for your web app:

az webapp log config --resource-group <resource-group-name> --name <app-name> --docker-container-logging filesystem

Then start the live log stream:

az webapp log tail --resource-group <resource-group-name> --name <app-name>

You should see output similar to the following example. The exact port value can vary; use the port value shown by the deployed app.

2024-11-07T18:14:37  Welcome, you are now connected to log-streaming service.
Starting Live Log Stream ---
2024-11-07T18:14:42.1234567Z Server started on port 8080

Use the Azure CLI

Use the following steps to deploy using the Azure CLI:

Install the Azure CLI, if it isn't already installed. For more information, see How to install the Azure CLI.
Use the following command to sign in to Azure:
```
az login
```

Use the following commands to set environment variables. Be sure to replace the placeholders with the values described in the table. These values are used throughout this module.

export RESOURCE_GROUP="appServiceWorkshop"
export LOCATION="<region>"
export APP_SERVICE_PLAN="myAppServicePlan"
export WEBAPP_NAME="<web-app-name>"      # Use a globally unique App Service name (2-60 characters)
export JAR_FILE_PATH="target/hello-java-azure-1.0-SNAPSHOT.jar"

The following table describes the placeholder values and JAR file path:

Value	Description
`<web-app-name>`	The name of your web app. It must be globally unique for the default `*.azurewebsites.net` URL, be 2-60 characters long, use only letters, numbers, and hyphens, and not start or end with a hyphen.
`<region>`	The Azure region you want to use. You can use `eastus` by default, but we recommend that you use a region close to where you live. To see the full list of available regions, enter `az account list-locations`.
`JAR_FILE_PATH`	This path is where your executable .jar file was saved in your project directory. The example uses target/hello-java-azure-1.0-SNAPSHOT.jar.

Use the following command to create a resource group:

az group create \
    --name $RESOURCE_GROUP \
    --location $LOCATION

Use the following command to create an App Service plan:

az appservice plan create \
    --name $APP_SERVICE_PLAN \
    --resource-group $RESOURCE_GROUP \
    --is-linux \
    --sku B1

Use the following command to create a web app:

az webapp create \
    --resource-group $RESOURCE_GROUP \
    --plan $APP_SERVICE_PLAN \
    --name $WEBAPP_NAME \
    --runtime "JAVA:17-java17"

Use the following command to deploy the app:

az webapp deploy \
    --resource-group $RESOURCE_GROUP \
    --name $WEBAPP_NAME \
    --src-path $JAR_FILE_PATH

It's normal for the deployment process to take several minutes.

Visit your deployed Java web app. Use the following command to produce the deployment URL:
```
echo "Your website is at https://$(az webapp show \
    --name $WEBAPP_NAME \
    --resource-group $RESOURCE_GROUP \
    --query defaultHostName \
    --output tsv)"
```
When you run this command, it outputs something like: Your website is at https://<your-app-name>.azurewebsites.net
Select the link. You should see "Hello, Java on Azure!" on the screen.

Congratulations! You successfully deployed a web app to Azure App Service.

Exercise summary

In this unit, you learned how to create and package a Java web application, how to use the Maven Plugin for Azure Web Apps, and how to deploy your application to Azure App Service. These steps apply to Java SE applications that package an executable JAR.

Feedback

Was this page helpful?