Enlaces de salida HTTP de Azure Functions

Use el enlace de salida HTTP para responder al remitente de la solicitud HTTP (desencadenador HTTP). Este enlace requiere un desencadenador HTTP y le permite personalizar la respuesta asociada con la solicitud del desencadenador.

El valor devuelto predeterminado para una función desencadenada por HTTP es:

  • HTTP 204 No Content con el cuerpo vacío en Functions 2.x y posterior
  • HTTP 200 OK con el cuerpo vacío en Functions 1.x

Attribute

No se requiere un atributo de valor devuelto al usar HttpResponseData. Sin embargo, cuando se usa una integración de ASP.NET Core y objetos de salida de varios enlaces, el [HttpResultAttribute] atributo debe aplicarse a la propiedad de objeto. El atributo no toma parámetros. Para obtener más información, consulte Uso.

anotaciones

En la biblioteca en tiempo de ejecución de funciones de Java, use la anotación HttpOutput para definir una variable de salida que no sea la variable predeterminada devuelta por la función. Esta anotación admite los valores siguientes:

Importante

En este artículo se usan pestañas para admitir varias versiones del modelo de programación de Node.js. El modelo v4 está disponible de forma general y está diseñado para que los desarrolladores de JavaScript y TypeScript tengan una experiencia más flexible e intuitiva. Para más detalles acerca de cómo funciona el modelo v4, consulte la Guía para desarrolladores de Node.js de Azure Functions. Para obtener más información acerca de las diferencias entre v3 y v4, consulte la Guía de migración.

Configuración

El objeto options pasado al método output.http() actualmente no admite ninguna propiedad para el modelo v4.

Configuración

En la siguiente tabla se explican las propiedades de configuración de enlace que se establecen en el archivo function.json.

Propiedad Descripción
type Se debe establecer en http.
direction Se debe establecer en out.
name Nombre de la variable usado en el código de la función para la respuesta, o $return para usar el valor devuelto.

Uso

Para enviar una respuesta HTTP, use los patrones de respuesta estándar del lenguaje.

En .NET, el tipo de respuesta depende del modo de C#:

La función desencadenada por HTTP devuelve un objeto de uno de los siguientes tipos:

  • IActionResult1 (o Task<IActionResult>)
  • HttpResponse1 (o Task<HttpResponse>)
  • HttpResponseData (o Task<HttpResponseData>)
  • Tipos serializables JSON que representan el cuerpo de la respuesta de una 200 OK respuesta.

1 Este tipo solo está disponible cuando se usa la integración de ASP.NET Core.

Cuando uno de estos tipos se usa como parte de objetos de salida de varios enlaces, el [HttpResult] atributo se debe aplicar a la propiedad de objeto. El atributo no toma parámetros.

Para Java, use HttpResponseMessage.Builder para crear una respuesta al desencadenador HTTP. Para obtener más información, consulte HttpRequestMessage y HttpResponseMessage.

Para ver respuestas de ejemplo, consulte los ejemplos de desencadenador.

Pasos siguientes