Skip to content
Azure Functions extension for VS Code
HTML TypeScript C# Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.azure-pipelines Remove intellinav (#1588) Oct 16, 2019
.github Send PR emails to fewer people (#1486) Sep 11, 2019
.vscode Minor updates to dev config (#1535) Oct 2, 2019
resources Actually support cached/backup/verified templates for Java (#1525) Sep 30, 2019
src
test Add support for file tree items 🗄🌲 (#1592) Oct 17, 2019
tools/JsonCli Change beta to ~2 (#581) Sep 12, 2018
.gitignore Clean up nightly tests (#1414) Aug 1, 2019
.vscodeignore Clean up nightly tests (#1414) Aug 1, 2019
CHANGELOG.md Patch release for "Add Binding" 😞 (#1585) Oct 15, 2019
LICENSE.md Add functions explorer Sep 21, 2017
NOTICE.html Prep for 0.19.0 release (#1574) Oct 11, 2019
README.md Enable slot support (#1554) Oct 8, 2019
extension.bundle.ts Add nuget versioning logic for getting bundle templates (#1545) Oct 7, 2019
gulpfile.ts Add python test (#1482) Sep 25, 2019
main.js Don't break other installed extensions when running with no webpack (#… May 2, 2019
package-lock.json Add support for file tree items 🗄🌲 (#1592) Oct 17, 2019
package.json Add support for file tree items 🗄🌲 (#1592) Oct 17, 2019
package.nls.json Add a setting to control terminating func host (#1565) Oct 9, 2019
tsconfig.json Update to gulp 4 and clean up pipelines (#853) Dec 6, 2018
tslint.json Update dependencies (#1470) Aug 29, 2019
webpack.config.js Don't use webpack for local development (#1151) Apr 2, 2019

README.md

Azure Functions for Visual Studio Code (Preview)

Version Installs Build Status GitHub

Create, debug, manage, and deploy Azure Functions directly from VS Code. Check out this deployment tutorial to get started with the Azure Functions extension and check out the Azure serverless community library to view sample projects.

Visit the wiki for additional information about the extension.

Prerequisites

Follow the OS-specific instructions to install the Azure Functions Core Tools:

Install the prerequisites for your desired language:

Features

  • Create new function projects
  • Create new functions from a template
  • Debug function projects locally
  • Deploy to Azure
  • View, create, delete, start, stop, and restart Azure Function Apps
  • View, edit, upload, and download application settings
  • JSON Intellisense for function.json, host.json, and proxies.json
  • Stream logs from your Azure Function Apps
  • View and manage deployment slots
  • Debug Node.js function project in Azure (experimental)

    NOTE: To enable, set azureFunctions.enableRemoteDebugging to true.

  • Debug Java function project in Azure (experimental)

    NOTE: To enable, set azureFunctions.enableJavaRemoteDebugging to true.

Create New Project

CreateProject

Debug Function Project Locally

Debug

Deploy to Azure

Deploy

OS-Specific Prerequisites

NOTE: npm can be used on all platforms. On unix platforms, you may need to specify --unsafe-perm if you are running npm with sudo. That's due to npm behavior of post install script.

Windows

Both v1 and v2 of the runtime can be installed on Windows. See here for more information on each version.

To install v1:

npm i -g azure-functions-core-tools@1

To install v2:

npm i -g azure-functions-core-tools@2

Mac

brew tap azure/functions
brew install azure-functions-core-tools

Linux

  1. Set up package feed

    • Ubuntu 18.10

      wget -q https://packages.microsoft.com/config/ubuntu/18.10/packages-microsoft-prod.deb
      sudo dpkg -i packages-microsoft-prod.deb
    • Ubuntu 18.04

      wget -q https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb
      sudo dpkg -i packages-microsoft-prod.deb
    • Ubuntu 16.04 / Linux Mint 18

      wget -q https://packages.microsoft.com/config/ubuntu/16.04/packages-microsoft-prod.deb
      sudo dpkg -i packages-microsoft-prod.deb
  2. Install

    sudo apt-get update
    sudo apt-get install azure-functions-core-tools

See here for more installation options and the latest instructions.

Language-Specific Prerequisites

Node

.NET

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

Python

NOTE: Python 3.6.8 is the last release of Python 3.6 with installable binaries for Windows.

PowerShell

NOTE: Debugging PowerShell functions and placing breakpoints works differently than other languages for now. Take a look at the official guide for locally debugging PowerShell functions for complete steps.

Managing Azure Subscriptions

If you are not signed in to Azure, you will see a "Sign in to Azure..." link. Alternatively, you can select "View->Command Palette" in the VS Code menu, and search for "Azure: Sign In".

Sign in to Azure

If you don't have an Azure Account, you can sign up for one today for free and receive $200 in credits by selecting "Create a Free Azure Account..." or selecting "View->Command Palette" and searching for "Azure: Create an Account".

You may sign out of Azure by selecting "View->Command Palette" and searching for "Azure: Sign Out".

To select which subscriptions show up in the extension's explorer, click on the "Select Subscriptions..." button on any subscription node (indicated by a "filter" icon when you hover over it), or select "View->Command Palette" and search for "Azure: Select Subscriptions". Note that this selection affects all VS Code extensions that support the Azure Account and Sign-In extension.

Select Azure Subscriptions

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

You can’t perform that action at this time.