Azure Event Hubs uitvoerbinding voor Azure Functions

Met het Python v2-programmeermodel kunt u bindingen definiëren met behulp van decorators rechtstreeks in uw Python functiecode. Zie de Python ontwikkelaarshandleiding voor meer informatie.

Voor het programmeermodel Python v1 moet u bindingen definiëren in een afzonderlijk function.json-bestand in de functiemap. Zie de Python ontwikkelaarshandleiding voor meer informatie.

In het volgende voorbeeld ziet u een C#-functie waarmee een berichttekenreeks naar een Event Hub wordt geschreven, met behulp van de retourwaarde van de methode als uitvoer:

[Function(nameof(EventHubFunction))]
[FixedDelayRetry(5, "00:00:10")]
[EventHubOutput("dest", Connection = "EventHubConnection")]
public string EventHubFunction(
    [EventHubTrigger("src", Connection = "EventHubConnection")] string[] input,
    FunctionContext context)
{
    _logger.LogInformation("First Event Hubs triggered message: {msg}", input[0]);

    var message = $"Output message created at {DateTime.Now}";
    return message;
}

In het volgende voorbeeld ziet u een C#-functie die een bericht naar een Event Hub schrijft, met behulp van de retourwaarde van de methode als uitvoer:

[FunctionName("EventHubOutput")]
[return: EventHub("outputEventHubMessage", Connection = "EventHubConnectionAppSetting")]
public static string Run([TimerTrigger("0 */5 * * * *")] TimerInfo myTimer, ILogger log)
{
    log.LogInformation($"C# Timer trigger function executed at: {DateTime.Now}");
    return $"{DateTime.Now}";
}

In het volgende voorbeeld ziet u hoe u de IAsyncCollector-interface gebruikt om een batch berichten te verzenden. Dit scenario is gebruikelijk wanneer u berichten verwerkt die afkomstig zijn van de ene Event Hub en het resultaat naar een andere Event Hub verzendt.

[FunctionName("EH2EH")]
public static async Task Run(
    [EventHubTrigger("source", Connection = "EventHubConnectionAppSetting")] EventData[] events,
    [EventHub("dest", Connection = "EventHubConnectionAppSetting")]IAsyncCollector<EventData> outputEvents,
    ILogger log)
{
    foreach (EventData eventData in events)
    {
        // Do some processing:
        string newEventBody = DoSomething(eventData);

        // Queue the message to be sent in the background by adding it to the collector.
        // If only the event is passed, an Event Hubs partition to be assigned via
        // round-robin for each batch.
        await outputEvents.AddAsync(new EventData(newEventBody));

        // If your scenario requires that certain events are grouped together in an
        // Event Hubs partition, you can specify a partition key.  Events added with 
        // the same key will always be assigned to the same partition.        
        await outputEvents.AddAsync(new EventData(newEventBody), "sample-key");
    }
}

In het volgende voorbeeld ziet u een door een timer geactiveerde TypeScript-functie waarmee één bericht naar een Event Hub wordt verzonden:

import { app, InvocationContext, output, Timer } from '@azure/functions';

export async function timerTrigger1(myTimer: Timer, context: InvocationContext): Promise<string> {
    const timeStamp = new Date().toISOString();
    return `Message created at: ${timeStamp}`;
}

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    return: output.eventHub({
        eventHubName: 'myeventhub',
        connection: 'MyEventHubSendAppSetting',
    }),
    handler: timerTrigger1,
});

Als u meerdere berichten wilt uitvoeren, retourneert u een matrix in plaats van één object. Voorbeeld:

const timeStamp = new Date().toISOString();
const message = `Message created at: ${timeStamp}`;
return [`1: ${message}`, `2: ${message}`];

TypeScript-voorbeelden worden niet gedocumenteerd voor model v3.

In het volgende voorbeeld ziet u een door een timer geactiveerde JavaScript-functie waarmee één bericht naar een Event Hub wordt verzonden:

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

const eventHubOutput = output.eventHub({
    eventHubName: 'myeventhub',
    connection: 'MyEventHubSendAppSetting',
});

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    return: eventHubOutput,
    handler: (myTimer, context) => {
        const timeStamp = new Date().toISOString();
        return `Message created at: ${timeStamp}`;
    },
});

Als u meerdere berichten wilt uitvoeren, retourneert u een matrix in plaats van één object. Voorbeeld:

const timeStamp = new Date().toISOString();
const message = `Message created at: ${timeStamp}`;
return [`1: ${message}`, `2: ${message}`];

In het volgende voorbeeld ziet u een event hub-triggerbinding in een function.json-bestand en een functie die gebruikmaakt van de binding. De functie schrijft een uitvoerbericht naar een Event Hub.

In het volgende voorbeeld ziet u een Event Hubs-bindingsgegevens in het function.json-bestand . Dit is anders voor versie 1.x van de Functions-runtime in vergelijking met latere versies.

{
    "type": "eventHub",
    "name": "outputEventHubMessage",
    "eventHubName": "myeventhub",
    "connection": "MyEventHubSendAppSetting",
    "direction": "out"
}

Dit is de JavaScript-code voor het verzenden van één bericht:

module.exports = function (context, myTimer) {
    var timeStamp = new Date().toISOString();
    context.log('Message created at: ', timeStamp);   
    context.bindings.outputEventHubMessage = "Message created at: " + timeStamp;
    context.done();
};

Dit is de JavaScript-code voor het verzenden van meerdere berichten:

module.exports = function(context) {
    var timeStamp = new Date().toISOString();
    var message = 'Message created at: ' + timeStamp;

    context.bindings.outputEventHubMessage = [];

    context.bindings.outputEventHubMessage.push("1 " + message);
    context.bindings.outputEventHubMessage.push("2 " + message);
    context.done();
};

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="eventhub_output")
@app.route(route="eventhub_output")
@app.event_hub_output(arg_name="event",
                      event_hub_name="<EVENT_HUB_NAME>",
                      connection="<CONNECTION_SETTING>")
def eventhub_output(req: func.HttpRequest, event: func.Out[str]):
    body = req.get_body()
    if body is not None:
        event.set(body.decode('utf-8'))
    else:    
        logging.info('req body is none')
    return 'ok'

Hier volgt Python code waarmee meerdere berichten worden verzonden:

import logging
import azure.functions as func
from typing import List

app = func.FunctionApp()

@app.function_name(name="eventhub_output")
@app.route(route="eventhub_output")
@app.event_hub_output(arg_name="event",
                      event_hub_name="<EVENT_HUB_NAME>",
                      connection="<CONNECTION_SETTING>")

def eventhub_output(req: func.HttpRequest, event: func.Out[List[str]]) -> func.HttpResponse:
    my_messages=["message1", "message2","message3"]
    event.set(my_messages)
    return func.HttpResponse(f"Messages sent")

In de volgende voorbeelden ziet u Event Hubs die gegevens binden in het bestand function.json.

{
    "type": "eventHub",
    "name": "$return",
    "eventHubName": "myeventhub",
    "connection": "MyEventHubSendAppSetting",
    "direction": "out"
}

Hier volgt Python code waarmee één bericht wordt verzonden:

import datetime
import logging
import azure.functions as func


def main(timer: func.TimerRequest) -> str:
    timestamp = datetime.datetime.utcnow()
    logging.info('Message created at: %s', timestamp)
    return 'Message created at: {}'.format(timestamp)

Hier volgt Python code waarmee meerdere berichten worden verzonden:

import logging
from typing import List
import azure.functions as func


def main(req: func.HttpRequest, messages:func.Out[List[str]]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')
    messages.set([{"message1"}, {"message2"}])
    return func.HttpResponse(f"Messages sent")

Gebruik [EventHubOutputAttribute] om een uitvoerbinding te definiëren voor een Event Hub, die de volgende eigenschappen ondersteunt.

Gebruik EventHubAttribute om een uitvoerbinding te definiëren voor een Event Hub, die ondersteuning biedt voor de volgende eigenschappen.

In de volgende tabel worden de eigenschappen uitgelegd die u kunt instellen voor het options object dat aan de output.eventHub() methode is doorgegeven.

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

In-process C#-klassebibliotheekfuncties ondersteunen de volgende typen:

• Azure. Messaging.EventHubs.EventData
• Snaar / Touwtje
• Bytematrix
• Normaal oud CLR-object (POCO)

Deze versie van EventData vermindert ondersteuning voor het verouderde Body type ten gunste van EventBody.

Verzend berichten met behulp van een methodeparameter, zoals out string paramName. Als u meerdere berichten wilt schrijven, kunt u ICollector<EventData> of IAsyncCollector<EventData> gebruiken in plaats van out string. Partitiesleutels mogen alleen worden gebruikt met IAsyncCollector<EventData>.

In-process C#-klassebibliotheekfuncties ondersteunen de volgende typen:

• Microsoft.Azure. EventHubs.EventData
• Snaar / Touwtje
• Bytematrix
• Normaal oud CLR-object (POCO)

Verzend berichten met behulp van een methodeparameter, zoals out string paramName. Als u meerdere berichten wilt schrijven, kunt u ICollector<string> of IAsyncCollector<string> gebruiken in plaats van out string.

Wanneer u wilt dat de functie één gebeurtenis schrijft, kan de Event Hubs-uitvoerbinding worden gekoppeld aan de volgende typen:

Wanneer u wilt dat de functie meerdere gebeurtenissen schrijft, kan de Event Hubs-uitvoerbinding worden gekoppeld aan de volgende typen:

Voor andere uitvoerscenario's maakt en gebruikt u een EventHubProducerClient met andere typen uit Azure. Messaging.EventHubs rechtstreeks. Zie Register Azure clients voor een voorbeeld van het gebruik van afhankelijkheidsinjectie om een clienttype te maken op basis van de Azure SDK.

Hiervoor moet u een aangepast type definiëren of een tekenreeks gebruiken. Er zijn extra opties beschikbaar in Extension v5.x+.

Open het uitvoerbericht door de waarde rechtstreeks of met behulp van context.extraOutputs.set().

Open de uitvoergebeurtenis met behulp van context.bindings.<name> waarbij <name> de waarde is die is opgegeven voor de eigenschap name van function.json.