Powiązania wyjściowe HTTP usługi Azure Functions
Użyj powiązania danych wyjściowych HTTP, aby odpowiedzieć na nadawcę żądania HTTP (wyzwalacz HTTP). To powiązanie wymaga wyzwalacza HTTP i pozwala na dostosowanie odpowiedzi skojarzonej z żądaniem wyzwalacza.
Domyślna wartość zwracana dla funkcji wyzwalanej przez protokół HTTP to:
HTTP 204 No Content
z pustą treścią w usłudze Functions w wersji 2.x lub nowszejHTTP 200 OK
z pustą treścią w usłudze Functions 1.x
Atrybut
Atrybut wartości zwracanej nie jest wymagany w przypadku używania atrybutu HttpResponseData. Jednak w przypadku korzystania z obiektów wyjściowych integracji ASP.NET Core i obiektów wyjściowych z wieloma powiązaniami[HttpResultAttribute]
należy zastosować atrybut do właściwości obiektu. Atrybut nie przyjmuje żadnych parametrów. Aby dowiedzieć się więcej, zobacz Użycie.
Adnotacje
W bibliotece środowiska uruchomieniowego funkcji Języka Java użyj adnotacji HttpOutput, aby zdefiniować zmienną wyjściową inną niż zmienna domyślna zwracana przez funkcję. Ta adnotacja obsługuje następujące ustawienia:
Ważne
W tym artykule są używane karty do obsługi wielu wersji modelu programowania Node.js. Model w wersji 4 jest ogólnie dostępny i ma bardziej elastyczne i intuicyjne środowisko dla deweloperów języka JavaScript i Języka TypeScript. Aby uzyskać więcej informacji na temat sposobu działania modelu w wersji 4, zapoznaj się z przewodnikiem dewelopera dotyczącym usługi Azure Functions Node.js. Aby dowiedzieć się więcej o różnicach między wersjami 3 i v4, zapoznaj się z przewodnikiem migracji.
Konfigurowanie
Obiekt options
przekazany do output.http()
metody obecnie nie obsługuje żadnych właściwości modelu w wersji 4.
Konfigurowanie
W poniższej tabeli opisano właściwości konfiguracji powiązania ustawione w pliku function.json .
Właściwości | Opis |
---|---|
type | Musi być ustawiona wartość http . |
direction | Musi być ustawiona wartość out . |
name | Nazwa zmiennej używana w kodzie funkcji dla odpowiedzi lub $return do użycia wartości zwracanej. |
Użycie
Aby wysłać odpowiedź HTTP, użyj standardowych wzorców odpowiedzi języka.
Na platformie .NET typ odpowiedzi zależy od trybu C#:
Funkcja wyzwalana przez protokół HTTP zwraca obiekt jednego z następujących typów:
- IActionResult1 (lub
Task<IActionResult>
) - HttpResponse1 (lub
Task<HttpResponse>
) - HttpResponseData (lub
Task<HttpResponseData>
) - Typy serializacji JSON reprezentujące treść odpowiedzi dla
200 OK
odpowiedzi.
1 Ten typ jest dostępny tylko w przypadku korzystania z integracji ASP.NET Core.
Jeśli jeden z tych typów jest używany jako część obiektów wyjściowych z wieloma powiązaniami, [HttpResult]
atrybut powinien zostać zastosowany do właściwości obiektu. Atrybut nie przyjmuje żadnych parametrów.
W przypadku języka Java użyj wyzwalacza HTTPResponseMessage.Builder , aby utworzyć odpowiedź na wyzwalacz HTTP. Aby dowiedzieć się więcej, zobacz HttpRequestMessage i HttpResponseMessage.
Przykładowe odpowiedzi można znaleźć w przykładach wyzwalacza.