| title | description | services | documentationcenter | author | manager | keywords | ms.service | ms.devlang | ms.topic | ms.date | ms.author |
|---|---|---|---|---|---|---|---|---|---|---|---|
Azure Functions HTTP triggers and bindings |
Understand how to use HTTP triggers and bindings in Azure Functions. |
functions |
na |
craigshoemaker |
jeconnoc |
azure functions, functions, event processing, webhooks, dynamic compute, serverless architecture, HTTP, API, REST |
azure-functions |
multiple |
reference |
11/21/2017 |
cshoe |
This article explains how to work with HTTP triggers and output bindings in Azure Functions.
An HTTP trigger can be customized to respond to webhooks.
[!INCLUDE intro]
[!INCLUDE HTTP client best practices]
The HTTP bindings are provided in the Microsoft.Azure.WebJobs.Extensions.Http NuGet package, version 1.x. Source code for the package is in the azure-webjobs-sdk-extensions GitHub repository.
[!INCLUDE functions-package-auto]
The HTTP bindings are provided in the Microsoft.Azure.WebJobs.Extensions.Http NuGet package, version 3.x. Source code for the package is in the azure-webjobs-sdk-extensions GitHub repository.
[!INCLUDE functions-package]
The HTTP trigger lets you invoke a function with an HTTP request. You can use an HTTP trigger to build serverless APIs and respond to webhooks.
By default, an HTTP trigger returns HTTP 200 OK with an empty body in Functions 1.x, or HTTP 204 No Content with an empty body in Functions 2.x. To modify the response, configure an HTTP output binding.
See the language-specific example:
The following example shows a C# function that looks for a name parameter either in the query string or the body of the HTTP request. Notice that the return value is used for the output binding, but a return value attribute isn't required.
[FunctionName("HttpTriggerCSharp")]
public static async Task<HttpResponseMessage> Run(
[HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)]HttpRequestMessage req,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
// parse query parameter
string name = req.GetQueryNameValuePairs()
.FirstOrDefault(q => string.Compare(q.Key, "name", true) == 0)
.Value;
// Get request body
dynamic data = await req.Content.ReadAsAsync<object>();
// Set name to query string or body data
name = name ?? data?.name;
return name == null
? req.CreateResponse(HttpStatusCode.BadRequest, "Please pass a name on the query string or in the request body")
: req.CreateResponse(HttpStatusCode.OK, "Hello " + name);
}The following example shows a trigger binding in a function.json file and a C# script function that uses the binding. The function looks for a name parameter either in the query string or the body of the HTTP request.
Here's the function.json file:
{
"disabled": false,
"bindings": [
{
"authLevel": "function",
"name": "req",
"type": "httpTrigger",
"direction": "in",
"methods": [
"get",
"post"
]
},
{
"name": "$return",
"type": "http",
"direction": "out"
}
]
}The configuration section explains these properties.
Here's C# script code that binds to HttpRequestMessage:
using System.Net;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
public static async Task<HttpResponseMessage> Run(HttpRequestMessage req, ILogger log)
{
log.LogInformation($"C# HTTP trigger function processed a request. RequestUri={req.RequestUri}");
// parse query parameter
string name = req.GetQueryNameValuePairs()
.FirstOrDefault(q => string.Compare(q.Key, "name", true) == 0)
.Value;
// Get request body
dynamic data = await req.Content.ReadAsAsync<object>();
// Set name to query string or body data
name = name ?? data?.name;
return name == null
? req.CreateResponse(HttpStatusCode.BadRequest, "Please pass a name on the query string or in the request body")
: req.CreateResponse(HttpStatusCode.OK, "Hello " + name);
}You can bind to a custom object instead of HttpRequestMessage. This object is created from the body of the request, parsed as JSON. Similarly, a type can be passed to the HTTP response output binding and returned as the response body, along with a 200 status code.
using System.Net;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
public static string Run(CustomObject req, ILogger log)
{
return "Hello " + req?.name;
}
public class CustomObject {
public String name {get; set;}
}The following example shows a trigger binding in a function.json file and an F# function that uses the binding. The function looks for a name parameter either in the query string or the body of the HTTP request.
Here's the function.json file:
{
"bindings": [
{
"authLevel": "function",
"name": "req",
"type": "httpTrigger",
"direction": "in"
},
{
"name": "res",
"type": "http",
"direction": "out"
}
],
"disabled": false
}The configuration section explains these properties.
Here's the F# code:
open System.Net
open System.Net.Http
open FSharp.Interop.Dynamic
let Run(req: HttpRequestMessage) =
async {
let q =
req.GetQueryNameValuePairs()
|> Seq.tryFind (fun kv -> kv.Key = "name")
match q with
| Some kv ->
return req.CreateResponse(HttpStatusCode.OK, "Hello " + kv.Value)
| None ->
let! data = Async.AwaitTask(req.Content.ReadAsAsync<obj>())
try
return req.CreateResponse(HttpStatusCode.OK, "Hello " + data?name)
with e ->
return req.CreateErrorResponse(HttpStatusCode.BadRequest, "Please pass a name on the query string or in the request body")
} |> Async.StartAsTaskYou need a project.json file that uses NuGet to reference the FSharp.Interop.Dynamic and Dynamitey assemblies, as shown in the following example:
{
"frameworks": {
"net46": {
"dependencies": {
"Dynamitey": "1.0.2",
"FSharp.Interop.Dynamic": "3.0.0"
}
}
}
}The following example shows a trigger binding in a function.json file and a JavaScript function that uses the binding. The function looks for a name parameter either in the query string or the body of the HTTP request.
Here's the function.json file:
{
"disabled": false,
"bindings": [
{
"authLevel": "function",
"type": "httpTrigger",
"direction": "in",
"name": "req"
},
{
"type": "http",
"direction": "out",
"name": "res"
}
]
}The configuration section explains these properties.
Here's the JavaScript code:
module.exports = function(context, req) {
context.log('Node.js HTTP trigger function processed a request. RequestUri=%s', req.originalUrl);
if (req.query.name || (req.body && req.body.name)) {
context.res = {
// status defaults to 200 */
body: "Hello " + (req.query.name || req.body.name)
};
}
else {
context.res = {
status: 400,
body: "Please pass a name on the query string or in the request body"
};
}
context.done();
};The following example shows a trigger binding in a function.json file and a Java function that uses the binding. The function returns an HTTP status code 200 response with a request body that prefixes the triggering request body with a "Hello, " greeting.
Here's the function.json file:
{
"disabled": false,
"bindings": [
{
"authLevel": "anonymous",
"type": "httpTrigger",
"direction": "in",
"name": "req"
},
{
"type": "http",
"direction": "out",
"name": "res"
}
]
}Here's the Java code:
@FunctionName("hello")
public HttpResponseMessage<String> hello(@HttpTrigger(name = "req", methods = {"post"}, authLevel = AuthorizationLevel.ANONYMOUS), Optional<String> request,
final ExecutionContext context)
{
// default HTTP 200 response code
return String.format("Hello, %s!", request);
}
}In C# class libraries, use the HttpTrigger attribute.
You can set the authorization level and allowable HTTP methods in attribute constructor parameters, and there are properties for webhook type and route template. For more information about these settings, see Trigger - configuration. Here's an HttpTrigger attribute in a method signature:
[FunctionName("HttpTriggerCSharp")]
public static HttpResponseMessage Run(
[HttpTrigger(AuthorizationLevel.Anonymous)] HttpRequestMessage req)
{
...
}For a complete example, see Trigger - C# example.
The following table explains the binding configuration properties that you set in the function.json file and the HttpTrigger attribute.
| function.json property | Attribute property | Description |
|---|---|---|
| type | n/a | Required - must be set to httpTrigger. |
| direction | n/a | Required - must be set to in. |
| name | n/a | Required - the variable name used in function code for the request or request body. |
| authLevel | AuthLevel | Determines what keys, if any, need to be present on the request in order to invoke the function. The authorization level can be one of the following values:
|
| methods | Methods | An array of the HTTP methods to which the function responds. If not specified, the function responds to all HTTP methods. See customize the http endpoint. |
| route | Route | Defines the route template, controlling to which request URLs your function responds. The default value if none is provided is <functionname>. For more information, see customize the http endpoint. |
| webHookType | WebHookType | Supported only for the version 1.x runtime. Configures the HTTP trigger to act as a webhook receiver for the specified provider. Don't set the methods property if you set this property. The webhook type can be one of the following values:
|
For C# and F# functions, you can declare the type of your trigger input to be either HttpRequestMessage or a custom type. If you choose HttpRequestMessage, you get full access to the request object. For a custom type, the runtime tries to parse the JSON request body to set the object properties.
For JavaScript functions, the Functions runtime provides the request body instead of the request object. For more information, see the JavaScript trigger example.
By default when you create a function for an HTTP trigger, the function is addressable with a route of the form:
http://<yourapp>.azurewebsites.net/api/<funcname>
You can customize this route using the optional route property on the HTTP trigger's input binding. As an example, the following function.json file defines a route property for an HTTP trigger:
{
"bindings": [
{
"type": "httpTrigger",
"name": "req",
"direction": "in",
"methods": [ "get" ],
"route": "products/{category:alpha}/{id:int?}"
},
{
"type": "http",
"name": "res",
"direction": "out"
}
]
}Using this configuration, the function is now addressable with the following route instead of the original route.
http://<yourapp>.azurewebsites.net/api/products/electronics/357
This allows the function code to support two parameters in the address, category and id. You can use any Web API Route Constraint with your parameters. The following C# function code makes use of both parameters.
public static Task<HttpResponseMessage> Run(HttpRequestMessage req, string category, int? id,
ILogger log)
{
if (id == null)
return req.CreateResponse(HttpStatusCode.OK, $"All {category} items were requested.");
else
return req.CreateResponse(HttpStatusCode.OK, $"{category} item with id = {id} has been requested.");
}Here is Node.js function code that uses the same route parameters.
module.exports = function (context, req) {
var category = context.bindingData.category;
var id = context.bindingData.id;
if (!id) {
context.res = {
// status defaults to 200 */
body: "All " + category + " items were requested."
};
}
else {
context.res = {
// status defaults to 200 */
body: category + " item with id = " + id + " was requested."
};
}
context.done();
} By default, all function routes are prefixed with api. You can also customize or remove the prefix using the http.routePrefix property in your host.json file. The following example removes the api route prefix by using an empty string for the prefix in the host.json file.
{
"http": {
"routePrefix": ""
}
}Functions lets you use keys to make it harder to access your HTTP function endpoints during development. A standard HTTP trigger may require such an API key be present in the request.
Important
While keys may help obfuscate your HTTP endpoints during development, they are not intended as a way to secure an HTTP trigger in production. To learn more, see Secure an HTTP endpoint in production.
Note
In the Functions 1.x runtime, webhook providers may use keys to authorize requests in a variety of ways, depending on what the provider supports. This is covered in Webhooks and keys. The version 2.x runtime does not include built-in support for webhook providers.
There are two types of keys:
- Host keys: These keys are shared by all functions within the function app. When used as an API key, these allow access to any function within the function app.
- Function keys: These keys apply only to the specific functions under which they are defined. When used as an API key, these only allow access to that function.
Each key is named for reference, and there is a default key (named "default") at the function and host level. Function keys take precedence over host keys. When two keys are defined with the same name, the function key is always used.
Each function app also has a special master key. This key is a host key named _master, which provides administrative access to the runtime APIs. This key cannot be revoked. When you set an authorization level of admin, requests must use the master key; any other key results in authorization failure.
Caution
Due to the elevated permissions in your function app granted by the master key, you should not share this key with third parties or distribute it in native client applications. Use caution when choosing the admin authorization level.
Keys are stored as part of your function app in Azure and are encrypted at rest. To view your keys, create new ones, or roll keys to new values, navigate to one of your HTTP-triggered functions in the Azure portal and select Manage.
There is no supported API for programmatically obtaining function keys.
Most HTTP trigger templates require an API key in the request. So your HTTP request normally looks like the following URL:
https://<yourapp>.azurewebsites.net/api/<function>?code=<ApiKey>
The key can be included in a query string variable named code, as above. It can also be included in an x-functions-key HTTP header. The value of the key can be any function key defined for the function, or any host key.
You can allow anonymous requests, which do not require keys. You can also require that the master key be used. You change the default authorization level by using the authLevel property in the binding JSON. For more information, see Trigger - configuration.
Note
When running functions locally, authorization is disabled regardless of the specified authentication level setting. After publishing to Azure, the authLevel setting in your trigger is enforced.
To fully secure your function endpoints in production, you should consider implementing one of the following function app-level security options:
-
Turn on App Service Authentication / Authorization for your function app. The App Service platform lets use Azure Active Directory (AAD) and several third-party identity providers to authenticate clients. You can use this to implement custom authorization rules for your functions, and you can work with user information from your function code. To learn more, see Authentication and authorization in Azure App Service.
-
Use Azure API Management (APIM) to authenticate requests. APIM provides a variety of API security options for incoming requests. To learn more, see API Management authentication policies. With APIM in place, you can configure your function app to accept requests only from the IP address of your APIM instance. To learn more, see IP address restrictions.
-
Deploy your function app to an Azure App Service Environment (ASE). ASE provides a dedicated hosting environment in which to run your functions. ASE lets you configure a single front-end gateway that you can use to authenticate all incoming requests. For more information, see Configuring a Web Application Firewall (WAF) for App Service Environment.
When using one of these function app-level security methods, you should set the HTTP-triggered function authentication level to anonymous.
Note
Webhook mode is only available for version 1.x of the Functions runtime.
Webhook mode provides additional validation for webhook payloads. In version 2.x, the base HTTP trigger still works and is the recommended approach for webhooks.
To respond to GitHub webhooks, first create your function with an HTTP Trigger, and set the webHookType property to github. Then copy its URL and API key into the Add webhook page of your GitHub repository.
For an example, see Create a function triggered by a GitHub webhook.
The Slack webhook generates a token for you instead of letting you specify it, so you must configure a function-specific key with the token from Slack. See Authorization keys.
Webhook authorization is handled by the webhook receiver component, part of the HTTP trigger, and the mechanism varies based on the webhook type. Each mechanism does rely on a key. By default, the function key named "default" is used. To use a different key, configure the webhook provider to send the key name with the request in one of the following ways:
- Query string: The provider passes the key name in the
clientidquery string parameter, such ashttps://<yourapp>.azurewebsites.net/api/<funcname>?clientid=<keyname>. - Request header: The provider passes the key name in the
x-functions-clientidheader.
The HTTP request length is limited to 100 MB (104,857,600 bytes), and the URL length is limited to 4 KB (4,096 bytes). These limits are specified by the httpRuntime element of the runtime's Web.config file.
If a function that uses the HTTP trigger doesn't complete within about 2.5 minutes, the gateway will time out and return an HTTP 502 error. The function will continue running but will be unable to return an HTTP response. For long-running functions, we recommend that you follow async patterns and return a location where you can ping the status of the request. For information about how long a function can run, see Scale and hosting - Consumption plan.
The host.json file contains settings that control HTTP trigger behavior.
[!INCLUDE functions-host-json-http]
Use the HTTP output binding to respond to the HTTP request sender. This binding requires an HTTP trigger and allows you to customize the response associated with the trigger's request. If an HTTP output binding is not provided, an HTTP trigger returns HTTP 200 OK with an empty body in Functions 1.x, or HTTP 204 No Content with an empty body in Functions 2.x.
The following table explains the binding configuration properties that you set in the function.json file. For C# class libraries, there are no attribute properties that correspond to these function.json properties.
| Property | Description |
|---|---|
| type | Must be set to http. |
| direction | Must be set to out. |
| name | The variable name used in function code for the response, or $return to use the return value. |
To send an HTTP response, use the language-standard response patterns. In C# or C# script, make the function return type HttpResponseMessage or Task<HttpResponseMessage>. In C#, a return value attribute isn't required.
For example responses, see the trigger example.