Compartir a través de

Enlace de salida de publicación de Dapr para Azure Functions

El enlace de salida de publicación de Dapr permite publicar un mensaje en un tema 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.

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 de un enlace de salida de publicación de Dapr para realizar una operación de publicación de Dapr en un componente y tema pub/sub.

[FunctionName("PublishOutputBinding")]
public static void Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "topic/{topicName}")] HttpRequest req,
    [DaprPublish(PubSubName = "%PubSubName%", Topic = "{topicName}")] out DaprPubSubEvent pubSubEvent,
    ILogger log)
{
    string requestBody = new StreamReader(req.Body).ReadToEnd();
    pubSubEvent = new DaprPubSubEvent(requestBody);
}

En el ejemplo siguiente se crea una "TransferEventBetweenTopics" función mediante el DaprPublishOutput enlace con :DaprTopicTrigger

@FunctionName("TransferEventBetweenTopics")
public String run(
        @DaprTopicTrigger(
            pubSubName = "%PubSubName%",
            topic = "A")
            String request,
        @DaprPublishOutput(
            pubSubName = "%PubSubName%",
            topic = "B")
        OutputBinding<String> payload,
        final ExecutionContext context) throws JsonProcessingException {
    context.getLogger().info("Java function processed a TransferEventBetweenTopics request from the Dapr Runtime.");
}

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

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

app.generic('PublishOutputBinding', {
    trigger: trigger.generic({
        type: 'httpTrigger',
        authLevel: 'anonymous',
        methods: ['POST'],
        route: "topic/{topicName}",
        name: "req"
    }),
    return: daprPublishOutput,
    handler: async (request, context) => {
        context.log("Node HTTP trigger function processed a request.");
        const payload = await request.text();
        context.log(JSON.stringify(payload));

        return { payload: 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 daprPublish:

{
  "bindings": 
    {
      "type": "daprPublish",
      "direction": "out",
      "name": "pubEvent",
      "pubsubname": "%PubSubName%",
      "topic": "B"
    }
}

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

# Example to use Dapr Service Invocation Trigger and Dapr State Output binding to persist a new state into statestore
param (
    $subEvent
)

Write-Host "PowerShell function processed a TransferEventBetweenTopics request from the Dapr Runtime."

# Convert the object to a JSON-formatted string with ConvertTo-Json
$jsonString = $subEvent["data"]

$messageFromTopicA = "Transfer from Topic A: $jsonString".Trim()

$publish_output_binding_req_body = @{
    "payload" = $messageFromTopicA
}

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

En el ejemplo siguiente se muestra un enlace de salida de publicación de Dapr, que usa el modelo de programación de Python v2. Para usar daprPublish 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="TransferEventBetweenTopics")
@app.dapr_topic_trigger(arg_name="subEvent", pub_sub_name="%PubSubName%", topic="A", route="A")
@app.dapr_publish_output(arg_name="pubEvent", pub_sub_name="%PubSubName%", topic="B")
def main(subEvent, pubEvent: func.Out[bytes]) -> None:
    logging.info('Python function processed a TransferEventBetweenTopics request from the Dapr Runtime.')
    subEvent_json = json.loads(subEvent)
    payload = "Transfer from Topic A: " + str(subEvent_json["data"])
    pubEvent.set(json.dumps({"payload": payload}).encode('utf-8'))

Attributes

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

function.json property Description Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
PubSubName Nombre del archivo pub/sub de Dapr para enviar el mensaje. ✔️ ✔️
Topic Nombre del tema de Dapr para enviar el mensaje. ✔️ ✔️
Payload Required. Mensaje que se está publicando. ❌ ✔️

Annotations

La DaprPublishOutput anotación permite tener acceso a una función a un mensaje publicado.

Element Description Se puede enviar mediante el elemento Attribute. Se puede enviar mediante el elemento RequestBody.
pubSubName Nombre del archivo pub/sub de Dapr para enviar el mensaje. ✔️ ✔️
topic Nombre del tema de Dapr para enviar el mensaje. ✔️ ✔️
payload Required. Mensaje que se está publicando. ❌ ✔️

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.
pubsubname Nombre del servicio de componentes del publicador. ✔️ ✔️
topic Nombre o identificador del tema del publicador. ✔️ ✔️
payload Required. Mensaje que se está publicando. ❌ ✔️

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.
pubsubname Nombre del servicio de componentes del publicador. ✔️ ✔️
topic Nombre o identificador del tema del publicador. ✔️ ✔️
payload Required. Mensaje que se está publicando. ❌ ✔️

En la tabla siguiente, se explican las propiedades de configuración de enlace para @dapp.dapr_publish_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.
pub_sub_name Nombre del evento publisher. ✔️ ✔️
topic Nombre o identificador del tema del publicador. ✔️ ✔️
payload Required. Mensaje que se está publicando. ❌ ✔️

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 publicación de Dapr, empiece por configurar un componente pub/sub 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 daprPublish 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

Obtenga más información sobre la publicación y suscripción de Dapr.

  • Last updated on