Skip to content

Latest commit

 

History

History
195 lines (144 loc) · 6.24 KB

quick-start.md

File metadata and controls

195 lines (144 loc) · 6.24 KB

Azure Functions - Quickstart

Pre-requisites

  1. Node.js v6.5.0+ (this is the runtime version supported by Azure Functions)
  2. Serverless CLI v1.9.0+. You can run npm i -g serverless if you don't already have it.
  3. An Azure account. If you don't already have one, you can sign up for a free trial that includes $200 of free credit.

Create a new Azure Function App

# Create Azure Function App from template
$ sls create -t azure-nodejs -p <appName>
# Move into project directory
$ cd <appName>
# Install dependencies (including this plugin)
$ npm install

Running Function App Locally (offline plugin)

In order to run a Azure Function App locally, the azure-functions-core-tools package needs to be installed from NPM. Since it is only used for local development, we did not include it in the devDependencies of package.json. To install globally, run:

$ npm i azure-functions-core-tools -g

Then, at the root of your project directory, run:

# Builds necessary function bindings files
$ sls offline
# Starts the function app
$ npm start

The offline process will generate a directory for each of your functions, which will contain a file titled function.json. This will contain a relative reference to your handler file & exported function from that file as long as they are referenced correctly in serverless.yml.

The npm start script just runs func host start, but we included the npm script for ease of use.

To clean up files generated from the build, you can simply run:

sls offline cleanup

Deploy Your Function App

Deploy your new service to Azure! The first time you do this, you will be asked to authenticate with your Azure account, so the serverless CLI can manage Functions on your behalf. Simply follow the provided instructions, and the deployment will continue as soon as the authentication process is completed.

$ sls deploy

For more advanced deployment scenarios, see our deployment docs

Test Your Function App

Invoke your HTTP functions without ever leaving the CLI using:

$ sls invoke -f <functionName>
Invoke Options
  • -f or --function - Function to Invoke
  • -d or --data - Stringified JSON data to use as either query params or request body
  • -p or --path - Path to JSON file to use as either query params or request body
  • -m or --method - HTTP method for request
Example

After deploying template function app, run

$ sls invoke -f hello '{"name": "Azure"}'

Roll Back Your Function App

To roll back your function app to a previous deployment, simply select a timestamp of a previous deployment and use rollback command.

# List all deployments to know the timestamp for rollback
$ sls deploy list
Serverless:
-----------
Name: myFunctionApp-t1561479533
Timestamp: 1561479533
Datetime: 2019-06-25T16:18:53+00:00
-----------
Name: myFunctionApp-t1561479506
Timestamp: 1561479506
Datetime: 2019-06-25T16:18:26+00:00
-----------
Name: myFunctionApp-t1561479444
Timestamp: 1561479444
Datetime: 2019-06-25T16:17:24+00:00
-----------

# Rollback Function App to timestamp
$ sls rollback -t 1561479506

This will update the app code and infrastructure to the selected previous deployment.

For more details, check out our rollback docs.

Deleting Your Function App

If at any point you no longer need your service, you can run the following command to delete the resource group containing your Azure Function App and other depoloyed resources using:

$ sls remove

Creating or removing Azure Functions

To create a new Azure Function within your function app, run the following command from within your app's directory:

# -n or --name for name of new function
$ sls func add -n {functionName}

This will create a new handler file at the root of your project with the title {functionName}.js. It will also update serverless.yml to contain the new function.

To remove an existing Azure Function from your function app, run the following command from within your app's directory:

# -n or --name for name of function to remove
$ sls func remove -n {functionName}

This will remove the {functionName}.js handler and remove the function from serverless.yml

*Note: Add & remove currently only support HTTP triggered functions. For other triggers, you will need to update serverless.yml manually

Advanced Authentication

The getting started walkthrough illustrates the interactive login experience, which is recommended when getting started. However, for more robust use, a service principal is recommended for authentication.

Creating a Service Principal

  1. Install the Azure CLI

  2. Login via Azure CLI and set subscription

    # Login to Azure
$ az login
# Set Azure Subscription for which to create Service Principal
$ az account set -s <subscription-id>

  3. Generate Service Principal for Azure Subscription

    # Create SP with unique name
$ az ad sp create-for-rbac --name <name>

    This will yield something like:

    {
  "appId": "<servicePrincipalId>",
  "displayName": "<name>",
  "name": "<name>",
  "password": "<password>",
  "tenant": "<tenantId>"
}

  4. Set environment variables

    Bash

    $ export AZURE_SUBSCRIPTION_ID='<subscriptionId>'
$ export AZURE_TENANT_ID='<tenantId>'
$ export AZURE_CLIENT_ID='<servicePrincipalId>'
$ export AZURE_CLIENT_SECRET='<password>'

    Powershell

    $env:AZURE_SUBSCRIPTION_ID='<subscriptionId>'
$env:AZURE_TENANT_ID='<tenantId>'
$env:AZURE_CLIENT_ID='<servicePrincipalName>'
$env:AZURE_CLIENT_SECRET='<password>'