Výstupní vazby Azure Queue Storage pro Azure Functions

Následující příklad ukazuje funkci jazyka C#, která pro každý přijatý požadavek HTTP vytvoří zprávu fronty.

[StorageAccount("MyStorageConnectionAppSetting")]
public static class QueueFunctions
{
    [FunctionName("QueueOutput")]
    [return: Queue("myqueue-items")]
    public static string QueueOutput([HttpTrigger] dynamic input,  ILogger log)
    {
        log.LogInformation($"C# function processed: {input.Text}");
        return input.Text;
    }
}

Následující příklad ukazuje vazbu triggeru HTTP v souboru function.json a kódu skriptu jazyka C# (.csx), který tuto vazbu používá. Funkce vytvoří položku fronty s datovou část objektu CustomQueueMessage pro každý přijatý požadavek HTTP.

Tady je soubor function.json:

{
  "bindings": [
    {
      "type": "httpTrigger",
      "direction": "in",
      "authLevel": "function",
      "name": "input"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "$return",
      "queueName": "outqueue",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

Tyto vlastnosti jsou vysvětlené v části Konfigurace.

Tady je kód skriptu jazyka C#, který vytvoří jednu zprávu fronty:

public class CustomQueueMessage
{
    public string PersonName { get; set; }
    public string Title { get; set; }
}

public static CustomQueueMessage Run(CustomQueueMessage input, ILogger log)
{
    return input;
}

Pomocí parametru nebo můžete odeslat více zpráv ICollector IAsyncCollector najednou. Tady je kód skriptu jazyka C#, který odesílá více zpráv, jednu s daty požadavku HTTP a jednu s pevnými hodnotami:

public static void Run(
    CustomQueueMessage input, 
    ICollector<CustomQueueMessage> myQueueItems, 
    ILogger log)
{
    myQueueItems.Add(input);
    myQueueItems.Add(new CustomQueueMessage { PersonName = "You", Title = "None" });
}

Následující příklad ukazuje funkci Jazyka Java, která vytvoří zprávu fronty pro při aktivaci požadavkem HTTP.

@FunctionName("httpToQueue")
@QueueOutput(name = "item", queueName = "myqueue-items", connection = "MyStorageConnectionAppSetting")
 public String pushToQueue(
     @HttpTrigger(name = "request", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS)
     final String message,
     @HttpOutput(name = "response") final OutputBinding<String> result) {
       result.setValue(message + " has been added.");
       return message;
 }

V knihovně runtime java functionspoužijte poznámku k parametrům, @QueueOutput jejichž hodnota by byla zapsána do queue storage. Typ parametru by měl být OutputBinding<T> , kde je jakýkoli nativní typ T Javy objektu POJO.

Následující příklad ukazuje vazbu triggeru HTTP v souboru function.json a funkci JavaScriptu, která tuto vazbu používá. Funkce vytvoří položku fronty pro každý přijatý požadavek HTTP.

Tady je soubor function.json:

{
  "bindings": [
    {
      "type": "httpTrigger",
      "direction": "in",
      "authLevel": "function",
      "name": "input"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "myQueueItem",
      "queueName": "outqueue",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

Tyto vlastnosti jsou vysvětlené v části Konfigurace.

Tady je kód JavaScriptu:

module.exports = function (context, input) {
    context.bindings.myQueueItem = input.body;
    context.done();
};

Definováním pole zpráv pro výstupní vazbu můžete odeslat více zpráv myQueueItem najednou. Následující kód JavaScriptu odešle dvě zprávy fronty s pevnými hodnotami pro každý přijatý požadavek HTTP.

module.exports = function(context) {
    context.bindings.myQueueItem = ["message 1","message 2"];
    context.done();
};

Následující příklady kódu ukazují výstup zprávy fronty z funkce aktivované protokolem HTTP. Oddíl konfigurace s type parametrem queue definuje výstupní vazbu.

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "Msg",
      "queueName": "outqueue",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

Pomocí této konfigurace vazby může funkce PowerShellu vytvořit zprávu fronty pomocí Push-OutputBinding . V tomto příkladu se vytvoří zpráva z řetězce dotazu nebo parametru body.

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$message = $Request.Query.Message
Push-OutputBinding -Name Msg -Value $message
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = 200
    Body = "OK"
})

Pokud chcete odeslat více zpráv najednou, definujte pole zpráv a použijte k odesílání Push-OutputBinding zpráv do výstupní vazby fronty.

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$message = @("message1", "message2")
Push-OutputBinding -Name Msg -Value $message
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = 200
    Body = "OK"
})

Následující příklad ukazuje výstup jedné a více hodnot do front úložiště. Konfigurace potřebná pro soubor function.json je v obou stranách stejná.

Vazba Storage fronty je definovaná v souboru function.json, kde type je nastavený na queue .

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureStorageQueuesConnectionString"
    }
  ]
}

Pokud chcete nastavit jednotlivé zprávy ve frontě, předáte metodě jednu set hodnotu.

import azure.functions as func

def main(req: func.HttpRequest, msg: func.Out[str]) -> func.HttpResponse:

    input_msg = req.params.get('message')

    msg.set(input_msg)

    return 'OK'

Pokud chcete ve frontě vytvořit více zpráv, deklarujte parametr jako odpovídající typ seznamu a do metody předejte pole hodnot (které odpovídají typu set seznamu).

import azure.functions as func
import typing

def main(req: func.HttpRequest, msg: func.Out[typing.List[str]]) -> func.HttpResponse:

    msg.set(['one', 'two'])

    return 'OK'

V knihovnách tříd jazyka C#použijte atribut QueueAttribute.

Atribut se vztahuje out na parametr nebo návratovou hodnotu funkce. Konstruktor atributu přebírá název fronty, jak je znázorněno v následujícím příkladu:

[FunctionName("QueueOutput")]
[return: Queue("myqueue-items")]
public static string Run([HttpTrigger] dynamic input,  ILogger log)
{
    ...
}

Můžete nastavit vlastnost Connection a zadat účet úložiště, který se má použít, jak je znázorněno v následujícím příkladu:

[FunctionName("QueueOutput")]
[return: Queue("myqueue-items", Connection = "StorageConnectionAppSetting")]
public static string Run([HttpTrigger] dynamic input,  ILogger log)
{
    ...
}

Kompletní příklad najdete v příkladu výstupu.

Pomocí atributu StorageAccount můžete zadat účet úložiště na úrovni třídy, metody nebo parametru. Další informace najdete v tématu Aktivační událost – atributy.

Skript jazyka C# nepodporuje atributy.

Poznámka umožňuje zapsat zprávu jako QueueOutput výstup funkce. Následující příklad ukazuje funkci aktivované protokolem HTTP, která vytvoří zprávu fronty.

package com.function;
import java.util.*;
import com.microsoft.azure.functions.annotation.*;
import com.microsoft.azure.functions.*;

public class HttpTriggerQueueOutput {
    @FunctionName("HttpTriggerQueueOutput")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.FUNCTION) HttpRequestMessage<Optional<String>> request,
            @QueueOutput(name = "message", queueName = "messages", connection = "MyStorageConnectionAppSetting") OutputBinding<String> message,
            final ExecutionContext context) {

        message.setValue(request.getQueryParameters().get("name"));
        return request.createResponseBuilder(HttpStatus.OK).body("Done").build();
    }
}

Parametr přidružený k QueueOutput poznámce je zadán jako instance <T> OutputBinding.

JavaScript atributy nepodporuje.

PowerShell atributy nepodporuje.

Python atributy nepodporuje.

Výchozí

Pomocí parametru metody, jako je , můžete napsat jednu zprávu out T paramName fronty. Místo parametru můžete použít návratový typ metody a out T může to být kterýkoli z následujících typů:

• Objekt serializovatelný jako JSON
• string
• byte[]
• CloudQueueMessage

Pokud se pokusíte vytvořit vazbu na a zobrazí se chybová zpráva, ujistěte se, že máte odkaz na správnou CloudQueueMessage Storage SDK.

Ve skriptu C# a C# zapište více zpráv fronty pomocí jednoho z následujících typů:

• ICollector<T> nebo IAsyncCollector<T>
• CloudQueue

Další typy

Aplikace, které používají verzi 5.0.0 nebo vyšší Storage, mohou také používat typy ze sady Azure SDK pro .NET. Tato verze zahodí podporu CloudQueue starších verzí a typů a CloudQueueMessage upřednostní následující typy:

• FrontaZpráva
• QueueClient pro zápis více zpráv fronty

Příklady použití těchto typů najdete v GitHub úložiště pro rozšíření.

Výchozí

Pomocí parametru metody, jako je , můžete napsat jednu zprávu out T paramName fronty. paramNameje hodnota zadaná ve vlastnosti name function.json. Místo parametru můžete použít návratový typ metody a out T může to být kterýkoli z následujících typů:

• Objekt serializovatelný jako JSON
• string
• byte[]
• CloudQueueMessage

Pokud se pokusíte vytvořit vazbu na a zobrazí se chybová zpráva, ujistěte se, že máte odkaz na správnou CloudQueueMessage Storage SDK.

Ve skriptu C# a C# zapište více zpráv fronty pomocí jednoho z následujících typů:

• ICollector<T> nebo IAsyncCollector<T>
• CloudQueue

Další typy

Aplikace, které používají verzi 5.0.0 nebo vyšší Storage, mohou také používat typy ze sady Azure SDK pro .NET. Tato verze zahodí podporu CloudQueue starších verzí a typů a CloudQueueMessage upřednostní následující typy:

• FrontaZpráva
• QueueClient pro zápis více zpráv fronty

Příklady použití těchto typů najdete v GitHub úložiště pro rozšíření.

Existují dvě možnosti pro výstup zprávy Queue z funkce pomocí poznámky QueueOutput:

• Návratová hodnota: Použitím anotace na samotnou funkci se návratová hodnota funkce zachová jako zpráva fronty.

• Imperativní: Pokud chcete explicitně nastavit hodnotu zprávy, použijte anotaci na konkrétní parametr typu , kde je POJO nebo jakýkoli OutputBinding<T> nativní typ T Jazyka Java. Při této konfiguraci předání hodnoty setValue metodě zachová hodnotu jako zprávu fronty.

Položka výstupní fronty je k dispozici prostřednictvím context.bindings.<NAME> , kde odpovídá názvu <NAME> definovanému v souboru function.json. Pro datovou část položky fronty můžete použít řetězec nebo objekt JSON-serializable.

Výstup zprávy fronty je k dispozici prostřednictvím příkazu , kde předáte argumenty, které odpovídají názvu určenému parametrem vazby Push-OutputBinding name v souboru function.json.

Existují dvě možnosti pro výstup zprávy fronty z funkce:

• Návratová hodnota: name Nastavte vlastnost v souboru function.json na $return . Při této konfiguraci se návratová hodnota funkce zachová jako zpráva Queue Storage.

• Imperativní: Předejte hodnotu metodě set parametru deklarovaného jako typ Out. Hodnota předaná do set se zachová jako zpráva Queue Storage.