Enlaces de salida de Azure Queue Storage para Azure Functions

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 un enlace de desencadenador HTTP de un archivo function.json y el código de script de C# (.csx) que usa el enlace. La función crea un elemento de cola con una carga del objeto CustomQueueMessage 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": "$return",
      "queueName": "outqueue",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

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

Este es el código de script de C# que crea un único mensaje de cola:

public class CustomQueueMessage
{
    public string PersonName { get; set; }
    public string Title { get; set; }
}

public static CustomQueueMessage Run(CustomQueueMessage input, ILogger log)
{
    return input;
}

Puede enviar varios mensajes a la vez mediante el uso de un parámetro ICollector o IAsyncCollector. Este es el código de script de C# que envía varios mensajes, uno con los datos de la solicitud HTTP y otro con valores codificados de forma rígida:

public static void Run(
    CustomQueueMessage input, 
    ICollector<CustomQueueMessage> myQueueItems, 
    ILogger log)
{
    myQueueItems.Add(input);
    myQueueItems.Add(new CustomQueueMessage { PersonName = "You", Title = "None" });
}

En el ejemplo siguiente se muestra una función de Java que crea un mensaje de cola cuando una solicitud HTTP la desencadena.

@FunctionName("httpToQueue")
@QueueOutput(name = "item", queueName = "myqueue-items", connection = "MyStorageConnectionAppSetting")
 public String pushToQueue(
     @HttpTrigger(name = "request", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS)
     final String message,
     @HttpOutput(name = "response") final OutputBinding<String> result) {
       result.setValue(message + " has been added.");
       return message;
 }

En la biblioteca en tiempo de ejecución de funciones de Java, utilice la anotación @QueueOutput en los parámetros cuyo valor se escribiría en Queue Storage. El tipo de parámetro debe ser OutputBinding<T>, donde T es cualquier tipo nativo de Java de un POJO.

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 = function (context, input) {
    context.bindings.myQueueItem = input.body;
    context.done();
};

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 = function(context) {
    context.bindings.myQueueItem = ["message 1","message 2"];
    context.done();
};

En los siguientes ejemplos de código se muestra cómo generar un mensaje de la cola desde una función desencadenada por HTTP. La sección de configuración con el valor de type de queue define el enlace de salida.

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "Msg",
      "queueName": "outqueue",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

Con esta configuración de enlace, una función de PowerShell puede crear un mensaje de cola mediante Push-OutputBinding. En este ejemplo, se crea un mensaje a partir de una cadena de consulta o un parámetro de cuerpo.

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$message = $Request.Query.Message
Push-OutputBinding -Name Msg -Value $message
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = 200
    Body = "OK"
})

Para enviar varios mensajes a la vez, defina una matriz de mensajes y utilice Push-OutputBinding para enviar mensajes al enlace de salida de la cola.

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$message = @("message1", "message2")
Push-OutputBinding -Name Msg -Value $message
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = 200
    Body = "OK"
})

En el ejemplo siguiente se muestra cómo generar valores únicos y múltiples en las colas de almacenamiento. La configuración necesaria para function.json es la misma en cualquier caso.

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'

En las bibliotecas de clase C#, use QueueAttribute.

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)
{
    ...
}

Para obtener un ejemplo completo, vea el ejemplo de salida.

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.

El script de C# no admite atributos.

La anotación QueueOutput permite escribir un mensaje como la salida de una función. En el ejemplo siguiente se muestra una función desencadenada mediante HTTP que crea un mensaje de cola.

package com.function;
import java.util.*;
import com.microsoft.azure.functions.annotation.*;
import com.microsoft.azure.functions.*;

public class HttpTriggerQueueOutput {
    @FunctionName("HttpTriggerQueueOutput")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.FUNCTION) HttpRequestMessage<Optional<String>> request,
            @QueueOutput(name = "message", queueName = "messages", connection = "MyStorageConnectionAppSetting") OutputBinding<String> message,
            final ExecutionContext context) {

        message.setValue(request.getQueryParameters().get("name"));
        return request.createResponseBuilder(HttpStatus.OK).body("Done").build();
    }
}

El parámetro asociado a la anotación QueueOutput tiene como tipo una instancia de OutputBinding<T>.

JavaScript no admite atributos.

PowerShell no admite atributos.

Python no admite atributos.

Valor predeterminado

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.

En C# y script de C#, escriba varios mensajes de cola mediante uno de los siguientes tipos:

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

Tipos adicionales

Las aplicaciones que usan la versión 5.0.0 o posterior de la extensión de Azure Storage también pueden usar tipos de Azure SDK para .NET. En esta versión se elimina la compatibilidad con los tipos CloudQueue y CloudQueueMessage heredados en favor de los siguientes tipos:

• QueueMessage
• QueueClient para escribir varios mensajes en la cola

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

Valor predeterminado

Escriba un mensaje de cola único mediante un parámetro de método como out T paramName. paramName es el valor especificado en la propiedad name de function.json. 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.

En C# y script de C#, escriba varios mensajes de cola mediante uno de los siguientes tipos:

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

Tipos adicionales

Las aplicaciones que usan la versión 5.0.0 o posterior de la extensión de Azure Storage también pueden usar tipos de Azure SDK para .NET. En esta versión se elimina la compatibilidad con los tipos CloudQueue y CloudQueueMessage heredados en favor de los siguientes tipos:

• QueueMessage
• QueueClient para escribir varios mensajes en la cola

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

Hay dos opciones para generar un mensaje de cola desde una función mediante la anotación QueueOutput:

• Valor devuelto: Al aplicar la anotación a la propia función, el valor devuelto de la función se conserva como un mensaje de cola.

• Imperativa: Para establecer explícitamente el valor del mensaje, aplique la anotación a un parámetro específico del tipo OutputBinding<T>, donde T es un POJO o cualquier tipo de Java nativo. Con esta configuración, al pasar un valor al método setValue se conserva el valor como un mensaje de cola.

El elemento de la cola de salida está disponible mediante context.bindings.<NAME>, donde <NAME> coincide con el nombre definido en function.json. Puede usar una cadena o un objeto JSON serializable para la carga del elemento de cola.

La salida al mensaje de la cola está disponible a través de Push-OutputBinding, donde se pasan argumentos que coinciden con el nombre designado por el parámetro name del enlace en el archivo function.json.

Hay dos opciones para la generación de un mensaje de cola desde una función:

• Valor devuelto: Establezca la propiedad name de function.json en $return. Con esta configuración, el valor devuelto de la función se conserva como un mensaje de Queue Storage.

• Imperativa: Pase un valor al método set del parámetro declarado como tipo Out. El valor pasado a set se conserva como un mensaje de Queue Storage.