Skip to content

Latest commit

 

History

History
109 lines (74 loc) · 6.47 KB

create-first-function-vs-code-typescript.md

File metadata and controls

109 lines (74 loc) · 6.47 KB
title description ms.topic ms.date ms.devlang ms.custom zone_pivot_groups
Create a TypeScript function using Visual Studio Code - Azure Functions
Learn how to create a TypeScript function, then publish the local Node.js project to serverless hosting in Azure Functions using the Azure Functions extension in Visual Studio Code.
quickstart
06/03/2024
typescript
mode-ui, vscode-azure-extension-update-complete, devx-track-js, devx-track-ts
functions-nodejs-model

Quickstart: Create a function in Azure with TypeScript using Visual Studio Code

In this article, you use Visual Studio Code to create a TypeScript function that responds to HTTP requests. After testing the code locally, you deploy it to the serverless environment of Azure Functions.

[!INCLUDE functions-nodejs-model-pivot-description]

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

There's also a CLI-based version of this article.

Configure your environment

Before you get started, make sure you have the following requirements in place:

::: zone pivot="nodejs-model-v3"

::: zone pivot="nodejs-model-v3"

Create your local project

In this section, you use Visual Studio Code to create a local Azure Functions project in TypeScript. Later in this article, you publish your function code to Azure.

  1. In Visual Studio Code, press F1 to open the command palette and search for and run the command Azure Functions: Create New Project....

  2. Choose the directory location for your project workspace and choose Select. You should either create a new folder or choose an empty folder for the project workspace. Don't choose a project folder that is already part of a workspace.

::: zone pivot="nodejs-model-v3" 3. Provide the following information at the prompts:

|Prompt|Selection|
|--|--|
|**Select a language for your function project**|Choose `TypeScript`.|
|**Select a TypeScript programming model**|Choose `Model V3`|
|**Select a template for your project's first function**|Choose `HTTP trigger`.|
|**Provide a function name**|Type `HttpExample`.|
|**Authorization level**|Choose `Anonymous`, which enables anyone to call your function endpoint. To learn about authorization level, see [Authorization keys](functions-bindings-http-webhook-trigger.md#authorization-keys).|
|**Select how you would like to open your project**|Choose `Open in current window`.|

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](functions-develop-vs-code.md?tabs=typescript#generated-project-files).

::: zone-end ::: zone pivot="nodejs-model-v4" 3. Provide the following information at the prompts:

|Prompt|Selection|
|--|--|
|**Select a language for your function project**|Choose `TypeScript`.|
|**Select a TypeScript programming model**|Choose `Model V4`|
|**Select a template for your project's first function**|Choose `HTTP trigger`.|
|**Provide a function name**|Type `HttpExample`.|
|**Select how you would like to open your project**|Choose `Open in current window`|

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 [Azure Functions TypeScript developer guide](functions-reference-node.md?tabs=typescript). 

::: zone-end

[!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]

Create the function app in Azure

[!INCLUDE functions-create-azure-resources-vs-code]

Deploy the project to Azure

[!INCLUDE functions-deploy-project-vs-code]

[!INCLUDE functions-vs-code-run-remote]

[!INCLUDE functions-cleanup-resources-vs-code.md]

Next steps

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 connecting to Azure Storage. To learn more about connecting to other Azure services, see Add bindings to an existing function in Azure Functions.

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