Enlaces de salida de Azure Queue Storage para Azure Functions

El modelo de programación de Python v2 permite definir enlaces mediante decoradores directamente en el código de función de Python. Para más información, consulte la Guía para desarrolladores de Python.

El modelo de programación de Python v1 requiere que defina enlaces en un archivo function.json independiente en la carpeta de funciones. Para más información, consulte la Guía para desarrolladores de 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;
}

En el ejemplo siguiente se muestra una función de C# que crea un mensaje de cola para cada una de las solicitudes HTTP que se reciben.

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

En el ejemplo siguiente se muestra una función de TypeScript desencadenada por HTTP que crea un elemento de cola para cada una de las solicitudes HTTP que se reciben.

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

Para generar varios mensajes, devuelva una matriz en lugar de un solo objeto. Por ejemplo:

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

Los ejemplos de TypeScript no están documentados para el modelo v3.

En el ejemplo siguiente se muestra una función de JavaScript desencadenada por HTTP que crea un elemento de cola para cada una de las solicitudes HTTP que se reciben.

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

Para generar varios mensajes, devuelva una matriz en lugar de un solo objeto. Por ejemplo:

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

Para ver un ejemplo completo de cómo configurar un enlace de salida en Queue Storage, consulte uno de estos artículos:

• Conexión de funciones a Azure Storage mediante Visual Studio Code
• Conexión de funciones a Azure Storage mediante herramientas de línea de comandos

En el ejemplo siguiente se muestra un enlace de desencadenador HTTP de un archivo function.json y una función de JavaScript que usa el enlace. La función crea un elemento de cola para cada una de las solicitudes HTTP recibidas.

Este es el archivo 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"
    }
  ]
}

En la sección de configuración se explican estas propiedades.

Este es el código de JavaScript:

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

Puede enviar varios mensajes a la vez mediante la definición de una matriz de mensajes para el enlace de salida myQueueItem. El código JavaScript envía dos mensajes de cola con valores codificados de forma rígida para cada una de las solicitudes HTTP recibidas.

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'

Para ver un ejemplo completo de cómo configurar un enlace de salida en Queue Storage, consulte uno de estos artículos:

• Conexión de funciones a Azure Storage mediante Visual Studio Code
• Conexión de funciones a Azure Storage mediante herramientas de línea de comandos

Un enlace de cola de almacenamiento se define en function.json, donde type está establecido en 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"
    }
  ]
}

Para establecer un mensaje individual en la cola, se pasa un valor único al método set.

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'

Para crear varios mensajes en la cola, declare un parámetro como el tipo de lista adecuado y pase una matriz de valores (que coincidan con el tipo de lista) al método set.

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'

Cuando se ejecuta en un proceso aislado, se usa QueueOutputAttribute, que toma el nombre de la cola, como se muestra en el ejemplo siguiente:

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

Solo se admiten las variables devueltas cuando se ejecutan en un proceso de trabajo aislado. No se pueden usar parámetros de salida.

En las bibliotecas de clase C#, use QueueAttribute. En su lugar, el script de C# usa un archivo de configuración function.json como se describe en la Guía de scripting de C#.

El atributo se aplica a un parámetro out o al valor de retorno de la función. El constructor del atributo toma el nombre de la cola, tal como se muestra en el ejemplo siguiente:

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

Puede establecer la propiedad Connection para especificar la cuenta de almacenamiento que se usará, tal como se muestra en el ejemplo siguiente:

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

Puede usar el atributo StorageAccount para especificar la cuenta de almacenamiento en el nivel de clase, método o parámetro. Para obtener más información, consulte Desencadenador: atributos.

En la tabla siguiente se explican las propiedades que puede establecer en el objeto options que se pasa al métodooutput.storageQueue().

En la siguiente tabla se explican las propiedades de configuración de enlace que se establecen en el archivo function.json.

Una función de C# compilada de la biblioteca de clases de procesos de trabajo aislados se ejecuta en un proceso aislado del entorno de ejecución.

Un biblioteca de clases en proceso es una función de C# compilada que se ejecuta en el mismo proceso que Functions Runtime.

Escriba un mensaje de cola único mediante un parámetro de método como out T paramName. Puede usar el tipo de valor devuelto del método en lugar de un parámetro out, y T puede ser cualquiera de los siguientes tipos:

• Un objeto serializable como JSON
• string
• byte[]
• QueueMessage

Para obtener ejemplos de uso de estos tipos, consulte el repositorio de GitHub de la extensión.

Puede escribir varios mensajes en la cola mediante uno de los siguientes tipos:

• ICollector<T> o IAsyncCollector<T>
• QueueClient

Para obtener ejemplos de uso de QueueMessage y QueueClient, consulte el repositorio de GitHub de la extensión.

Aunque el atributo toma una propiedad Connection, también puede usar el atributo Connection para especificar una conexión de cuenta de almacenamiento. Puede hacerlo cuando necesite usar una cuenta de almacenamiento diferente a otras funciones de la biblioteca. El constructor toma el nombre de una configuración de aplicación que contiene una cadena de conexión de almacenamiento. El atributo se puede aplicar en el nivel de clase, método o parámetro. En el ejemplo siguiente se muestran el nivel de clase y de método:

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

La cuenta de almacenamiento que se debe usar se determina en el orden siguiente:

• La propiedad Connection del atributo de enlace o desencadenador.
• El atributo StorageAccount aplicado al mismo parámetro que el atributo de enlace o desencadenador.
• El atributo StorageAccount aplicado a la función.
• El atributo StorageAccount aplicado a la clase.
• La cuenta de almacenamiento predeterminada de la aplicación de funciones, que se define en la configuración de la aplicación AzureWebJobsStorage.

Escriba un mensaje de cola único mediante un parámetro de método como out T paramName. Puede usar el tipo de valor devuelto del método en lugar de un parámetro out, y T puede ser cualquiera de los siguientes tipos:

• Un objeto serializable como JSON
• string
• byte[]
• CloudQueueMessage

Si intenta enlazar a CloudQueueMessage y obtiene un mensaje de error, asegúrese de que tiene una referencia a la versión correcta del SDK de Storage.

Puede escribir varios mensajes en la cola mediante uno de los siguientes tipos:

• ICollector<T> o IAsyncCollector<T>
• CloudQueue

Aunque el atributo toma una propiedad Connection, también puede usar el atributo Connection para especificar una conexión de cuenta de almacenamiento. Puede hacerlo cuando necesite usar una cuenta de almacenamiento diferente a otras funciones de la biblioteca. El constructor toma el nombre de una configuración de aplicación que contiene una cadena de conexión de almacenamiento. El atributo se puede aplicar en el nivel de clase, método o parámetro. En el ejemplo siguiente se muestran el nivel de clase y de método:

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

La cuenta de almacenamiento que se debe usar se determina en el orden siguiente:

• La propiedad Connection del atributo de enlace o desencadenador.
• El atributo StorageAccount aplicado al mismo parámetro que el atributo de enlace o desencadenador.
• El atributo StorageAccount aplicado a la función.
• El atributo StorageAccount aplicado a la clase.
• La cuenta de almacenamiento predeterminada de la aplicación de funciones, que se define en la configuración de la aplicación AzureWebJobsStorage.

Cuando quiera que la función escriba un único mensaje, el enlace de salida de la cola puede enlazarse a los siguientes tipos:

Cuando quiera que la función escriba varios mensajes, el enlace de salida de la cola puede enlazarse a los siguientes tipos:

Para otros escenarios de salida, cree y use queueClient con otros tipos de Azure.Storage.Queues directamente. Consulte Registro de clientes de Azure para obtener un ejemplo de uso de la inserción de dependencias para crear un tipo de cliente a partir del SDK de Azure.

Actualmente, el proceso de trabajo aislado solo admite el enlace a parámetros de cadena.

Para acceder al elemento de cola de salida, devuelva el valor directamente o mediante context.extraOutputs.set(). Puede usar una cadena o un objeto JSON serializable para la carga del elemento de cola.

Acceda al elemento de cola de salida mediante context.bindings.<name>, donde <name> es el valor especificado en la propiedad name de function.json. Puede usar una cadena o un objeto JSON serializable para la carga del elemento de cola.