Ligações de saída HTTP do Azure Functions

  • Artigo

Use a ligação de saída HTTP para responder ao remetente da solicitação HTTP (gatilho HTTP). Esse enlace requer um acionador HTTP e permite-lhe personalizar a resposta associada ao pedido do acionador.

O valor de retorno padrão para uma função acionada por HTTP é:

  • HTTP 204 No Content com um corpo vazio em Funções 2.x e superiores
  • HTTP 200 OK com um corpo vazio no Functions 1.x

Atributo

Um atributo return value não é necessário ao usar HttpResponseData. No entanto, ao usar uma integração do ASP.NET Core e objetos de saída de multiligação, o [HttpResultAttribute] atributo deve ser aplicado à propriedade do objeto. O atributo não usa parâmetros. Para saber mais, consulte Uso.

Anotações

Na biblioteca de tempo de execução de funções Java, use a anotação HttpOutput para definir uma variável de saída diferente da variável padrão retornada pela função. Esta anotação suporta as seguintes configurações:

Importante

Este artigo usa guias para oferecer suporte a várias versões do modelo de programação Node.js. O modelo v4 está geralmente disponível e foi projetado para ter uma experiência mais flexível e intuitiva para desenvolvedores JavaScript e TypeScript. Para obter mais detalhes sobre como o modelo v4 funciona, consulte o Guia do desenvolvedor do Azure Functions Node.js. Para saber mais sobre as diferenças entre v3 e v4, consulte o guia de migração.

Configuração

O options objeto passado para o método atualmente não suporta nenhuma propriedade para o output.http() modelo v4.

Configuração

A tabela a seguir explica as propriedades de configuração de associação definidas no arquivo function.json .

Property Descrição
type Deve ser definido como http.
direção Deve ser definido como out.
Designação O nome da variável usado no código de função para a resposta ou $return para usar o valor de retorno.

Utilização

Para enviar uma resposta HTTP, use os padrões de resposta padrão de idioma.

No .NET, o tipo de resposta depende do modo C#:

A função acionada HTTP retorna um objeto de um dos seguintes tipos:

  • IActionResult1 (ou Task<IActionResult>)
  • HttpResponse1 (ou Task<HttpResponse>)
  • HttpResponseData (ou Task<HttpResponseData>)
  • Tipos serializáveis JSON que representam o corpo da resposta para uma 200 OK resposta.

1 Este tipo só está disponível quando se utiliza a integração ASP.NET Core.

Quando um desses tipos é usado como parte de objetos de saída de ligação múltipla, o [HttpResult] atributo deve ser aplicado à propriedade object. O atributo não usa parâmetros.

Para Java, use um HttpResponseMessage.Builder para criar uma resposta ao gatilho HTTP. Para saber mais, consulte HttpRequestMessage e HttpResponseMessage.

Para exemplos de respostas, consulte os exemplos de gatilho.

Próximos passos