Compartir a través de

Enlace de salida de estado dapr para Azure Functions

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 de configuración de la extensión Dapr, consulte la introducción a la extensión Dapr.

Example

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

Execution model Description
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 más información, consulte Guía para ejecutar C# azure Functions en el modelo de trabajo aislado.
In-process model 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 más información, consulte Desarrollo de funciones de la biblioteca de clases de C# con Azure Functions.

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 "CreateNewOrderHttpTrigger" función mediante el DaprStateOutput enlace con :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 };
    }
});

The following examples show Dapr triggers in a function.json file and PowerShell code that uses those bindings.

Here's the function.json file for daprState output:

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

For more information about function.json file properties, see the Configuration section.

In code:

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

Attributes

In the in-process model, use the DaprState to define a Dapr state output binding, which supports these parameters:

Parameter Description Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
StateStore Nombre del almacén de estado que se va a guardar. ✔️ ❌
Key Nombre de la clave que se va a guardar en el almacén de estado. ✔️ ✔️
Value Required. Valor que se almacena. ❌ ✔️

Annotations

La DaprStateOutput anotación le permite funcionar con acceso a un almacén de estado.

Element Description Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
stateStore Nombre del almacén de estado que se va a guardar. ✔️ ❌
key Nombre de la clave que se va a guardar en el almacén de estado. ✔️ ✔️
value Required. Valor que se almacena. ❌ ✔️

Configuration

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

Property Description Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
stateStore Nombre del almacén de estado que se va a guardar. ✔️ ❌
key Nombre de la clave que se va a guardar en el almacén de estado. ✔️ ✔️
value Required. Valor que se almacena. ❌ ✔️

The following table explains the binding configuration properties that you set in the function.json file.

function.json property Description Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
stateStore Nombre del almacén de estado que se va a guardar. ✔️ ❌
key Nombre de la clave que se va a guardar en el almacén de estado. ✔️ ✔️
value Required. 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.

Property Description Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
stateStore Nombre del almacén de estado que se va a guardar. ✔️ ❌
key Nombre de la clave que se va a guardar en el almacén de estado. ✔️ ✔️
value Required. Valor que se almacena. ❌ ✔️

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

See the Example section for complete examples.

Usage

Para usar el enlace de salida de estado de Dapr, empiece por configurar un componente de almacén de estado de 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 el archivo local.setting.json con la siguiente configuración:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

Next steps

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

  • Last updated on