Enlace de salida de enlace de Dapr para Azure Functions

  • Artículo

Importante

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

El enlace de salida de Dapr permite enviar un valor a un enlace de salida de 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.

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 de un desencadenador de invocación del servicio Dapr y un enlace de salida de Dapr para leer y procesar una solicitud de enlace.

[FunctionName("SendMessageToKafka")]
public static async Task Run(
    [DaprServiceInvocationTrigger] JObject payload,
    [DaprBinding(BindingName = "%KafkaBindingName%", Operation = "create")] IAsyncCollector<object> messages,
    ILogger log)
{
    log.LogInformation("C#  function processed a SendMessageToKafka request.");
    await messages.AddAsync(payload);
}

En el ejemplo siguiente se crea una función "SendMessagetoKafka" mediante el enlace DaprBindingOutput con DaprServiceInvocationTrigger:

@FunctionName("SendMessageToKafka")
public String run(
        @DaprServiceInvocationTrigger(
            methodName = "SendMessageToKafka") 
        String payload,
        @DaprBindingOutput(
            bindingName = "%KafkaBindingName%", 
            operation = "create")
        OutputBinding<String> product,
        final ExecutionContext context) {
    context.getLogger().info("Java  function processed a SendMessageToKafka request.");
    product.setValue(payload);

    return payload;
}

En el ejemplo siguiente, el enlace de salida de Dapr se empareja con el desencadenador de salida de invocación de Dapr, que está registrado por el app objeto :

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

app.generic('SendMessageToKafka', {
    trigger: trigger.generic({
        type: 'daprServiceInvocationTrigger',
        name: "payload"
    }),
    return: daprBindingOuput,
    handler: async (request, context) => {
        context.log("Node function processed a SendMessageToKafka request from the Dapr Runtime.");
        context.log(context.triggerMetadata.payload)

        return { "data": context.triggerMetadata.payload };
    }
});

En los ejemplos siguientes, se muestran desencadenadores de Dapr en un archivo function.json y código de PowerShell que usa esos enlaces.

Este es el archivo function.json para daprBinding:

{
  "bindings": 
    {
      "type": "daprBinding",
      "direction": "out",
      "bindingName": "%KafkaBindingName%",
      "operation": "create",
      "name": "messages"
    }
}

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

Mediante código:

using namespace System.Net

# Input bindings are passed in via param block.
param($req, $TriggerMetadata)

Write-Host "Powershell SendMessageToKafka processed a request."

$invoke_output_binding_req_body = @{
    "data" = $req
}

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name messages -Value $invoke_output_binding_req_body

En el ejemplo siguiente, se muestra un enlace de salida de enlace de Dapr que usa el modelo de programación de Python v2. Para usar @dapp.dapr_binding_output 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="SendMessageToKafka")
@app.dapr_service_invocation_trigger(arg_name="payload", method_name="SendMessageToKafka")
@app.dapr_binding_output(arg_name="messages", binding_name="%KafkaBindingName%", operation="create")
def main(payload: str, messages: func.Out[bytes]) -> None:
    logging.info('Python processed a SendMessageToKafka request from the Dapr Runtime.')
    messages.set(json.dumps({"data": payload}).encode('utf-8'))

Atributos

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

Parámetro Descripción Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
BindingName El nombre del enlace de Dapr. ✔️ ✔️
Operación La operación de enlace configurada. ✔️ ✔️
Metadata Espacio de nombres de metadatos. ❌ ✔️
Data Necesario. Datos de la operación de enlace. ❌ ✔️

anotaciones

La anotación DaprBindingOutput permite crear una función que envíe un enlace de salida.

Elemento Descripción Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
bindingName El nombre del enlace de Dapr. ✔️ ✔️
output La operación de enlace configurada. ✔️ ✔️
metadata Espacio de nombres de metadatos. ❌ ✔️
data Necesario. Datos de la operación de enlace. ❌ ✔️

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 mediante el elemento RequestBody.
bindingName Nombre del enlace. ✔️ ✔️
operación Operación de enlace. ✔️ ✔️
metadata Espacio de nombres de metadatos. ❌ ✔️
data Necesario. Datos de la operación de enlace. ❌ ✔️

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 mediante el elemento RequestBody.
bindingName Nombre del enlace. ✔️ ✔️
operación Operación de enlace. ✔️ ✔️
metadata Espacio de nombres de metadatos. ❌ ✔️
data Necesario. Datos de la operación de enlace. ❌ ✔️

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

Propiedad Descripción Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
binding_name Nombre del evento de enlace. ✔️ ✔️
operación Nombre o identificador de la operación de enlace. ✔️ ✔️
metadata Espacio de nombres de metadatos. ❌ ✔️
data Necesario. Datos de la operación de enlace. ❌ ✔️

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 Dapr, empiece por configurar un componente de enlace de salida 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 daprBinding 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

Pasos siguientes

Obtenga más información sobre la invocación del servicio Dapr.