title | description | ms.topic | ms.date |
---|---|---|---|
Create a function in Azure with Java using VS Code |
Create and publish to Azure a simple HTTP triggered function by using Azure Functions extension in Visual Studio Code using Java. |
quickstart |
09/14/2020 |
In this article, you use Visual Studio Code 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 Visual Studio Code isn't your preferred development tool, check out our similar tutorials for Java developers using Maven, Gradle and IntelliJ IDEA.
Before you get started, make sure you have the following requirements in place:
-
An Azure account with an active subscription. Create an account for free.
-
The Java Developer Kit, version 8.
-
Apache Maven, version 3.0 or above.
-
Visual Studio Code on one of the supported platforms.
-
The Azure Functions extension for Visual Studio Code.
In this section, you use Visual Studio Code to create a local Azure Functions project in your chosen language. Later in this article, you'll publish your function code to Azure.
-
Choose the Azure icon in the Activity bar, then in the Azure: Functions area, select the Create new project... icon.
-
Choose a directory location for your project workspace and choose Select.
[!NOTE] These steps were designed to be completed outside of a workspace. In this case, do not select a project folder that is part of a workspace.
-
Provide the following information at the prompts:
-
Select a language for your function project: Choose
Java
. -
Provide a group ID: Choose
com.function
. -
Provide an artifact ID: Choose
myFunction
. -
Provide a version: Choose
1.0-SNAPSHOT
. -
Provide a package name: Choose
com.function
. -
Provide an app name: Choose
myFunction-12345
. -
Authorization level: Choose
Anonymous
, which enables anyone to call your function endpoint. To learn about authorization level, see Authorization keys. -
Select how you would like to open your project: Choose
Add to workspace
.
-
-
Using this information, Visual Studio Code generates an Azure Functions project with an HTTP trigger. You can view the local project files in the Explorer. To learn more about files that are created, see Generated project files.
[!INCLUDE functions-run-function-test-local-vs-code]
After you've verified that the function runs correctly on your local computer, it's time to use Visual Studio Code to publish the project directly to Azure.
[!INCLUDE functions-sign-in-vs-code]
In this section, you create a function app and related resources in your Azure subscription and then deploy your code.
Important
Publishing to an existing function app overwrites the content of that app in Azure.
-
Choose the Azure icon in the Activity bar, then in the Azure: Functions area, choose the Deploy to function app... button.
-
Provide the following information at the prompts:
-
Select folder: Choose a folder from your workspace or browse to one that contains your function app. You won't see this if you already have a valid function app opened.
-
Select subscription: Choose the subscription to use. You won't see this if you only have one subscription.
-
Select Function App in Azure: Choose
+ Create new Function App
. (Don't choose theAdvanced
option, which isn't covered in this article.) -
Enter a globally unique name for the function app: Type a name that is valid in a URL path. The name you type is validated to make sure that it's unique in Azure Functions.
-
Select a location for new resources: For better performance, choose a region near you.
-
-
When completed, the following Azure resources are created in your subscription, using names based on your function app name:
- A resource group, which is a logical container for related resources.
- A standard Azure Storage account, which maintains state and other information about your projects.
- A consumption plan, which defines the underlying host for your serverless function app.
- A function app, which provides the environment for executing your function code. A function app lets you group functions as a logical unit for easier management, deployment, and sharing of resources within the same hosting plan.
- An Application Insights instance connected to the function app, which tracks usage of your serverless function.
A notification is displayed after your function app is created and the deployment package is applied.
-
Select View Output in this notification to view the creation and deployment results, including the Azure resources that you created. If you miss the notification, select the bell icon in the lower right corner to see it again.
-
Back in the Azure: Functions area in the side bar, expand the new function app under your subscription. Expand Functions, right-click (Windows) or Ctrl + click (macOS) on HttpExample, and then choose Copy function URL.
-
Paste this URL for the HTTP request into your browser's address bar, add the
name
query string as?name=Functions
to the end of this URL, and then execute the request. The URL that calls your HTTP-triggered function should be in the following format:http://<functionappname>.azurewebsites.net/api/httpexample?name=Functions
The following example shows the response in the browser to the remote GET request returned by the function:
When you continue to the next step, Add an Azure Storage queue binding to your function, you'll need to keep all your resources in place to build on what you've already done.
Otherwise, you can use the following steps to delete the function app and its related resources to avoid incurring any further costs.
[!INCLUDE functions-cleanup-resources-vs-code.md]
To learn more about Functions costs, see Estimating Consumption plan costs.
You have used Visual Studio Code to create a function app with a simple HTTP-triggered function. In the next article, you expand that function by adding an output binding. This binding writes the string from the HTTP request to a message in an Azure Queue Storage queue.
[!div class="nextstepaction"] Add an Azure Storage queue binding to your function