Desencadenador 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.

En el ejemplo siguiente se muestra una función de C# que sondea la cola input-queue y escribe varios mensajes a una cola de salida cada vez que se procesa un elemento de cola.

[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 sondea la cola myqueue-items y escribe un registro cada vez que se procesa un elemento de cola.

public static class QueueFunctions
{
    [FunctionName("QueueTrigger")]
    public static void QueueTrigger(
        [QueueTrigger("myqueue-items")] string myQueueItem, 
        ILogger log)
    {
        log.LogInformation($"C# function processed: {myQueueItem}");
    }
}

En el ejemplo siguiente se muestra una función de TypeScript de desencadenador de cola. La función sondea la cola myqueue-items y escribe un registro cada vez que se procesa un elemento de cola.

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

export async function storageQueueTrigger1(queueItem: unknown, context: InvocationContext): Promise<void> {
    context.log('Storage queue function processed work item:', queueItem);
    context.log('expirationTime =', context.triggerMetadata.expirationTime);
    context.log('insertionTime =', context.triggerMetadata.insertionTime);
    context.log('nextVisibleTime =', context.triggerMetadata.nextVisibleTime);
    context.log('id =', context.triggerMetadata.id);
    context.log('popReceipt =', context.triggerMetadata.popReceipt);
    context.log('dequeueCount =', context.triggerMetadata.dequeueCount);
}

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    handler: storageQueueTrigger1,
});

En la sección de uso se explica queueItem. En la sección de metadatos del mensaje se explican el resto de variables que se muestran.

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

En el ejemplo siguiente se muestra una función de JavaScript de desencadenador de cola. La función sondea la cola myqueue-items y escribe un registro cada vez que se procesa un elemento de cola.

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

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    handler: (queueItem, context) => {
        context.log('Storage queue function processed work item:', queueItem);
        context.log('expirationTime =', context.triggerMetadata.expirationTime);
        context.log('insertionTime =', context.triggerMetadata.insertionTime);
        context.log('nextVisibleTime =', context.triggerMetadata.nextVisibleTime);
        context.log('id =', context.triggerMetadata.id);
        context.log('popReceipt =', context.triggerMetadata.popReceipt);
        context.log('dequeueCount =', context.triggerMetadata.dequeueCount);
    },
});

En la sección de uso se explica queueItem. En la sección de metadatos del mensaje se explican el resto de variables que se muestran.

En el ejemplo siguiente se muestra un enlace de desencadenador de cola de un archivo function.json y una función de JavaScript que usa el enlace. La función sondea la cola myqueue-items y escribe un registro cada vez que se procesa un elemento de cola.

Este es el archivo function.json:

{
    "disabled": false,
    "bindings": [
        {
            "type": "queueTrigger",
            "direction": "in",
            "name": "myQueueItem",
            "queueName": "myqueue-items",
            "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, message) {
    context.log('Node.js queue trigger function processed work item', message);
    // OR access using context.bindings.<name>
    // context.log('Node.js queue trigger function processed work item', context.bindings.myQueueItem);
    context.log('expirationTime =', context.bindingData.expirationTime);
    context.log('insertionTime =', context.bindingData.insertionTime);
    context.log('nextVisibleTime =', context.bindingData.nextVisibleTime);
    context.log('id =', context.bindingData.id);
    context.log('popReceipt =', context.bindingData.popReceipt);
    context.log('dequeueCount =', context.bindingData.dequeueCount);
};

En la sección acerca del uso se explica myQueueItem, que recibe el nombre de la propiedad name de function.json. En la sección de metadatos del mensaje se explican el resto de variables que se muestran.

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="QueueFunc")
@app.queue_trigger(arg_name="msg", queue_name="inputqueue",
                   connection="storageAccountConnectionString")  # Queue trigger
@app.queue_output(arg_name="outputQueueItem", queue_name="outqueue",
                 connection="storageAccountConnectionString")  # Queue output binding
def test_function(msg: func.QueueMessage,
                  outputQueueItem: func.Out[str]) -> None:
    logging.info('Python queue trigger function processed a queue item: %s',
                 msg.get_body().decode('utf-8'))
    outputQueueItem.set('hello')

Un desencadenador de cola de almacenamiento se define en function.json, donde type está establecido en queueTrigger.

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "msg",
      "type": "queueTrigger",
      "direction": "in",
      "queueName": "messages",
      "connection": "AzureStorageQueuesConnectionString"
    }
  ]
}

El código _init_.py declara un parámetro como func.QueueMessage, lo que permite leer el mensaje de la cola en la función.

import logging
import json

import azure.functions as func

def main(msg: func.QueueMessage):
    logging.info('Python queue trigger function processed a queue item.')

    result = json.dumps({
        'id': msg.id,
        'body': msg.get_body().decode('utf-8'),
        'expiration_time': (msg.expiration_time.isoformat()
                            if msg.expiration_time else None),
        'insertion_time': (msg.insertion_time.isoformat()
                           if msg.insertion_time else None),
        'time_next_visible': (msg.time_next_visible.isoformat()
                              if msg.time_next_visible else None),
        'pop_receipt': msg.pop_receipt,
        'dequeue_count': msg.dequeue_count
    })

    logging.info(result)

En las bibliotecas de clase C#, el constructor del atributo toma el nombre de la cola que debe supervisar, tal como se muestra en el ejemplo siguiente:

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

En este ejemplo también se muestra cómo establecer la configuración de la cadena de conexión en el propio atributo.

En las bibliotecas de clase C#, el constructor del atributo toma el nombre de la cola que debe supervisar, tal como se muestra en el ejemplo siguiente:

[FunctionName("QueueTrigger")]
public static void Run(
    [QueueTrigger("myqueue-items")] string myQueueItem, 
    ILogger log)
{
    ...
}

Puede establecer la propiedad Connection para especificar la configuración de aplicación que contiene la cadena de conexión de la cuenta de almacenamiento, tal como se muestra en el ejemplo siguiente:

[FunctionName("QueueTrigger")]
public static void Run(
    [QueueTrigger("myqueue-items", Connection = "StorageConnectionAppSetting")] string myQueueItem, 
    ILogger log)
{
    ....
}

En la tabla siguiente se explican las propiedades que puede establecer en el objeto options que se pasa al métodoapp.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.

Acceda a los datos de mensaje mediante un parámetro de método, como string paramName. paramName es el valor especificado en QueueTriggerAttribute. Puede enlazar a cualquiera de los siguientes tipos:

• Objeto CLR de .NET sin formato (POCO)
• string
• byte[]
• QueueMessage

Al enlazar a un objeto, el tiempo de ejecución de Functions intenta deserializar una carga JSON en una instancia de una clase arbitraria definida en el código. Para obtener ejemplos de uso de QueueMessage, 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.

Acceda a los datos de mensaje mediante un parámetro de método, como string paramName. paramName es el valor especificado en QueueTriggerAttribute. Puede enlazar a cualquiera de los siguientes tipos:

• Objeto CLR convencional (POCO)
• string
• byte[]
• CloudQueueMessage

Al enlazar a un objeto, el tiempo de ejecución de Functions intenta deserializar una carga JSON en una instancia de una clase arbitraria definida en el código. 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.

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.

El desencadenador de cola puede enlazarse a los siguientes tipos:

¹ Para utilizar estos tipos, debe hacer referencia a Microsoft.Azure.Functions.Worker.Extensions.Storage.Queues 5.2.0 o posterior y a las dependencias comunes para los enlaces de tipo SDK.

Las versiones anteriores de extensiones del proceso de trabajo aislado solo admiten el enlace a cadenas. Hay más opciones disponibles para la extensión 5.x+.

Acceda al elemento de cola como primer argumento de la función. Si la carga es JSON, el valor se deserializa en un objeto.

Acceda al elemento de cola mediante context.bindings.<NAME>, donde <NAME> coincide con el valor definido en function.json. Si la carga es JSON, el valor se deserializa en un objeto.