Vinculação de entrada de dados do Estado do Dapr para o Azure Functions

Warning

A extensão Dapr para Azure Functions se aposenta em 20 de abril de 2027 e está programada para remoção dos pacotes de extensão nessa data. A remoção se aplica ao pacote principal de extensões versão 4.42.0 e posteriores e ao pacote de extensão de visualização versão 4.60.0 e posteriores.

Essa remoção também se aplica àquelas versões pré-instaladas ou armazenadas em cache no Linux hospedadas por imagens ou distribuídas via hospedagem do Windows.

Migre diretamente para SDKs de clientes Dapr ou APIs HTTP Dapr a partir do seu código de função, e substitua os gatilhos Dapr por funções disparadas por HTTP que recebam callbacks Dapr. Aplicativos existentes podem fixar temporariamente o pacote principal em [4.*, 4.42.0) ou o bundle de pré-visualização em [4.*, 4.60.0) em host.json. Os aplicativos .NET podem continuar usando diretamente os pacotes NuGet correspondentes da extensão Dapr. Nem fixar um pacote mais antigo nem continuar usando os pacotes NuGet estende o suporte além de 20 de abril de 2027 ou altera a data de remoção.

A vinculação de entrada de dados do Estado do Dapr permite que você leia o estado do Dapr durante a execução de uma função.

Para obter informações sobre a instalação e detalhes de configuração da extensão do Dapr, confira a Visão geral da extensão do Dapr.

Example

A função C# pode ser criada usando um dos seguintes modos C#:

Modelo de execução Description
Modelo de trabalho isolado O código de função é executado em um processo de trabalho do .NET separado. Use com versões com suporte do .NET e do .NET Framework. Para saber mais, consulte Guia para executar o C# Azure Functions no modelo de trabalho isolado.
Modelo em processo Seu código de função é executado no mesmo processo que o processo de host do Functions. Dá suporte apenas a versões LTS (suporte de longo prazo) do .NET. Para saber mais, confira Desenvolver funções da biblioteca de classes C# usando o Azure Functions.
[FunctionName("StateInputBinding")]
public static IActionResult Run(
    [HttpTrigger(AuthorizationLevel.Function, "get", Route = "state/{key}")] HttpRequest req,
    [DaprState("statestore", Key = "{key}")] string state,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    return new OkObjectResult(state);
}

O exemplo a seguir cria uma função "RetrieveOrder" usando a vinculação de DaprStateInput com o DaprServiceInvocationTrigger:

@FunctionName("RetrieveOrder")
public String run(
        @DaprServiceInvocationTrigger(
            methodName = "RetrieveOrder") 
        String payload,
        @DaprStateInput(
            stateStore = "%StateStoreName%",
            key = "order")
        String product,
        final ExecutionContext context)

No exemplo a seguir, a associação de entrada de invocação do Dapr é adicionada como uma extraInput e emparelhada com um gatilho HTTP, que é registrado pelo objeto app:

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

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

        const daprStateInputValue = context.extraInputs.get(daprStateInput);
        // print the fetched state value
        context.log(daprStateInputValue);

        return daprStateInputValue;
    }
});

Os exemplos a seguir mostram disparos Dapr em um arquivo function.json e código PowerShell que usa essas bindings.

Aqui está o arquivo function.json para o daprState:

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

Para obter mais informações sobre as propriedades do arquivo function.json, consulte a seção Configuração.

No 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, $order
)

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

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

Write-Host "$jsonString"

O exemplo a seguir mostra uma vinculação de entrada de dados do Estado do Dapr, que usa o modelo de programação do Python v2. Para usar a vinculação de dados do daprState juntamente com o daprServiceInvocationTrigger no código do seu aplicativo de funções do Python:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="RetrieveOrder")
@app.dapr_service_invocation_trigger(arg_name="payload", method_name="RetrieveOrder")
@app.dapr_state_input(arg_name="data", state_store="statestore", key="order")
def main(payload, data: str) :
    # Function should be invoked with this command: dapr invoke --app-id functionapp --method RetrieveOrder  --data '{}'
    logging.info('Python function processed a RetrieveOrder request from the Dapr Runtime.')
    logging.info(data)

Attributes

No modelo em processo, use o DaprState para ler o estado Dapr na sua função, que suporta estes parâmetros:

Parameter Description
StateStore O nome do repositório do estado para recuperar o estado.
Key O nome da chave a ser recuperada do repositório do estado especificado.

Annotations

A anotação do DaprStateInput permite que você leia o Estado do Dapr na sua função.

Element Description
stateStore O nome do repositório do estado do Dapr.
key O valor da chave do repositório do estado.

Configuration

A tabela a seguir explica as propriedades de configuração de associação que você definiu no código.

Property Description
stateStore O nome do repositório do estado.
key O nome da chave a ser recuperada do repositório do estado especificado.

A tabela a seguir explica as propriedades de configuração de associação que você define no arquivo function.json.

Propriedade function.json Description
key O nome da chave a ser recuperada do repositório do estado especificado.
stateStore O nome do repositório do estado.

A tabela a seguir explica as propriedades de configuração de associação para @dapp.dapr_state_input definidas no código do Python.

Property Description
state_store O nome do repositório do estado.
key O valor da chave secreta. O nome da chave a ser recuperada do repositório do estado especificado.

Consulte a Seção de exemplo para obter exemplos completos.

Usage

Para usar a vinculação de entrada de dados do Estado do Dapr, comece configurando um componente de repositório do Estado do Dapr. Sabia mais sobre qual componente deve ser usado e como configurá-lo na documentação oficial do Dapr.

Para usar o daprState no Python v2, configure seu projeto com as dependências corretas.

  1. Criar e ativar um ambiente virtual

  2. No seu arquivo requirements.text, adicione a seguinte linha:

    azure-functions==1.18.0b3
    
  3. No terminal, instale a biblioteca do Python.

    pip install -r .\requirements.txt
    
  4. Altere seu arquivo local.setting.json com a configuração a seguir:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
    

Próximas Etapas 

Saiba mais sobre o gerenciamento do Estado do Dapr.