Skip to content

Latest commit

 

History

History
217 lines (133 loc) · 11.4 KB

create-first-function-cli-java.md

File metadata and controls

217 lines (133 loc) · 11.4 KB
title description ms.date ms.topic ms.custom
Use Java to create a function in Azure to respond to HTTP
Learn how to create a function from the command line using Java, then publish the local project to serverless hosting in Azure Functions.
09/14/2020
quickstart
devx-track-java
devx-track-azurecli

Quickstart: Create a function in Azure using Java that responds to HTTP requests

In this article, you use command-line tools to create a Java function that responds to HTTP requests. After testing the code locally, you deploy it to the serverless environment of Azure Functions.

Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Note

If Maven is not your preferred development tool, check out our similar tutorials for Java developers using Gradle, IntelliJ IDEA and Visual Studio Code.

Configure your local environment

Before you begin, you must have the following:

Prerequisite check

  • In a terminal or command window, run func --version to check that the Azure Functions Core Tools are version 2.7.1846 or later.

  • Run az --version to check that the Azure CLI version is 2.0.76 or later.

  • Run az login to sign in to Azure and verify an active subscription.

Create a local function project

In Azure Functions, a function project is a container for one or more individual functions that each responds to a specific trigger. All functions in a project share the same local and hosting configurations. In this section, you create a function project that contains a single function.

In an empty folder, run the following command to generate the Functions project from a Maven archetype. Use -DjavaVersion=11 if you want to run your functions in Azure on Java 11 instead of Java 8. To learn more, see Java versions.

Bash

mvn archetype:generate -DarchetypeGroupId=com.microsoft.azure -DarchetypeArtifactId=azure-functions-archetype -DjavaVersion=8

PowerShell

mvn archetype:generate "-DarchetypeGroupId=com.microsoft.azure" "-DarchetypeArtifactId=azure-functions-archetype" "-DjavaVersion=8"

Cmd

mvn archetype:generate "-DarchetypeGroupId=com.microsoft.azure" "-DarchetypeArtifactId=azure-functions-archetype" "-DjavaVersion=8"

Maven asks you for values needed to finish generating the project on deployment.
Provide the following values when prompted:

Prompt Value Description
groupId com.fabrikam A value that uniquely identifies your project across all projects, following the package naming rules for Java.
artifactId fabrikam-functions A value that is the name of the jar, without a version number.
version 1.0-SNAPSHOT Choose the default value.
package com.fabrikam A value that is the Java package for the generated function code. Use the default.

Type Y or press Enter to confirm.

Maven creates the project files in a new folder with a name of artifactId, which in this example is fabrikam-functions.

Navigate into the project folder:

cd fabrikam-functions

This folder contains various files for the project, including configurations files named local.settings.json and host.json. Because local.settings.json can contain secrets downloaded from Azure, the file is excluded from source control by default in the .gitignore file.

(Optional) Examine the file contents

If desired, you can skip to Run the function locally and examine the file contents later.

Function.java

Function.java contains a run method that receives request data in the request variable is an HttpRequestMessage that's decorated with the HttpTrigger annotation, which defines the trigger behavior.

:::code language="java" source="~/azure-functions-samples-java/src/main/java/com/functions/Function.java":::

The response message is generated by the HttpResponseMessage.Builder API.

pom.xml

Settings for the Azure resources created to host your app are defined in the configuration element of the plugin with a groupId of com.microsoft.azure in the generated pom.xml file. For example, the configuration element below instructs a Maven-based deployment to create a function app in the java-functions-group resource group in the westus region. The function app itself runs on Windows hosted in the java-functions-app-service-plan plan, which by default is a serverless Consumption plan.

:::code language="java" source="~/azure-functions-samples-java/pom.xml" range="62-102":::

You can change these settings to control how resources are created in Azure, such as by changing runtime.os from windows to linux before initial deployment. For a complete list of settings supported by the Maven plug-in, see the configuration details.

If you want to run your function app on Java 11 instead of Java 8, you must manually update the pom.xml file with Java 11 values. To learn more, see Java versions. When running on Java 11, make sure that

FunctionTest.java

The archetype also generates a unit test for your function. When you change your function to add bindings or add new functions to the project, you'll also need to modify the tests in the FunctionTest.java file.

Run the function locally

Run your function by starting the local Azure Functions runtime host from the LocalFunctionProj folder:

mvn clean package
mvn azure-functions:run

Toward the end of the output, the following lines should appear:

...

Now listening on: http://0.0.0.0:7071
Application started. Press Ctrl+C to shut down.

Http Functions:

        HttpExample: [GET,POST] http://localhost:7071/api/HttpExample
...

Note

If HttpExample doesn't appear as shown below, you likely started the host from outside the root folder of the project. In that case, use Ctrl+C to stop the host, navigate to the project's root folder, and run the previous command again.

Copy the URL of your HttpExample function from this output to a browser and append the query string ?name=<your-name>, making the full URL like http://localhost:7071/api/HttpExample?name=Functions. The browser should display a message like Hello Functions:

Result of the function run locally in the browser

The terminal in which you started your project also shows log output as you make requests.

When you're ready, use Ctrl+C and choose y to stop the functions host.

Deploy the function project to Azure

A function app and related resources are created in Azure when you first deploy your functions project. Settings for the Azure resources created to host your app are defined in the pom.xml file. In this article, you'll accept the defaults.

Tip

To create a function app running on Linux instead of Windows, change the runtime.os element in the pom.xml file from windows to linux. Running Linux in a consumption plan is supported in these regions. You can't have apps that run on Linux and apps that run on Windows in the same resource group.

Before you can deploy, use the az login Azure CLI command to sign in to your Azure subscription.

az login

Use the following command to deploy your project to a new function app.

mvn azure-functions:deploy

This creates the following resources in Azure:

  • Resource group. Named as java-functions-group.
  • Storage account. Required by Functions. The name is generated randomly based on Storage account name requirements.
  • Hosting plan. Serverless hosting for your function app in the westus region. The name is java-functions-app-service-plan.
  • Function app. A function app is the deployment and execution unit for your functions. The name is randomly generated based on your artifactId, appended with a randomly generated number.

The deployment packages the project files and deploys them to the new function app using zip deployment. The code runs from the deployment package in Azure.

Invoke the function on Azure

Because your function uses an HTTP trigger, you invoke it by making an HTTP request to its URL in the browser or with a tool like curl. In both instances, the code URL parameter is your unique function key that authorizes the invocation of your function endpoint.

Browser

Copy the complete Invoke URL shown in the output of the publish command into a browser address bar, appending the query parameter &name=Functions. The browser should display similar output as when you ran the function locally.

The output of the function run on Azure in a browser

curl

Run curl with the Invoke URL, appending the parameter &name=Functions. The output of the command should be the text, "Hello Functions."

The output of the function run on Azure using curl

Tip

To view near real-time logs for a published function app, use the Application Insights Live Metrics Stream.

Run the following command to open the live metrics stream in a browser.

func azure functionapp logstream <APP_NAME> --browser

Clean up resources

If you continue to the next step, Add an Azure Storage queue output binding, keep all your resources in place as you'll build on what you've already done.

Otherwise, use the following command to delete the resource group and all its contained resources to avoid incurring further costs.

az group delete --name java-functions-group

Next steps

[!div class="nextstepaction"] Connect to an Azure Storage queue