Gatilho de invocação de serviço 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.

O Azure Functions pode ser disparado em uma invocação de serviço Dapr usando os eventos dapr a seguir.

Para obter mais informações sobre detalhes de instalação e configuração da extensão Dapr, consulte a Visão geral da extensão 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("CreateNewOrder")]
public static void Run(
    [DaprServiceInvocationTrigger] JObject payload,
    [DaprState("%StateStoreName%", Key = "order")] out JToken order,
    ILogger log)
{
    log.LogInformation("C# function processed a CreateNewOrder request from the Dapr Runtime.");

    // payload must be of the format { "data": { "value": "some value" } }
    order = payload["data"];
}

Este é o código Java para o gatilho invocação de serviço dapr:

@FunctionName("CreateNewOrder")
public String run(
        @DaprServiceInvocationTrigger(
            methodName = "CreateNewOrder") 
)

Use o app objeto para registrar o daprInvokeOutput:

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

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

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

        return { body: payload };
    }
});

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 daprServiceInvocationTrigger:

{
  "bindings": [
    {
      "type": "daprServiceInvocationTrigger",
      "name": "payload",
      "direction": "in"
    }
  ]
}

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
)

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

O exemplo a seguir mostra um gatilho invocação de serviço dapr, que usa o modelo de programação python v2. Para usar o código do daprServiceInvocationTrigger 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 DaprServiceInvocationTrigger para acionar uma ligação de invocação de serviço Dapr, que suporta as seguintes propriedades.

Parameter Description
MethodName Optional. O nome do método que o chamador Dapr deve usar. Se não for especificado, o nome da função será usado como o nome do método.

Annotations

A DaprServiceInvocationTrigger anotação permite que você crie uma função que seja invocada pelo runtime do Dapr.

Element Description
methodName O nome do método.

Configuration

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

Property Description
type Deve ser definido como daprServiceInvocationTrigger.
name O nome da variável que representa os dados dapr no código de função.

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

Propriedade function.json Description
type Deve ser definido como daprServiceInvocationTrigger.
name O nome da variável que representa os dados dapr no código de função.

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

Property Description
method_name O nome da variável que representa os dados dapr.

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

Usage

Para usar um gatilho de Invocação de Serviço daPr, saiba mais sobre quais componentes usar com o gatilho invocação de serviço e como configurá-los na documentação oficial do Dapr.

Para usar a opção daprServiceInvocationTrigger no Python v2, configure seu projeto com as dependências corretas.

  1. Criar e ativar um ambiente virtual.

  2. No 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. Modifique seu arquivo local.setting.json com a seguinte configuração:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
    

Próximas Etapas 

Saiba mais sobre a invocação do serviço do Dapr.