Associações de saída 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.

[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 cria uma mensagem de fila para cada solicitação HTTP recebida.

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

O exemplo a seguir mostra uma função TypeScript acionada por HTTP que cria um item de fila para cada solicitação HTTP recebida.

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 gerar várias mensagens, retorne uma matriz em vez de um único objeto. Por exemplo:

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

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

O exemplo a seguir mostra uma função JavaScript acionada por HTTP que cria um item de fila para cada solicitação HTTP recebida.

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 gerar várias mensagens, retorne uma matriz em vez de um único objeto. Por exemplo:

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

Para obter um exemplo completo de como configurar uma ligação de saída para o armazenamento em fila, consulte um destes artigos:

• Conectar funções ao Armazenamento do Azure usando o Visual Studio Code
• Conectar funções ao Armazenamento do Azure usando ferramentas de linha de comando

O exemplo a seguir mostra uma ligação de gatilho HTTP em um arquivo function.json e uma função JavaScript que usa a ligação. A função cria um item de fila para cada solicitação HTTP recebida.

Aqui está o arquivo 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"
    }
  ]
}

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

Aqui está o código JavaScript:

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

Você pode enviar várias mensagens de uma só vez definindo uma matriz de mensagens para a associação de myQueueItem saída. O código JavaScript a seguir envia duas mensagens de fila com valores codificados para cada solicitação HTTP recebida.

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 obter um exemplo completo de como configurar uma ligação de saída para o armazenamento em fila, consulte um destes artigos:

• Conectar funções ao Armazenamento do Azure usando o Visual Studio Code
• Conectar funções ao Armazenamento do Azure usando ferramentas de linha de comando

Uma associação de fila de armazenamento é definida em function.json onde type é definido como 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 definir uma mensagem individual na fila, passe um único valor para o set método.

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 criar várias mensagens na fila, declare um parâmetro como o tipo de lista apropriado e passe uma matriz de valores (que correspondem ao tipo de lista) para o set método.

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'

Ao executar em um processo de trabalho isolado, você usa o QueueOutputAttribute, que leva o nome da fila, conforme mostrado no exemplo a seguir:

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

Somente variáveis retornadas são suportadas quando executadas em um processo de trabalho isolado. Os parâmetros de saída não podem ser usados.

Em bibliotecas de classes C#, use o QueueAttribute. Em vez disso, o script C# usa um arquivo de configuração function.json, conforme descrito no guia de script C#.

O atributo se aplica a um out parâmetro ou ao valor de retorno da função. O construtor do atributo usa o nome da fila, conforme mostrado no exemplo a seguir:

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

Você pode definir a Connection propriedade para especificar a conta de armazenamento a ser usada, conforme mostrado no exemplo a seguir:

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

Você pode usar o StorageAccount atributo para especificar a conta de armazenamento no nível de classe, método ou parâmetro. Para obter mais informações, consulte Trigger - attributes.

A tabela a seguir explica as propriedades que você pode definir no options objeto passado para o output.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.

Escreva uma única mensagem de fila usando um parâmetro de método como out T paramName. Você pode usar o método return type em vez de um parâmetro e T pode ser qualquer um out dos seguintes tipos:

• Um objeto serializável como JSON
• string
• byte[]
• QueueMessage

Para obter exemplos usando esses tipos, consulte o repositório GitHub para a extensão.

Você pode gravar várias mensagens na fila usando um dos seguintes tipos:

• ICollector<T> ou IAsyncCollector<T>
• QueueClient

Para obter exemplos usando QueueMessage e QueueClient, 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.

Escreva uma única mensagem de fila usando um parâmetro de método como out T paramName. Você pode usar o método return type em vez de um parâmetro e T pode ser qualquer um out dos seguintes tipos:

• Um objeto serializável como JSON
• string
• byte[]
• CloudQueueMessage

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.

Você pode gravar várias mensagens na fila usando um dos seguintes tipos:

• ICollector<T> ou IAsyncCollector<T>
• CloudQueue

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.

Quando você deseja que a função escreva uma única mensagem, a ligação de saída da fila pode se vincular aos seguintes tipos:

Quando você deseja que a função escreva várias mensagens, a ligação de saída da fila pode ser vinculada aos seguintes tipos:

Para outros cenários de saída, crie e use um QueueClient com outros tipos de Azure.Storage.Queues diretamente. Consulte Registrar clientes do Azure para obter um exemplo de como usar a injeção de dependência para criar um tipo de cliente a partir do SDK do Azure.

Atualmente, o processo de trabalho isolado suporta apenas a vinculação a parâmetros de cadeia de caracteres.

Acesse o item da fila de saída retornando o valor diretamente ou usando context.extraOutputs.set()o . Você pode usar uma cadeia de caracteres ou um objeto serializável JSON para a carga útil do item de fila.

Acesse o item da fila de saída usando context.bindings.<name> onde é o name valor especificado na propriedade de function.json<name>. Você pode usar uma cadeia de caracteres ou um objeto serializável JSON para a carga útil do item de fila.