vscode-azurefunctions/README.md

Azure Functions for Visual Studio Code (Preview)

Prerequisites

• Install your desired version of the Azure Functions Core Tools
  • For version 2.0 (This version works cross-platform, but is still in preview and not recommended for production):
    • Install .NET Core 2.0
    • Install the Azure Functions Core Tools:

    npm install -g azure-functions-core-tools@core
    

    Note: When installing on Ubuntu, you may need to use sudo. On MacOS and Linux, you may need to include the unsafe-perm flag, as follows:

    sudo npm install -g azure-functions-core-tools@core --unsafe-perm true
    

  • For version 1.0 (This version is only supported on Windows):

    npm install -g azure-functions-core-tools
    

• Install the prerequisites for your desired language:
  • JavaScript
  • C#
  • Java

NOTE: You may change your azureFunctions.projectLanguage user setting to multiple other 'preview' languages not listed above. This allows you to create a project/function in that language, but we do not yet support local debugging for these languages.

Features

• Create new Function projects
• Create new Functions from a template
• Debug Function projects locally
• Deploy to Azure Function Apps
• View, create, delete, start, stop, and restart Azure Function Apps
• JSON Intellisense for function.json, host.json, and proxies.json

Create New Project

Debug Function App Locally

Deploy to Azure

Language-Specific Prerequisites

JavaScript

• Node 8.0+

C#

• VS Code Debugger for C#
• .NET CLI
• .NET Templates for Azure Functions
  • You will be automatically prompted to install these templates when you first create a project/function
    • If you are using v2.0 of the Azure Functions runtime, you must install the beta (.NET Core) templates
    • If you are using v1.0 of the Azure Functions runtime, you must install the v1.0 (.NET Framework) templates.

    NOTE: The VS Code Debugger for C# only supports attaching to 64-bit processes. v1.0 of the Azure Functions runtime defaults to 32-bit and you must install a 64-bit version. See here for instructions.

  • You may uninstall or reinstall the templates with the following steps:
    1. Open Command Palette (View -> Command Palette...)
    2. Search for "Azure Functions" and "install" or "uninstall"
    3. Run the corresponding command for .NET templates

NOTE: The default experience for C# uses class libraries (*.cs files), which provide superior performance, scalability, and versatility over C# Scripts (*.csx files). If you want to use C# Scripts, you may change your azureFunctions.projectLanguage user setting to C#Script.

Java

• VS Code Debugger for Java
• JDK 1.8+
• Maven 3.0+

Contributing

There are a couple of ways you can contribute to this repo:

• Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads.
• Documentation: Found a typo or strangely worded sentences? Submit a PR!
• Code: Contribute bug fixes, features or design changes:
  • Clone the repository locally and open in VS Code.
  • Install TSLint for Visual Studio Code.
  • Open the terminal (press CTRL+`) and run npm install.
  • To build, press F1 and type in Tasks: Run Build Task.
  • Debug: press F5 to start debugging the extension.

Legal

Before we can accept your pull request you will need to sign a Contribution License Agreement. All you need to do is to submit a pull request, then the PR will get appropriately labelled (e.g. cla-required, cla-norequired, cla-signed, cla-already-signed). If you already signed the agreement we will continue with reviewing the PR, otherwise system will tell you how you can sign the CLA. Once you sign the CLA all future PR's will be labeled as cla-signed.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Telemetry

VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

License

MIT