Utdatabindningar för Azure Queue Storage för Azure Functions

Med programmeringsmodellen Python v2 kan du definiera bindningar med hjälp av dekoratörer direkt i python-funktionskoden. Mer information finns i utvecklarguiden för Python.

Programmeringsmodellen Python v1 kräver att du definierar bindningar i en separat function.json fil i funktionsmappen. Mer information finns i utvecklarguiden för Python.

[Function(nameof(QueueFunction))]
[QueueOutput("output-queue")]
public string[] Run([QueueTrigger("input-queue")] Album myQueueItem, FunctionContext context)
{
    // Use a string array to return more than one message.
    string[] messages = {
        $"Album name = {myQueueItem.Name}",
        $"Album songs = {myQueueItem.Songs.ToString()}"};

    _logger.LogInformation("{msg1},{msg2}", messages[0], messages[1]);

    // Queue Output messages
    return messages;
}

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öst TypeScript-funktion som skapar ett köobjekt för varje HTTP-begäran som tas emot.

import { app, HttpRequest, HttpResponseInit, InvocationContext, output } from '@azure/functions';

const queueOutput = output.storageQueue({
    queueName: 'outqueue',
    connection: 'MyStorageConnectionAppSetting',
});

export async function httpTrigger1(request: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
    const body = await request.text();
    context.extraOutputs.set(queueOutput, body);
    return { body: 'Created queue item.' };
}

app.http('httpTrigger1', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraOutputs: [queueOutput],
    handler: httpTrigger1,
});

Om du vill mata ut flera meddelanden returnerar du en matris i stället för ett enda objekt. Till exempel:

context.extraOutputs.set(queueOutput, ['message 1', 'message 2']);

TypeScript-exempel dokumenteras inte för modell v3.

I följande exempel visas en HTTP-utlöst JavaScript-funktion som skapar ett köobjekt för varje HTTP-begäran som tas emot.

const { app, output } = require('@azure/functions');

const queueOutput = output.storageQueue({
    queueName: 'outqueue',
    connection: 'MyStorageConnectionAppSetting',
});

app.http('httpTrigger1', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraOutputs: [queueOutput],
    handler: async (request, context) => {
        const body = await request.text();
        context.extraOutputs.set(queueOutput, body);
        return { body: 'Created queue item.' };
    },
});

Om du vill mata ut flera meddelanden returnerar du en matris i stället för ett enda objekt. Till exempel:

context.extraOutputs.set(queueOutput, ['message 1', 'message 2']);

Ett exempel från slutpunkt till slutpunkt på hur du konfigurerar en utdatabindning till Queue Storage finns i någon av följande artiklar:

• Ansluta funktioner till Azure Storage med Visual Studio Code
• Ansluta funktioner till Azure Storage med kommandoradsverktyg

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 den function.json filen:

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

I konfigurationsavsnittet förklaras dessa egenskaper.

Här är JavaScript-koden:

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

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

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

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="QueueOutput1")
@app.route(route="message")
@app.queue_output(arg_name="msg", 
                  queue_name="<QUEUE_NAME>", 
                  connection="<CONNECTION_SETTING>")
def main(req: func.HttpRequest, msg: func.Out[str]) -> func.HttpResponse:
    input_msg = req.params.get('name')
    logging.info(input_msg)

    msg.set(input_msg)

    logging.info(f'name: {name}')
    return 'OK'

Ett exempel från slutpunkt till slutpunkt på hur du konfigurerar en utdatabindning till Queue Storage finns i någon av följande artiklar:

• Ansluta funktioner till Azure Storage med Visual Studio Code
• Ansluta funktioner till Azure Storage med kommandoradsverktyg

En lagringskö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'

När du kör i en isolerad arbetsprocess använder du QueueOutputAttribute, som tar namnet på kön, enligt följande exempel:

[Function(nameof(QueueFunction))]
[QueueOutput("output-queue")]
public string[] Run([QueueTrigger("input-queue")] Album myQueueItem, FunctionContext context)

Endast returnerade variabler stöds när de körs i en isolerad arbetsprocess. Det går inte att använda utdataparametrar.

I C#-klassbibliotek använder du QueueAttribute. C#-skriptet använder i stället en function.json konfigurationsfil enligt beskrivningen i C#-skriptguiden.

Attributet gäller för en out parameter eller funktionens returvärde. Attributets konstruktor tar namnet på kön, enligt följande exempel:

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

Du kan ange att Connection egenskapen ska ange vilket lagringskonto som ska användas, enligt följande exempel:

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

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

I följande tabell förklaras de egenskaper som du kan ange för objektet options som skickas output.storageQueue() till metoden.

I följande tabell förklaras de bindningskonfigurationsegenskaper som du anger i filen function.json .

Ett isolerat arbetsprocessklassbibliotek kompilerade C#-funktioner körs i en process som är isolerad från körningen.

Ett kursbibliotek i processen är en kompilerad C#-funktion som körs i samma process som Functions-körningen.

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

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

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

Du kan skriva flera meddelanden till kön med någon av följande typer:

• ICollector<T> eller IAsyncCollector<T>
• QueueClient

Exempel som använder QueueMessage och QueueClient finns i GitHub-lagringsplatsen för tillägget.

Även om attributet tar en Connection egenskap kan du också använda StorageAccountAttribute för att ange en anslutning till lagringskontot. Du kan göra detta när du behöver använda ett annat lagringskonto än andra funktioner i biblioteket. Konstruktorn tar namnet på en appinställning som innehåller en lagrings-niska veze. Attributet kan användas på parameter-, metod- eller klassnivå. I följande exempel visas klassnivå och metodnivå:

[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
    [FunctionName("StorageTrigger")]
    [StorageAccount("FunctionLevelStorageAppSetting")]
    public static void Run( //...
{
    ...
}

Lagringskontot som ska användas bestäms i följande ordning:

• Egenskapen för utlösaren eller bindningsattributet Connection .
• Attributet StorageAccount som tillämpas på samma parameter som utlösaren eller bindningsattributet.
• Attributet StorageAccount som tillämpas på funktionen.
• Attributet StorageAccount som tillämpas på klassen.
• Standardlagringskontot för funktionsappen, som definieras i programinställningen AzureWebJobsStorage .

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

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

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

Du kan skriva flera meddelanden till kön med någon av följande typer:

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

Även om attributet tar en Connection egenskap kan du också använda StorageAccountAttribute för att ange en anslutning till lagringskontot. Du kan göra detta när du behöver använda ett annat lagringskonto än andra funktioner i biblioteket. Konstruktorn tar namnet på en appinställning som innehåller en lagrings-niska veze. Attributet kan användas på parameter-, metod- eller klassnivå. I följande exempel visas klassnivå och metodnivå:

[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
    [FunctionName("StorageTrigger")]
    [StorageAccount("FunctionLevelStorageAppSetting")]
    public static void Run( //...
{
    ...
}

Lagringskontot som ska användas bestäms i följande ordning:

• Egenskapen för utlösaren eller bindningsattributet Connection .
• Attributet StorageAccount som tillämpas på samma parameter som utlösaren eller bindningsattributet.
• Attributet StorageAccount som tillämpas på funktionen.
• Attributet StorageAccount som tillämpas på klassen.
• Standardlagringskontot för funktionsappen, som definieras i programinställningen AzureWebJobsStorage .

När du vill att funktionen ska skriva ett enda meddelande kan köutdatabindningen binda till följande typer:

När du vill att funktionen ska skriva flera meddelanden kan köutdatabindningen binda till följande typer:

För andra utdatascenarier skapar och använder du typer från Azure.Storage.Queues direkt.

Isolerad arbetsprocess stöder för närvarande endast bindning till strängparametrar.

Få åtkomst till utdataköobjektet genom att returnera värdet direkt eller med hjälp av context.extraOutputs.set(). Du kan använda en sträng eller ett JSON-serialiserbart objekt för köobjektets nyttolast.

Få åtkomst till utdataköobjektet med hjälp context.bindings.<name> av var <name> är värdet som anges i name egenskapen för function.json. Du kan använda en sträng eller ett JSON-serialiserbart objekt för köobjektets nyttolast.