Build and Deploy your Java app to an Azure Web App

Azure Pipelines | TFS 2017 RTM

In just a few steps you can build and deploy your Java app to Azure. This works from both the Azure Pipelines service and your on-premises Team Foundation Server.

Upload your code

Upload your code to Azure Pipelines or your on-premises Team Foundation Server. Either push your code to Git or check in your code to TFVC.

If you don't have any code, you can download our Hello world Java web app.

What code is in the sample app?

Enable Java, Apache Tomcat, and FTP for your Azure Web App

  1. Sign in to the Azure portal.

  2. Edit or create a Java web app and enable Apache Tomcat.

  3. Click the deployment credentials part (outlined in red below). Create a user name and password. Click Save. If you previously enabled publishing for a web app, you don't need to do this step.

    Create FTP deployment credentials

Create the pipeline

  1. Open your project in your web browser ▼

    Browse to project

    (If you don't see your project listed on the home page, select Browse.)

    • On-premises TFS: http://{your_server}:8080/tfs/DefaultCollection/{your_project}
    • Azure Pipelines:{your_organization}/{your_project}

    The TFS URL doesn't work for me. How can I get the correct URL?

  2. Create a build pipeline (Pipelines tab > Builds) ▼

    Build tab

  3. Click Empty to start with an empty pipeline.

Define variables to store Azure FTP authentication data

On the Variables tab, store the data needed to copy files to Azure via FTP. Copy this data from the Azure portal. There is nothing special about the variable names we suggest below, so you can make them whatever you prefer.

Name Notes
azure.ftp.userName Take this value from your Azure Web App essentials. For example if the name of your Azure Web App is FabrikamJava, then the value would be : FabrikamJava\YourUserName
azure.ftp.password Take this value from your Azure subscription deployment settings. In your build pipeline variables, make sure to click secret to avoid exposing this password value. I don't want to use my Azure subscription FTP credentials. Can I use credentials scoped to my Azure Web App?

Java deployment build variables

Add build tasks

On the Build tab, add these tasks:

Build: Maven Build: Maven

Build the app.

  • Maven POM file: Browse and select your pom.xml file. For example, helloworld/pom.xml.
Utility: cURL Upload Files Utility: cURL Upload Files

Copy the .war file to Azure.

  • Files: helloworld/target/hello.war
  • Username: $(azure.ftp.userName)
  • Password: $(azure.ftp.password)
  • URL: Take this value from your Azure Web App essentials page on the Azure portal. For example,
  • Optional Arguments: -Q "+CWD site/wwwroot/webapps"
Utility: Copy and Publish Build Artifacts Build: Publish Build Artifacts

(Optional) Drop some of the build outputs, such as the .war file as we do in the example below.

  • Copy Root: helloworld/target
  • Contents: hello.war
  • Artifact name: drop
  • Artifact Type: Server

Finish and test the pipeline

  1. On the Repository tab:

    • Git: Make sure the repository and branch containing your application are selected. (By default the repository with the same name as the project is selected.)

    • TFVC: Make sure the folder that contains your app is mapped.

  2. On the Triggers tab select continuous integration (CI). If your code is in Git, specify the branches you want to build.

  3. Save your pipeline and queue the build.

After a successful build, check your site: http://{web_app_name}{war_file_name}

Q & A

What code is in the sample app?

We used Eclipse to create our Hello World Java sample web app. We adapted a project created from the maven webapp archetype.

|-- .gitignore
`-- helloworld
    |-- .classpath
    |-- .project
    |-- pom.xml
    `-- src
        `-- main
            `-- webapp
                |-- WEB-INF
                |   `-- web.xml
                `-- index.jsp

The pom.xml file enables you to build with Maven. The .gitignore file keeps build artifacts on your dev machine from getting into your Git repo.

I don't want to use my Azure subscription FTP credentials. Can I use credentials scoped to my Azure Web App?

A: Yes.

  1. Sign in to the Azure portal.

  2. Open your web app and download the publish profile.

  3. Open your .PublishSettings file and copy some of the data from the publishMethod="FTP" section into your build variables.

Name Value from .PublishSettings file attribute Notes
azure.ftp.userName userName For example, YourAppName\$YourAppName
azure.ftp.password userPWD In your build pipeline variables, make sure to click secret to avoid exposing this password value.

How do I continually deliver my app and manage my releases?

Learn about Azure Pipelines

What other kinds of apps can I build?

Build your app

What other kinds of build tasks are available?

Specify your build tasks

How do we protect our codebase from build breaks?

How do I modify other parts of my build pipeline?

I selected parallel multi-configuration, but only one build is running at a time.

If you're using Azure Pipelines, you might need more parallel jobs. See Parallel jobs in Azure Pipelines.

How do I see what has changed in my build pipeline?

View the change history of your build pipeline

Do I need an agent?

You need at least one agent to run your build or release. Get an agent for Linux, macOS, or Windows.

I can't select a default agent pool and I can't queue my build or release. How do I fix this?

See Agent pools.

I use TFS on-premises and I don't see some of these features. Why not?

Some of these features are available only on Azure Pipelines and not yet available on-premises. Some features are available on-premises if you have upgraded to the latest version of TFS.