Gatilho de armazenamento de fila do Azure para o Azure Functions

O modelo de programação Python v2 permite definir ligações usando decoradores diretamente em seu código de função Python. Para obter mais informações, consulte o guia do desenvolvedor do Python.

O modelo de programação Python v1 requer que você defina ligações em um arquivo function.json separado na pasta de funções. Para obter mais informações, consulte o guia do desenvolvedor do Python.

O exemplo a seguir mostra uma função C# que sonda a fila input-queue e grava várias mensagens em uma fila de saída cada vez que um item de fila é processado.

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

O exemplo a seguir mostra uma função C# que sonda a fila myqueue-items e grava um log cada vez que um item de fila é processado.

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

O exemplo a seguir mostra uma função TypeScript de gatilho de fila. A função sonda a fila myqueue-items e grava um log cada vez que um item de fila é processado.

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

A seção de uso explica queueItem. A seção de metadados da mensagem explica todas as outras variáveis mostradas.

Os exemplos do TypeScript não estão documentados para o modelo v3.

O exemplo a seguir mostra uma função JavaScript de gatilho de fila. A função sonda a fila myqueue-items e grava um log cada vez que um item de fila é processado.

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

A seção de uso explica queueItem. A seção de metadados da mensagem explica todas as outras variáveis mostradas.

O exemplo a seguir mostra uma ligação de gatilho de fila em um arquivo function.json e uma função JavaScript que usa a ligação. A função sonda a fila myqueue-items e grava um log cada vez que um item de fila é processado.

Aqui está o arquivo function.json :

{
    "disabled": false,
    "bindings": [
        {
            "type": "queueTrigger",
            "direction": "in",
            "name": "myQueueItem",
            "queueName": "myqueue-items",
            "connection":"MyStorageConnectionAppSetting"
        }
    ]
}

A seção de configuração explica essas propriedades.

Aqui está o código 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);
};

A seção de uso explica myQueueItem, que é nomeado pela name propriedade em function.json. A seção de metadados da mensagem explica todas as outras variáveis mostradas.

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')

Um gatilho de fila de armazenamento é definido em function.json onde type é definido como queueTrigger.

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

O código _init_.py declara um parâmetro como func.QueueMessage, que permite que você leia a mensagem de fila em sua função.

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)

Em bibliotecas de classe C#, o construtor do atributo usa o nome da fila para monitorar, conforme mostrado no exemplo a seguir:

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

Este exemplo também demonstra a configuração da cadeia de conexão no próprio atributo.

Em bibliotecas de classe C#, o construtor do atributo usa o nome da fila para monitorar, conforme mostrado no exemplo a seguir:

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

Você pode definir a Connection propriedade para especificar a configuração do aplicativo que contém a cadeia de conexão da conta de armazenamento a ser usada, conforme mostrado no exemplo a seguir:

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

A tabela a seguir explica as propriedades que você pode definir no options objeto passado para o app.storageQueue() método.

A tabela a seguir explica as propriedades de configuração de associação definidas no arquivo function.json .

Uma biblioteca de classes de processo de trabalho isolada compilada função C# é executada em um processo isolado do tempo de execução.

Uma biblioteca de classes em processo é uma função C# compilada executada no mesmo processo que o tempo de execução do Functions.

Acesse os dados da mensagem usando um parâmetro de método, como string paramName. O paramName é o valor especificado no QueueTriggerAttribute. Você pode vincular a qualquer um dos seguintes tipos:

• Objeto CLR .NET (POCO) simples
• string
• byte[]
• QueueMessage

Ao vincular a um objeto, o tempo de execução do Functions tenta desserializar a carga JSON em uma instância de uma classe arbitrária definida em seu código. Para obter exemplos usando QueueMessage, consulte o repositório GitHub para a extensão.

Embora o atributo tenha uma Connection propriedade, você também pode usar StorageAccountAttribute para especificar uma conexão de conta de armazenamento. Você pode fazer isso quando precisar usar uma conta de armazenamento diferente de outras funções na biblioteca. O construtor leva o nome de uma configuração de aplicativo que contém uma cadeia de conexão de armazenamento. O atributo pode ser aplicado no nível de parâmetro, método ou classe. O exemplo a seguir mostra o nível da classe e o nível do método:

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

A conta de armazenamento a ser usada é determinada na seguinte ordem:

• A propriedade do atributo trigger ou de ligação Connection .
• O StorageAccount atributo aplicado ao mesmo parâmetro que o atributo trigger ou de ligação.
• O StorageAccount atributo aplicado à função.
• O StorageAccount atributo aplicado à classe.
• A conta de armazenamento padrão para o aplicativo de função, que é definida na configuração do AzureWebJobsStorage aplicativo.

Acesse os dados da mensagem usando um parâmetro de método, como string paramName. O paramName é o valor especificado no QueueTriggerAttribute. Você pode vincular a qualquer um dos seguintes tipos:

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

Ao vincular a um objeto, o tempo de execução do Functions tenta desserializar a carga JSON em uma instância de uma classe arbitrária definida em seu código. Se você tentar vincular ao CloudQueueMessage e receber uma mensagem de erro, certifique-se de ter uma referência à versão correta do SDK de armazenamento.

Embora o atributo tenha uma Connection propriedade, você também pode usar StorageAccountAttribute para especificar uma conexão de conta de armazenamento. Você pode fazer isso quando precisar usar uma conta de armazenamento diferente de outras funções na biblioteca. O construtor leva o nome de uma configuração de aplicativo que contém uma cadeia de conexão de armazenamento. O atributo pode ser aplicado no nível de parâmetro, método ou classe. O exemplo a seguir mostra o nível da classe e o nível do método:

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

A conta de armazenamento a ser usada é determinada na seguinte ordem:

• A propriedade do atributo trigger ou de ligação Connection .
• O StorageAccount atributo aplicado ao mesmo parâmetro que o atributo trigger ou de ligação.
• O StorageAccount atributo aplicado à função.
• O StorageAccount atributo aplicado à classe.
• A conta de armazenamento padrão para o aplicativo de função, que é definida na configuração do AzureWebJobsStorage aplicativo.

O gatilho de fila pode se vincular aos seguintes tipos:

1 Para usar esses tipos, você precisa fazer referência a Microsoft.Azure.Functions.Worker.Extensions.Storage.Queues 5.2.0 ou posterior e às dependências comuns para associações de tipo SDK.

As versões anteriores dessa extensão no processo de trabalho isolado suportam apenas a vinculação a cadeias de caracteres. Mais opções estão disponíveis para a extensão 5.x+.

Acesse o item de fila como o primeiro argumento para sua função. Se a carga for JSON, o valor será desserializado em um objeto.

Acesse o item de fila usando context.bindings.<NAME> onde <NAME> corresponde ao valor definido em function.json. Se a carga for JSON, o valor será desserializado em um objeto.