Výstupní vazba služby Azure Event Hubs pro Azure Functions

Programovací model Pythonu v2 umožňuje definovat vazby pomocí dekorátorů přímo v kódu funkce Pythonu. Další informace najdete v příručce pro vývojáře Pythonu.

Programovací model Pythonu v1 vyžaduje, abyste definovali vazby v samostatném souboru function.json ve složce funkce. Další informace najdete v příručce pro vývojáře Pythonu.

Následující příklad ukazuje funkci jazyka C#, která zapíše řetězec zprávy do centra událostí pomocí návratové hodnoty metody jako výstupu:

[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;
}

Následující příklad ukazuje funkci jazyka C#, která zapisuje zprávu do centra událostí pomocí návratové hodnoty metody jako výstupu:

[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}";
}

Následující příklad ukazuje, jak použít IAsyncCollector rozhraní k odeslání dávky zpráv. Tento scénář je běžný, když zpracováváte zprávy přicházející z jednoho centra událostí a odesíláte výsledek do jiného centra událostí.

[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");
    }
}

Následující příklad ukazuje funkci TypeScript aktivovanou časovačem, která odesílá jednu zprávu do centra událostí:

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,
});

Pokud chcete vytvořit výstup více zpráv, vraťte místo jednoho objektu pole. Příklad:

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

Ukázky TypeScriptu nejsou zdokumentované pro model v3.

Následující příklad ukazuje časovač aktivovanou funkci JavaScriptu, která odesílá jednu zprávu do centra událostí:

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}`;
    },
});

Pokud chcete vytvořit výstup více zpráv, vraťte místo jednoho objektu pole. Příklad:

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

Následující příklad ukazuje vazbu triggeru centra událostí v souboru function.json a funkci, která používá vazbu. Funkce zapíše výstupní zprávu do centra událostí.

Následující příklad ukazuje data vazby služby Event Hubs v souboru function.json , která se liší pro verzi 1.x modulu runtime služby Functions v porovnání s novějšími verzemi.

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

Tady je javascriptový kód, který odesílá jednu zprávu:

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();
};

Tady je javascriptový kód, který odesílá více zpráv:

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'

Tady je kód Pythonu, který odesílá více zpráv:

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")

Následující příklady ukazují data vazby služby Event Hubs v souboru function.json .

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

Tady je kód Pythonu, který odesílá jednu zprávu:

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)

Tady je kód Pythonu, který odesílá více zpráv:

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")

Pomocí [EventHubOutputAttribute] definujte výstupní vazbu do centra událostí, která podporuje následující vlastnosti.

Pomocí EventHubAttribute definujte výstupní vazbu do centra událostí, která podporuje následující vlastnosti.

Následující tabulka vysvětluje vlastnosti, které můžete nastavit u objektu předaného options metodě output.eventHub() .

Následující tabulka vysvětluje vlastnosti konfigurace vazby, které jste nastavili v souboru function.json .

Funkce knihovny tříd jazyka C# v procesu podporují následující typy:

• Azure.Messaging.EventHubs.EventData
• String
• Bajtové
• Prostý objekt CLR (POCO)

Tato verze EventData zahodí podporu staršího Body typu ve prospěch EventBody.

Odesílání zpráv pomocí parametru metody, například out string paramName. Chcete-li psát více zpráv, můžete použít ICollector<EventData> nebo IAsyncCollector<EventData> místo out string. Klíče oddílů lze používat pouze s IAsyncCollector<EventData>.

Funkce knihovny tříd jazyka C# v procesu podporují následující typy:

• Microsoft.Azure.EventHubs.EventData
• String
• Bajtové
• Prostý objekt CLR (POCO)

Odesílání zpráv pomocí parametru metody, například out string paramName. Chcete-li psát více zpráv, můžete použít ICollector<string> nebo IAsyncCollector<string> místo out string.

Pokud chcete, aby funkce zapisuje jednu událost, výstupní vazba služby Event Hubs může svázat s následujícími typy:

Pokud chcete, aby funkce zapisuje více událostí, výstupní vazba služby Event Hubs může svázat s následujícími typy:

V případě jiných výstupních scénářů můžete přímo vytvářet a používat typy z Microsoft.Azure.EventHubs .

Vyžaduje, abyste definovali vlastní typ nebo použili řetězec. Další možnosti jsou k dispozici v rozšíření v5.x+.

Přístup k výstupní zprávě vrácením hodnoty přímo nebo pomocí context.extraOutputs.set().

Přístup k výstupní události pomocí where context.bindings.<name> <name> je hodnota zadaná ve name vlastnosti function.json.