Enlace de salida de estado Dapr para Azure Functions

  • Artículo

Importante

La extensión Dapr para Azure Functions está actualmente en versión preliminar y solo se admite en entornos de Azure Container Apps.

El enlace de salida de estado Dapr permite guardar un valor en un estado Dapr durante la ejecución de una función.

Para obtener información sobre la configuración y los detalles respectivos de la extensión Dapr, consulte Introducción a la extensión Dapr.

Ejemplo

Se puede crear una función C# usando uno de los siguientes modos de C#:

Modelo de ejecución Descripción
Modelo de trabajo aislado El código de función se ejecuta en un proceso de trabajo de .NET independiente. Se usa con versiones compatibles de .NET y .NET Framework. Para obtener más información, consulte Desarrollo de funciones de procesos de trabajo aislados en .NET.
Modelo de proceso El código de función se ejecuta en el mismo proceso que el proceso de host de Functions. Solo admite versiones de .NET de compatibilidad a largo plazo (LTS). Para obtener más información, consulte Desarrollo de funciones de la biblioteca de clases de .NET.

En el ejemplo siguiente se muestra el uso del enlace de salida de estado Dapr para conservar un nuevo estado en el almacén de estado.

[FunctionName("StateOutputBinding")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "state/{key}")] HttpRequest req,
    [DaprState("statestore", Key = "{key}")] IAsyncCollector<string> state,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
    await state.AddAsync(requestBody);

    return new OkResult();
}

En el ejemplo siguiente se crea una función "CreateNewOrderHttpTrigger" mediante el enlace DaprStateOutput con un elemento HttpTrigger:

@FunctionName("CreateNewOrderHttpTrigger")
public String run(
        @HttpTrigger(
            name = "req",
            methods = {HttpMethod.POST},
            authLevel = AuthorizationLevel.ANONYMOUS)
            HttpRequestMessage<Optional<String>> request,
        @DaprStateOutput(
            stateStore = "%StateStoreName%",
            key = "product")
        OutputBinding<String> product,
        final ExecutionContext context) {
    context.getLogger().info("Java HTTP trigger (CreateNewOrderHttpTrigger) processed a request.");
}

En el ejemplo siguiente, el enlace de salida de estado Dapr se empareja con un desencadenador HTTP, que está registrado por el app objeto :

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

app.generic('StateOutputBinding', {
    trigger: trigger.generic({
        type: 'httpTrigger',
        authLevel: 'anonymous',
        methods: ['POST'],
        route: "state/{key}",
        name: "req"
    }),
    return: daprStateOutput,
    handler: async (request, context) => {
        context.log("Node HTTP trigger function processed a request.");

        const payload = await request.text();
        context.log(JSON.stringify(payload));

        return { value : payload };
    }
});

En los ejemplos siguientes se muestra cómo se desencadena Dapr en un archivo function.json y el código de PowerShell que usa esos enlaces.

Este es el archivo function.json para la salida daprState:

{
  "bindings": 
    {
      "type": "daprState",
      "stateStore": "%StateStoreName%",
      "direction": "out",
      "name": "order",
      "key": "order"
    }
}

Para obtener más información sobre las propiedades del archivo function.json, consulte la sección Configuración.

Mediante código:

using namespace System
using namespace Microsoft.Azure.WebJobs
using namespace Microsoft.Extensions.Logging
using namespace Microsoft.Azure.WebJobs.Extensions.Dapr
using namespace Newtonsoft.Json.Linq

param (
    $payload
)

# C# function processed a CreateNewOrder request from the Dapr Runtime.
Write-Host "PowerShell function processed a CreateNewOrder request from the Dapr Runtime."

# Payload must be of the format { "data": { "value": "some value" } }

# Convert the object to a JSON-formatted string with ConvertTo-Json
$jsonString = $payload| ConvertTo-Json

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name order -Value $payload["data"]

En el ejemplo siguiente se muestra un enlace de salida de estado Dapr, que usa el modelo de programación de Python v2. Para usar daprState en el código de aplicación de funciones de Python:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="HttpTriggerFunc")
@app.route(route="req", auth_level=dapp.auth_level.ANONYMOUS)
@app.dapr_state_output(arg_name="state", state_store="statestore", key="newOrder")
def main(req: func.HttpRequest, state: func.Out[str] ) -> str:
    # request body must be passed this way '{\"value\": { \"key\": \"some value\" } }'
    body = req.get_body()
    if body is not None:
        state.set(body.decode('utf-8'))
        logging.info(body.decode('utf-8'))
    else:
        logging.info('req body is none')
    return 'ok'

Atributos

En el modelo In-Process, use el atributo DaprState para definir un enlace de salida de estado Dapr, que admite estos parámetros:

Parámetro Descripción Se puede enviar mediante el elemento Attribute. Se puede enviar a través de RequestBody
StateStore Nombre del almacén de estado para guardar el estado. ✔️ ❌
Clave Nombre de la clave para guardar el estado en el almacén de estado. ✔️ ✔️
Valor Necesario. Valor que se almacena. ❌ ✔️

anotaciones

La anotación DaprStateOutput le permite acceder a las funciones de un almacén de estado.

Elemento Descripción Se puede enviar mediante el elemento Attribute. Se puede enviar a través de RequestBody
stateStore Nombre del almacén de estado para guardar el estado. ✔️ ❌
key Nombre de la clave para guardar el estado en el almacén de estado. ✔️ ✔️
value Necesario. Valor que se almacena. ❌ ✔️

Configuración

En la tabla siguiente se explican las propiedades de configuración de enlace establecidas en el código.

Propiedad Descripción Se puede enviar mediante el elemento Attribute. Se puede enviar a través de RequestBody
stateStore Nombre del almacén de estado para guardar el estado. ✔️ ❌
key Nombre de la clave para guardar el estado en el almacén de estado. ✔️ ✔️
value Necesario. Valor que se almacena. ❌ ✔️

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

Propiedad de function.json Descripción Se puede enviar mediante el elemento Attribute. Se puede enviar a través de RequestBody
stateStore Nombre del almacén de estado para guardar el estado. ✔️ ❌
key Nombre de la clave para guardar el estado en el almacén de estado. ✔️ ✔️
value Necesario. Valor que se almacena. ❌ ✔️

En la tabla siguiente, se explican las propiedades de configuración de enlace para @dapp.dapr_state_output que estableció en el código de Python.

Propiedad Descripción Se puede enviar mediante el elemento Attribute. Se puede enviar a través de RequestBody
stateStore Nombre del almacén de estado para guardar el estado. ✔️ ❌
key Nombre de la clave para guardar el estado en el almacén de estado. ✔️ ✔️
value Necesario. Valor que se almacena. ❌ ✔️

Si las propiedades se definen tanto en Attributes como en RequestBody, se da prioridad a los datos proporcionados en RequestBody.

Consulte la sección de ejemplos para ver ejemplos completos.

Uso

Para usar el enlace de salida de estado Dapr, empiece por configurar un componente de almacén de estado Dapr. Puede obtener más información sobre qué componente usar y cómo configurarlo en la documentación oficial de Dapr.

Para usar daprState en Python v2, configure el proyecto con las dependencias correctas.

  1. Creación y activación de un entorno virtual.

  2. En el archivo requirements.text, agregue la línea siguiente:

    azure-functions==1.18.0b3

  3. En el terminal, instale la biblioteca de Python.

    pip install -r .\requirements.txt

  4. Modifique su archivo local.setting.json con la configuración siguiente:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

Pasos siguientes

Más información acerca de la administración de estado Dapr.