Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 3.83 KB

functions-bindings-http-webhook-output.md

File metadata and controls

100 lines (63 loc) · 3.83 KB
title description author ms.topic ms.date ms.author zone_pivot_groups
Azure Functions HTTP output bindings
Learn how to return HTTP responses in Azure Functions.
ggailey777
reference
02/21/2020
cshoe
programming-languages-set-functions-lang-workers

Azure Functions HTTP output bindings

Use the HTTP output binding to respond to the HTTP request sender (HTTP trigger). This binding requires an HTTP trigger and allows you to customize the response associated with the trigger's request.

The default return value for an HTTP-triggered function is:

  • HTTP 204 No Content with an empty body in Functions 2.x and higher
  • HTTP 200 OK with an empty body in Functions 1.x

::: zone pivot="programming-language-csharp"

Attribute

Both in-process and isolated process C# libraries don't require an attribute. C# script uses a function.json configuration file.

In-process

A return value attribute isn't required. To learn more, see Usage.

Isolated process

A return value attribute isn't required. To learn more, see Usage.

C# Script

The following table explains the binding configuration properties that you set in the function.json file.

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.

::: zone-end ::: zone pivot="programming-language-java"

Annotations

In the Java functions runtime library, use the HttpOutput annotation to define an output variable other than the default variable returned by the function. This annotation supports the following settings:

::: zone-end ::: zone pivot="programming-language-javascript,programming-language-python,programming-language-powershell"

Configuration

The following table explains the binding configuration properties that you set in the function.json file.

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.

::: zone-end

Usage

To send an HTTP response, use the language-standard response patterns.

::: zone pivot="programming-language-csharp" The response type depends on the C# mode:

In-process

The HTTP triggered function returns a type of IActionResult or Task<IActionResult>.

Isolated process

The HTTP triggered function returns an HttpResponseData object.

C# Script

The HTTP triggered function returns a type of IActionResult or Task<IActionResult>.

::: zone-end
::: zone pivot="programming-language-java"

For Java, use an HttpResponseMessage.Builder to create a response to the HTTP trigger. To learn more, see HttpRequestMessage and HttpResponseMessage.

::: zone-end

For example responses, see the trigger examples.

Next steps