Dela via


Dapr State-utdatabindning för Azure Functions

Med utdatabindningen för Dapr-tillstånd kan du spara ett värde i ett Dapr-tillstånd under en funktionskörning.

Information om installation och konfiguration av Dapr-tillägget finns i översikten över Dapr-tillägget.

Example

En C#-funktion kan skapas med något av följande C#-lägen:

Execution model Description
Isolerad arbetsmodell Funktionskoden körs i en separat .NET-arbetsprocess. Använd med versioner av .NET och .NET Framework som stöds. Mer information finns i Guide för att köra C# Azure Functions i den isolerade arbetsmodellen.
In-process model Funktionskoden körs i samma process som värdprocessen för Functions. Stöder endast LTS-versioner (Long Term Support) av .NET. Mer information finns i Utveckla C#-klassbiblioteksfunktioner med Hjälp av Azure Functions.

I följande exempel visas hur du använder Dapr-tillståndsutdatabindningen för att bevara ett nytt tillstånd i tillståndsarkivet.

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

I följande exempel skapas en "CreateNewOrderHttpTrigger" funktion med bindningen DaprStateOutput med en 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.");
}

I följande exempel paras Dapr-tillståndsutdatabindningen ihop med en HTTP-utlösare som registreras av app objektet:

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"]

I följande exempel visas en Dapr State-utdatabindning som använder programmeringsmodellen v2 Python. Så här använder daprState du i din Python-funktionsappkod:

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 Kan skickas via attribut Kan skickas via RequestBody
StateStore Namnet på tillståndsarkivet för att spara tillstånd. ✔️
Key Namnet på nyckeln för att spara tillstånd i tillståndsarkivet. ✔️ ✔️
Value Required. Värdet som lagras. ✔️

Annotations

Med anteckningen DaprStateOutput kan du funktionsåtkomst till ett tillståndslager.

Element Description Kan skickas via attribut Kan skickas via RequestBody
stateStore Namnet på tillståndsarkivet för att spara tillstånd. ✔️
key Namnet på nyckeln för att spara tillstånd i tillståndsarkivet. ✔️ ✔️
value Required. Värdet som lagras. ✔️

Configuration

I följande tabell förklaras de bindningskonfigurationsegenskaper som du anger i koden.

Property Description Kan skickas via attribut Kan skickas via RequestBody
stateStore Namnet på tillståndsarkivet för att spara tillstånd. ✔️
key Namnet på nyckeln för att spara tillstånd i tillståndsarkivet. ✔️ ✔️
value Required. Värdet som lagras. ✔️

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

function.json property Description Kan skickas via attribut Kan skickas via RequestBody
stateStore Namnet på tillståndsarkivet för att spara tillstånd. ✔️
key Namnet på nyckeln för att spara tillstånd i tillståndsarkivet. ✔️ ✔️
value Required. Värdet som lagras. ✔️

I följande tabell beskrivs bindningskonfigurationsegenskaperna för @dapp.dapr_state_output som du anger i Python-koden.

Property Description Kan skickas via attribut Kan skickas via RequestBody
stateStore Namnet på tillståndsarkivet för att spara tillstånd. ✔️
key Namnet på nyckeln för att spara tillstånd i tillståndsarkivet. ✔️ ✔️
value Required. Värdet som lagras. ✔️

Om egenskaper definieras i både Attribut och RequestBodyges prioritet till data som anges i RequestBody.

See the Example section for complete examples.

Usage

Om du vill använda Dapr-tillståndsutdatabindningen börjar du med att konfigurera en Dapr-komponent för tillståndslager. Du kan lära dig mer om vilken komponent som ska användas och hur du konfigurerar den i den officiella Dapr-dokumentationen.

Om du vill använda daprState i Python v2 konfigurerar du projektet med rätt beroenden.

  1. Skapa och aktivera en virtuell miljö.

  2. requirements.text Lägg till följande rad i filen:

    azure-functions==1.18.0b3
    
  3. Installera Python-biblioteket i terminalen.

    pip install -r .\requirements.txt
    
  4. local.setting.json Ändra filen med följande konfiguration:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
    

Next steps

Läs mer om Dapr-tillståndshantering.