Associazioni di output di Archiviazione code di Azure per Funzioni di Azure

Il modello di programmazione Python v2 consente di definire associazioni usando elementi Decorator direttamente nel codice della funzione Python. Per altre informazioni, vedere la Guida per sviluppatori Python.

Il modello di programmazione Python v1 richiede di definire associazioni in un file di function.json separato nella cartella della funzione. Per altre informazioni, vedere la Guida per sviluppatori Python.

[Function(nameof(QueueInputOutputFunction))]
[QueueOutput("output-queue")]
public string[] QueueInputOutputFunction([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}"};

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

    // Queue Output messages
    return messages;
}

L'esempio seguente illustra una funzione C# che crea un messaggio nella coda per ogni richiesta HTTP ricevuta.

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

L'esempio seguente mostra una funzione TypeScript attivata da HTTP che crea un elemento della coda per ogni richiesta HTTP ricevuta.

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

Per restituire più messaggi, restituire una matrice anziché un singolo oggetto. Ad esempio:

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

Gli esempi typeScript non sono documentati per il modello v3.

L'esempio seguente mostra una funzione JavaScript attivata da HTTP che crea un elemento della coda per ogni richiesta HTTP ricevuta.

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.' };
    },
});

Per restituire più messaggi, restituire una matrice anziché un singolo oggetto. Ad esempio:

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

Per un esempio end-to-end di come configurare un'associazione di output all'archiviazione code, vedere uno di questi articoli:

• Connettere le funzioni a Archiviazione di Azure usando Visual Studio Code
• Connettere le funzioni a Archiviazione di Azure usando gli strumenti da riga di comando

L'esempio seguente illustra un'associazione di trigger HTTP in un file function.json e una funzione JavaScript che usa l'associazione. La funzione crea un elemento della coda per ogni richiesta HTTP ricevuta.

Ecco il file 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"
    }
  ]
}

Queste proprietà sono descritte nella sezione configuration.

Ecco il codice JavaScript:

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

È possibile inviare più messaggi contemporaneamente definendo un array di messaggio per l'associazione di output myQueueItem. Il codice JavaScript seguente invia due messaggi della coda con valori hardcoded per ogni richiesta HTTP ricevuta.

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'

Per un esempio end-to-end di come configurare un'associazione di output all'archiviazione code, vedere uno di questi articoli:

• Connettere le funzioni a Archiviazione di Azure usando Visual Studio Code
• Connettere le funzioni a Archiviazione di Azure usando gli strumenti da riga di comando

Un'associazione della coda di archiviazione viene definita in function.json dove il tipo è impostato su 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"
    }
  ]
}

Per impostare un singolo messaggio nella coda, passare un singolo valore al set metodo .

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'

Per creare più messaggi nella coda, dichiarare un parametro come tipo di elenco appropriato e passare una matrice di valori (che corrispondono al tipo di elenco) al set metodo .

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'

Quando si esegue in un processo di lavoro isolato, si usa QueueOutputAttribute, che accetta il nome della coda, come illustrato nell'esempio seguente:

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

Durante l'esecuzione in un processo di lavoro isolato sono supportate solo le variabili restituite. Non è possibile usare i parametri di output.

Nelle librerie di classi C# usare QueueAttribute. Lo script C# usa invece un file di configurazione function.json come descritto nella guida per gli script C#.

L'attributo si applica a un parametro out o al valore restituito della funzione. Il costruttore dell'attributo accetta il nome della coda, come illustrato nell'esempio seguente:

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

È possibile impostare la proprietà Connection per specificare l'account di archiviazione da usare, come illustrato nell'esempio seguente:

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

È possibile usare l'attributo StorageAccount per specificare l'account di archiviazione a livello di classe, metodo o parametro. Per altre informazioni, vedere Trigger - attributi.

Nella tabella seguente vengono illustrate le proprietà che è possibile impostare sull'oggetto options passato al output.storageQueue() metodo .

Nella tabella seguente sono illustrate le proprietà di configurazione dell'associazione impostate nel file function.json.

Una funzione C# compilata di libreria di classi di processo di lavoro viene eseguita in un processo isolato dal runtime.

Una libreria di classi in-process è una funzione C# compilata eseguita nello stesso processo del runtime di Funzioni.

Scrivere un singolo messaggio in coda usando un parametro del metodo, out T paramNamead esempio . È possibile usare il tipo restituito del metodo anziché un parametro out e T può essere uno dei seguenti tipi:

• Un oggetto serializzabile come JSON
• string
• byte[]
• QueueMessage

Per esempi relativi all'uso di questi tipi, vedere il repository GitHub per l'estensione.

È possibile scrivere più messaggi nella coda usando uno dei tipi seguenti:

• ICollector<T> oppure IAsyncCollector<T>
• QueueClient

Per esempi che usano QueueMessage e QueueClient, vedere il repository GitHub per l'estensione.

Mentre l'attributo accetta una Connection proprietà, è anche possibile usare StorageAccountAttribute per specificare una connessione all'account di archiviazione. Questa operazione può essere eseguita quando è necessario usare un account di archiviazione diverso da altre funzioni della libreria. Il costruttore accetta il nome di un'impostazione dell'app che contiene una stringa di connessione di archiviazione. L'attributo può essere applicato a livello di parametro, metodo o classe. L'esempio seguente illustra il livello classe e il livello metodo:

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

L'account di archiviazione da usare è determinato nell'ordine seguente:

• Proprietà dell'attributo trigger o binding Connection .
• Attributo StorageAccount applicato allo stesso parametro dell'attributo trigger o binding.
• L'attributo StorageAccount applicato alla funzione.
• L'attributo StorageAccount applicato alla classe.
• L'account di archiviazione predefinito per l'app per le funzioni, definito nell'impostazione dell'applicazione AzureWebJobsStorage .

Scrivere un singolo messaggio in coda usando un parametro del metodo, out T paramNamead esempio . È possibile usare il tipo restituito del metodo anziché un parametro out e T può essere uno dei seguenti tipi:

• Un oggetto serializzabile come JSON
• string
• byte[]
• CloudQueueMessage

Se si tenta di eseguire l'associazione a CloudQueueMessage e viene visualizzato un messaggio di errore, assicurarsi di avere un riferimento alla versione corretta di Storage SDK.

È possibile scrivere più messaggi nella coda usando uno dei tipi seguenti:

• ICollector<T> oppure IAsyncCollector<T>
• CloudQueue

Mentre l'attributo accetta una Connection proprietà, è anche possibile usare StorageAccountAttribute per specificare una connessione all'account di archiviazione. Questa operazione può essere eseguita quando è necessario usare un account di archiviazione diverso da altre funzioni della libreria. Il costruttore accetta il nome di un'impostazione dell'app che contiene una stringa di connessione di archiviazione. L'attributo può essere applicato a livello di parametro, metodo o classe. L'esempio seguente illustra il livello classe e il livello metodo:

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

L'account di archiviazione da usare è determinato nell'ordine seguente:

• Proprietà dell'attributo trigger o binding Connection .
• Attributo StorageAccount applicato allo stesso parametro dell'attributo trigger o binding.
• L'attributo StorageAccount applicato alla funzione.
• L'attributo StorageAccount applicato alla classe.
• L'account di archiviazione predefinito per l'app per le funzioni, definito nell'impostazione dell'applicazione AzureWebJobsStorage .

Quando si vuole che la funzione scriva un singolo messaggio, l'associazione di output della coda può essere associata ai tipi seguenti:

Quando si vuole che la funzione scriva più messaggi, l'associazione di output della coda può essere associata ai tipi seguenti:

Per altri scenari di output, creare e usare queueClient con altri tipi direttamente da Azure.Storage.Queues. Vedere Registrare i client di Azure per un esempio di uso dell'inserimento delle dipendenze per creare un tipo di client da Azure SDK.

Il processo di lavoro isolato supporta attualmente solo l'associazione ai parametri stringa.

Accedere all'elemento della coda di output restituendo il valore direttamente o usando context.extraOutputs.set(). È possibile usare una stringa o un oggetto serializzabile in JSON per il payload dell'elemento della coda.

Accedere all'elemento della coda di output usando context.bindings.<name> dove <name> è il valore specificato nella name proprietà di function.json. È possibile usare una stringa o un oggetto serializzabile in JSON per il payload dell'elemento della coda.