Azure Queue Storage-utdatabindningar för Azure Functions

I följande exempel visas en C#-funktion som skapar ett kömeddelande för varje HTTP-begäran som tas emot.

[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;
    }
}

I följande exempel visas en HTTP-utlösarbindning i en function.json-fil och C#-skriptkod (.csx) som använder bindningen. Funktionen skapar ett köobjekt med en CustomQueueMessage-objektnyttolast för varje HTTP-begäran som tas emot.

Här är filen 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"
    }
  ]
}

Konfigurationsavsnittet förklarar dessa egenskaper.

Här är C#-skriptkod som skapar ett enda kömeddelande:

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

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

Du kan skicka flera meddelanden samtidigt med hjälp av en ICollector - eller IAsyncCollector -parameter. Här är C#-skriptkod som skickar flera meddelanden, ett med HTTP-begärandedata och ett med hårdkodade värden:

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

I följande exempel visas en Java-funktion som skapar ett kömeddelande för när det utlöses av en HTTP-begäran.

@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;
 }

I Java Functions-körningsbiblioteketanvänder du @QueueOutput -anteckningen för parametrar vars värde skulle skrivas till Queue Storage. Parametertypen ska vara OutputBinding<T> , där är en ursprunglig T Java-typ av en POJO.

I följande exempel visas en HTTP-utlösarbindning i en function.json-fil och en JavaScript-funktion som använder bindningen. Funktionen skapar ett köobjekt för varje HTTP-begäran som tas emot.

Här är filen 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"
    }
  ]
}

Konfigurationsavsnittet förklarar dessa egenskaper.

Här är JavaScript-koden:

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

Du kan skicka flera meddelanden samtidigt genom att definiera en meddelandematris för myQueueItem utdatabindningen. Följande JavaScript-kod skickar två kömeddelanden med hårdkodade värden för varje HTTP-begäran som tas emot.

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

Följande kodexempel visar hur du matar ut ett kömeddelande från en HTTP-utlöst funktion. Konfigurationsavsnittet med av type queue definierar utdatabindningen.

{
  "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"
    }
  ]
}

Med den här bindningskonfigurationen kan en PowerShell-funktion skapa ett kömeddelande med hjälp av Push-OutputBinding . I det här exemplet skapas ett meddelande från en frågesträng eller en brödtextparameter.

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"
})

Om du vill skicka flera meddelanden samtidigt definierar du en meddelandematris och använder för Push-OutputBinding att skicka meddelanden till köutdatabindningen.

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"
})

Följande exempel visar hur du matar ut enkla och flera värden till lagringsköer. Konfigurationen som behövs för function.json är densamma oavsett hur du gör.

En Storage-köbindning definieras i function.json där typen är inställd på 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"
    }
  ]
}

Om du vill ange ett enskilt meddelande i kön skickar du ett enda värde till set metoden .

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'

Om du vill skapa flera meddelanden i kön deklarerar du en parameter som lämplig listtyp och skickar en matris med värden (som matchar listtypen) till set metoden .

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'

I C#-klassbibliotekanvänder du QueueAttribute.

Attributet gäller för en out parameter eller returvärdet för funktionen. Attributets konstruktor tar namnet på kön, som du ser i följande exempel:

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

Du kan ange egenskapen Connection för att ange vilket lagringskonto som ska användas, som du ser i följande exempel:

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

Ett fullständigt exempel finns i Utdataexempel.

Du kan använda StorageAccount attributet för att ange lagringskontot på klass-, metod- eller parameternivå. Mer information finns i Utlösare – attribut.

Attribut stöds inte av C#-skript.

Med QueueOutput anteckningen kan du skriva ett meddelande som utdata för en funktion. I följande exempel visas en HTTP-utlöst funktion som skapar ett kömeddelande.

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();
    }
}

Parametern som är associerad QueueOutput med anteckningen har skrivits som en <T> OutputBinding-instans.

Attribut stöds inte av JavaScript.

Attribut stöds inte av PowerShell.

Attribut stöds inte av Python.

Standardvärde

Skriv ett enskilt kömeddelande med hjälp av en metodparameter, till exempel out T paramName . Du kan använda metoden return type i stället för out en parameter och kan vara någon av följande T typer:

• Ett objekt serialiserbart som JSON
• string
• byte[]
• CloudQueueMessage

Om du försöker binda till och få ett felmeddelande kontrollerar du att du har en referens till rätt CloudQueueMessage Storage SDK-version.

I C# och C#-skript skriver du flera kömeddelanden med någon av följande typer:

• ICollector<T> eller IAsyncCollector<T>
• CloudQueue

Ytterligare typer

Appar som använder version 5.0.0 eller senare av Storage-tillägget kan också använda typer från Azure SDK för .NET. Den här versionen minskar stödet för CloudQueue äldre och typer till förmån för följande CloudQueueMessage typer:

• QueueMessage
• QueueClient för att skriva flera kömeddelanden

Exempel som använder dessa typer finns i GitHub lagringsplatsen för tillägget.

Standardvärde

Skriv ett enda kömeddelande med hjälp av en metodparameter, till exempel out T paramName . paramNameär det värde som anges i egenskapen för name function.json. Du kan använda metodens returtyp i stället för out en parameter och kan vara någon av följande T typer:

• Ett objekt serialiserbart som JSON
• string
• byte[]
• CloudQueueMessage

Om du försöker binda till och få ett felmeddelande kontrollerar du att du har en referens till rätt CloudQueueMessage Storage SDK-version.

I C# och C#-skript skriver du flera kömeddelanden med någon av följande typer:

• ICollector<T> eller IAsyncCollector<T>
• CloudQueue

Ytterligare typer

Appar som använder version 5.0.0 eller senare av Storage-tillägget kan också använda typer från Azure SDK för .NET. Den här versionen minskar stödet för CloudQueue äldre och typer till förmån för följande CloudQueueMessage typer:

• QueueMessage
• QueueClient för att skriva flera kömeddelanden

Exempel som använder dessa typer finns i GitHub lagringsplatsen för tillägget.

Det finns två alternativ för att mata ut ett kömeddelande från en funktion med hjälp av QueueOutput-anteckningen:

• Returvärde: Genom att tillämpa kommentaren på själva funktionen bevaras funktionens returvärde som ett kömeddelande.

• Imperativt: Om du uttryckligen vill ange meddelandevärdet tillämpar du kommentaren på en specifik parameter av typen , där är en POJO eller OutputBinding<T> en ursprunglig T Java-typ. Med den här konfigurationen beständigas värdet som ett kömeddelande genom att skicka ett setValue värde till metoden .

Utdataköobjektet är tillgängligt via context.bindings.<NAME> där matchar namnet som <NAME> definierats i function.json. Du kan använda en sträng eller ett JSON-serialiserbart objekt för nyttolasten för köobjekt.

Utdata till kömeddelandet är tillgängligt via där du skickar argument som matchar namnet som anges av bindningens parameter i Push-OutputBinding name function.json-filen.

Det finns två alternativ för att mata ut ett kömeddelande från en funktion:

• Returvärde: Ange name egenskapen i function.json till $return . Med den här konfigurationen bevaras funktionens returvärde som ett Queue Storage-meddelande.

• Imperativt: Skicka ett värde till set-metoden för parametern som deklareras som en Out-typ. Värdet som skickas till set bevaras som ett Queue Storage-meddelande.