Привязки Центров событий Azure для службы "Функции Azure"Azure Event Hubs bindings for Azure Functions

В следующем примере показана функция C#, которая записывает в журнал текст сообщений триггера концентратора событий.The following example shows a C# function that logs the message body of the event hub trigger.

[FunctionName("EventHubTriggerCSharp")]
public static void Run([EventHubTrigger("samples-workitems", Connection = "EventHubConnectionAppSetting")] string myEventHubMessage, ILogger log)
{
    log.LogInformation($"C# function triggered to process a message: {myEventHubMessage}");
}

Чтобы получить доступ к метаданным события в коде функции, создайте привязку к объекту EventData (требуется инструкция using для Microsoft.Azure.EventHubs).To get access to event metadata in function code, bind to an EventData object (requires a using statement for Microsoft.Azure.EventHubs). Вы также можете получить доступ к тем же свойствам, используя выражения привязки в сигнатуре метода.You can also access the same properties by using binding expressions in the method signature. В следующем примере показаны оба способа получения одних и тех же данных:The following example shows both ways to get the same data:

[FunctionName("EventHubTriggerCSharp")]
public static void Run(
    [EventHubTrigger("samples-workitems", Connection = "EventHubConnectionAppSetting")] EventData myEventHubMessage,
    DateTime enqueuedTimeUtc,
    Int64 sequenceNumber,
    string offset,
    ILogger log)
{
    log.LogInformation($"Event: {Encoding.UTF8.GetString(myEventHubMessage.Body)}");
    // Metadata accessed by binding to EventData
    log.LogInformation($"EnqueuedTimeUtc={myEventHubMessage.SystemProperties.EnqueuedTimeUtc}");
    log.LogInformation($"SequenceNumber={myEventHubMessage.SystemProperties.SequenceNumber}");
    log.LogInformation($"Offset={myEventHubMessage.SystemProperties.Offset}");
    // Metadata accessed by using binding expressions in method parameters
    log.LogInformation($"EnqueuedTimeUtc={enqueuedTimeUtc}");
    log.LogInformation($"SequenceNumber={sequenceNumber}");
    log.LogInformation($"Offset={offset}");
}

Для пакетного получения событий сделайте string или EventData массивом.To receive events in a batch, make string or EventData an array.

[FunctionName("EventHubTriggerCSharp")]
public static void Run([EventHubTrigger("samples-workitems", Connection = "EventHubConnectionAppSetting")] EventData[] eventHubMessages, ILogger log)
{
    foreach (var message in eventHubMessages)
    {
        log.LogInformation($"C# function triggered to process a message: {Encoding.UTF8.GetString(message.Body)}");
        log.LogInformation($"EnqueuedTimeUtc={message.SystemProperties.EnqueuedTimeUtc}");
    }
}

В следующем примере показаны привязка триггера концентратора событий в файле function.json и функция сценария C#, которая использует эту привязку.The following example shows an event hub trigger binding in a function.json file and a C# script function that uses the binding. Эта функция записывает в журнал текст сообщений триггера концентратора событий.The function logs the message body of the event hub trigger.

В приведенных ниже примерах показаны данные привязки Центров событий в файле function.json.The following examples show Event Hubs binding data in the function.json file.

Версии 2. x и вышеVersion 2.x and higher

{
  "type": "eventHubTrigger",
  "name": "myEventHubMessage",
  "direction": "in",
  "eventHubName": "MyEventHub",
  "connection": "myEventHubReadConnectionAppSetting"
}

Версия 1.xVersion 1.x

{
  "type": "eventHubTrigger",
  "name": "myEventHubMessage",
  "direction": "in",
  "path": "MyEventHub",
  "connection": "myEventHubReadConnectionAppSetting"
}

Ниже приведен код скрипта C#.Here's the C# script code:

using System;

public static void Run(string myEventHubMessage, TraceWriter log)
{
    log.Info($"C# function triggered to process a message: {myEventHubMessage}");
}

Чтобы получить доступ к метаданным события в коде функции, создайте привязку к объекту EventData (требуется инструкция using для Microsoft.Azure.EventHubs).To get access to event metadata in function code, bind to an EventData object (requires a using statement for Microsoft.Azure.EventHubs). Вы также можете получить доступ к тем же свойствам, используя выражения привязки в сигнатуре метода.You can also access the same properties by using binding expressions in the method signature. В следующем примере показаны оба способа получения одних и тех же данных:The following example shows both ways to get the same data:

#r "Microsoft.Azure.EventHubs"

using System.Text;
using System;
using Microsoft.ServiceBus.Messaging;
using Microsoft.Azure.EventHubs;

public static void Run(EventData myEventHubMessage,
    DateTime enqueuedTimeUtc,
    Int64 sequenceNumber,
    string offset,
    TraceWriter log)
{
    log.Info($"Event: {Encoding.UTF8.GetString(myEventHubMessage.Body)}");
    log.Info($"EnqueuedTimeUtc={myEventHubMessage.SystemProperties.EnqueuedTimeUtc}");
    log.Info($"SequenceNumber={myEventHubMessage.SystemProperties.SequenceNumber}");
    log.Info($"Offset={myEventHubMessage.SystemProperties.Offset}");

    // Metadata accessed by using binding expressions
    log.Info($"EnqueuedTimeUtc={enqueuedTimeUtc}");
    log.Info($"SequenceNumber={sequenceNumber}");
    log.Info($"Offset={offset}");
}

Для пакетного получения событий создайте массив string или EventData.To receive events in a batch, make string or EventData an array:

public static void Run(string[] eventHubMessages, TraceWriter log)
{
    foreach (var message in eventHubMessages)
    {
        log.Info($"C# function triggered to process a message: {message}");
    }
}

В следующем примере показаны привязка триггера концентратора событий в файле function.json и функция JavaScript, которая использует эту привязку.The following example shows an event hub trigger binding in a function.json file and a JavaScript function that uses the binding. Функция считывает метаданные события и записывает сообщение в журнал.The function reads event metadata and logs the message.

В приведенных ниже примерах показаны данные привязки Центров событий в файле function.json.The following examples show Event Hubs binding data in the function.json file.

Версии 2. x и вышеVersion 2.x and higher

{
  "type": "eventHubTrigger",
  "name": "myEventHubMessage",
  "direction": "in",
  "eventHubName": "MyEventHub",
  "connection": "myEventHubReadConnectionAppSetting"
}

Версия 1.xVersion 1.x

{
  "type": "eventHubTrigger",
  "name": "myEventHubMessage",
  "direction": "in",
  "path": "MyEventHub",
  "connection": "myEventHubReadConnectionAppSetting"
}

Ниже показан код JavaScript.Here's the JavaScript code:

module.exports = function (context, myEventHubMessage) {
    context.log('Function triggered to process a message: ', myEventHubMessage);
    context.log('EnqueuedTimeUtc =', context.bindingData.enqueuedTimeUtc);
    context.log('SequenceNumber =', context.bindingData.sequenceNumber);
    context.log('Offset =', context.bindingData.offset);

    context.done();
};

Чтобы получить события в пакете, задайте для параметра cardinality в файле function.json значение many, как показано в приведенных ниже примерах.To receive events in a batch, set cardinality to many in the function.json file, as shown in the following examples.

Версии 2. x и вышеVersion 2.x and higher

{
  "type": "eventHubTrigger",
  "name": "eventHubMessages",
  "direction": "in",
  "eventHubName": "MyEventHub",
  "cardinality": "many",
  "connection": "myEventHubReadConnectionAppSetting"
}

Версия 1.xVersion 1.x

{
  "type": "eventHubTrigger",
  "name": "eventHubMessages",
  "direction": "in",
  "path": "MyEventHub",
  "cardinality": "many",
  "connection": "myEventHubReadConnectionAppSetting"
}

Ниже показан код JavaScript.Here's the JavaScript code:

module.exports = function (context, eventHubMessages) {
    context.log(`JavaScript eventhub trigger function called for message array ${eventHubMessages}`);

    eventHubMessages.forEach((message, index) => {
        context.log(`Processed message ${message}`);
        context.log(`EnqueuedTimeUtc = ${context.bindingData.enqueuedTimeUtcArray[index]}`);
        context.log(`SequenceNumber = ${context.bindingData.sequenceNumberArray[index]}`);
        context.log(`Offset = ${context.bindingData.offsetArray[index]}`);
    });

    context.done();
};

В следующем примере показаны привязка триггера концентратора событий в файле function.json и функция Python, которая использует эту привязку.The following example shows an event hub trigger binding in a function.json file and a Python function that uses the binding. Функция считывает метаданные события и записывает сообщение в журнал.The function reads event metadata and logs the message.

В приведенных ниже примерах показаны данные привязки Центров событий в файле function.json.The following examples show Event Hubs binding data in the function.json file.

{
  "type": "eventHubTrigger",
  "name": "event",
  "direction": "in",
  "eventHubName": "MyEventHub",
  "connection": "myEventHubReadConnectionAppSetting"
}

Ниже приведен код Python.Here's the Python code:

import logging
import azure.functions as func


def main(event: func.EventHubEvent):
    logging.info('Function triggered to process a message: ', event.get_body())
    logging.info('  EnqueuedTimeUtc =', event.enqueued_time)
    logging.info('  SequenceNumber =', event.sequence_number)
    logging.info('  Offset =', event.offset)

В следующем примере показана привязка триггера концентратора событий в файле Function. JSON и функция Java , которая использует эту привязку.The following example shows an Event Hub trigger binding in a function.json file and a Java function that uses the binding. Эта функция записывает в журнал текст сообщений триггера концентратора событий.The function logs the message body of the Event Hub trigger.

{
  "type": "eventHubTrigger",
  "name": "msg",
  "direction": "in",
  "eventHubName": "myeventhubname",
  "connection": "myEventHubReadConnectionAppSetting"
}

@FunctionName("ehprocessor")
public void eventHubProcessor(
  @EventHubTrigger(name = "msg",
                  eventHubName = "myeventhubname",
                  connection = "myconnvarname") String message,
       final ExecutionContext context )
       {
          context.getLogger().info(message);
 }

В библиотеке среды выполнения функций Java используйте заметку EventHubTrigger для параметров, значения которых будут поступать из концентратора событий.In the Java functions runtime library, use the EventHubTrigger annotation on parameters whose value would come from Event Hub. Параметры с этими заметками запускают функцию, когда происходит событие.Parameters with these annotations cause the function to run when an event arrives. Эта заметка может использоваться с собственными типами Java, объектами POJO или значениями, допускающими значения NULL, используя Optional<T>.This annotation can be used with native Java types, POJOs, or nullable values using Optional<T>.

В библиотеках классов C# используйте атрибут EventHubTriggerAttribute.In C# class libraries, use the EventHubTriggerAttribute attribute.

Конструктор атрибута принимает имя концентратора событий, имя группы потребителей и имя параметра приложения, содержащего строку подключения.The attribute's constructor takes the name of the event hub, the name of the consumer group, and the name of an app setting that contains the connection string. Дополнительные сведения об этих параметрах см. в разделе Привязки концентраторов событий функций Azure.For more information about these settings, see the trigger configuration section. Ниже приведен пример атрибута EventHubTriggerAttribute.Here's an EventHubTriggerAttribute attribute example:

[FunctionName("EventHubTriggerCSharp")]
public static void Run([EventHubTrigger("samples-workitems", Connection = "EventHubConnectionAppSetting")] string myEventHubMessage, ILogger log)
{
    ...
}

Полный пример см. в разделе Пример C# в триггере.For a complete example, see Trigger - C# example.

Атрибуты не поддерживаются C# сценарием.Attributes are not supported by C# Script.

Атрибуты не поддерживаются в JavaScript.Attributes are not supported by JavaScript.

Атрибуты не поддерживаются в Python.Attributes are not supported by Python.

В библиотеке времени выполнения функцийJava Используйте заметку EventHubTrigger в параметрах, значение которых поступает из концентратора событий.From the Java functions runtime library, use the EventHubTrigger annotation on parameters whose value would come from Event Hub. Параметры с этими заметками запускают функцию, когда происходит событие.Parameters with these annotations cause the function to run when an event arrives. Эта заметка может использоваться с собственными типами Java, объектами POJO или значениями, допускающими значения NULL, используя Optional<T>.This annotation can be used with native Java types, POJOs, or nullable values using Optional<T>.

В следующем примере показана функция C#, которая записывает сообщение в концентратор событий, используя возвращаемое значение метода в качестве выходных данных.The following example shows a C# function that writes a message to an event hub, using the method return value as the output:

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

В следующем примере показано, как использовать интерфейс IAsyncCollector для отправки пакета сообщений.The following example shows how to use the IAsyncCollector interface to send a batch of messages. Этот сценарий часто используется при обработке сообщений, поступающих из одного концентратора событий, и при отправке результата в другой концентратор событий.This scenario is common when you are processing messages coming from one Event Hub and sending the result to another Event Hub.

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

        // then send the message
        await outputEvents.AddAsync(JsonConvert.SerializeObject(myProcessedEvent));
    }
}

В следующем примере показаны привязка триггера концентратора событий в файле function.json и функция сценария C#, которая использует эту привязку.The following example shows an event hub trigger binding in a function.json file and a C# script function that uses the binding. Эта функция записывает сообщение в концентратор событий.The function writes a message to an event hub.

В приведенных ниже примерах показаны данные привязки Центров событий в файле function.json.The following examples show Event Hubs binding data in the function.json file. Первый пример — для функций 2. x и более поздних, а второй — для функций 1. x.The first example is for Functions 2.x and higher, and the second one is for Functions 1.x.

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

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

Ниже приведен код сценария C#, который создает одно сообщение.Here's C# script code that creates one message:

using System;
using Microsoft.Extensions.Logging;

public static void Run(TimerInfo myTimer, out string outputEventHubMessage, ILogger log)
{
    String msg = $"TimerTriggerCSharp1 executed at: {DateTime.Now}";
    log.LogInformation(msg);   
    outputEventHubMessage = msg;
}

Ниже приведен код сценария C#, который создает несколько сообщений.Here's C# script code that creates multiple messages:

public static void Run(TimerInfo myTimer, ICollector<string> outputEventHubMessage, ILogger log)
{
    string message = $"Message created at: {DateTime.Now}";
    log.LogInformation(message);
    outputEventHubMessage.Add("1 " + message);
    outputEventHubMessage.Add("2 " + message);
}

В следующем примере показаны привязка триггера концентратора событий в файле function.json и функция JavaScript, которая использует эту привязку.The following example shows an event hub trigger binding in a function.json file and a JavaScript function that uses the binding. Эта функция записывает сообщение в концентратор событий.The function writes a message to an event hub.

В приведенных ниже примерах показаны данные привязки Центров событий в файле function.json.The following examples show Event Hubs binding data in the function.json file. Первый пример — для функций 2. x и более поздних, а второй — для функций 1. x.The first example is for Functions 2.x and higher, and the second one is for Functions 1.x.

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

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

Ниже приведен код JavaScript, который отправляет отдельное сообщение.Here's JavaScript code that sends a single message:

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

Ниже приведен код JavaScript, который отправляет несколько сообщений.Here's JavaScript code that sends multiple messages:

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

В следующем примере показаны привязка триггера концентратора событий в файле function.json и функция Python, которая использует эту привязку.The following example shows an event hub trigger binding in a function.json file and a Python function that uses the binding. Эта функция записывает сообщение в концентратор событий.The function writes a message to an event hub.

В приведенных ниже примерах показаны данные привязки Центров событий в файле function.json.The following examples show Event Hubs binding data in the function.json file.

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

Ниже приведен код Python, который отправляет отдельное сообщение.Here's Python code that sends a single message:

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)

В следующем примере показана функция Java, которая записывает сообщение, содержащее текущее время, в концентратор событий.The following example shows a Java function that writes a message containing the current time to an Event Hub.

@FunctionName("sendTime")
@EventHubOutput(name = "event", eventHubName = "samples-workitems", connection = "AzureEventHubConnection")
public String sendTime(
   @TimerTrigger(name = "sendTimeTrigger", schedule = "0 */5 * * * *") String timerInfo)  {
     return LocalDateTime.now().toString();
 }

В библиотеке среды выполнения функций Java используйте заметку @EventHubOutput для параметров, значения которых будут опубликованы в концентраторе событий.In the Java functions runtime library, use the @EventHubOutput annotation on parameters whose value would be published to Event Hub. Параметр должен быть типа OutputBinding<T>, где T — POJO или любой собственный тип Java.The parameter should be of type OutputBinding<T> , where T is a POJO or any native Java type.

В библиотеках классов C# используйте атрибут EventHubAttribute.For C# class libraries, use the EventHubAttribute attribute.

Конструктор атрибута принимает имя концентратора событий и имя параметра приложения, содержащего строку подключения.The attribute's constructor takes the name of the event hub and the name of an app setting that contains the connection string. Дополнительные сведения об этих параметрах см. в разделе Привязки концентраторов событий функций Azure.For more information about these settings, see Output - configuration. Ниже приведен пример атрибута EventHub.Here's an EventHub attribute example:

[FunctionName("EventHubOutput")]
[return: EventHub("outputEventHubMessage", Connection = "EventHubConnectionAppSetting")]
public static string Run([TimerTrigger("0 */5 * * * *")] TimerInfo myTimer, ILogger log)
{
    ...
}

Полный пример см. в разделе Пример выходных данных C#.For a complete example, see Output - C# example.

Атрибуты не поддерживаются C# сценарием.Attributes are not supported by C# Script.

Атрибуты не поддерживаются в JavaScript.Attributes are not supported by JavaScript.

Атрибуты не поддерживаются в Python.Attributes are not supported by Python.

В библиотеке времени выполнения функций Javaиспользуйте аннотацию евенсубаутпут в параметрах, значение которых будет опубликовано в концентраторе событий.In the Java functions runtime library, use the EventHubOutput annotation on parameters whose value would be published to Event Hub. Параметр должен иметь тип OutputBinding<T>, где T является POJO или любым собственным типом Java.The parameter should be of type OutputBinding<T> , where T is a POJO or any native Java type.

Отправка сообщений с помощью параметра метода, например out string paramName.Send messages by using a method parameter such as out string paramName. В скрипте C# paramName — это значение, заданное в свойстве name файла function.json.In C# script, paramName is the value specified in the name property of function.json. Для записи нескольких сообщений можно использовать ICollector<string> или IAsyncCollector<string> вместо out string.To write multiple messages, you can use ICollector<string> or IAsyncCollector<string> in place of out string.

Отправка сообщений с помощью параметра метода, например out string paramName.Send messages by using a method parameter such as out string paramName. В скрипте C# paramName — это значение, заданное в свойстве name файла function.json.In C# script, paramName is the value specified in the name property of function.json. Для записи нескольких сообщений можно использовать ICollector<string> или IAsyncCollector<string> вместо out string.To write multiple messages, you can use ICollector<string> or IAsyncCollector<string> in place of out string.

Получите доступ к выходному событию с помощью context.bindings.<name>, где <name> — это значение, указанное в свойстве name файла Function. JSON.Access the output event by using context.bindings.<name> where <name> is the value specified in the name property of function.json.

Существует два варианта вывода сообщения концентратора событий из функции:There are two options for outputting an Event Hub message from a function:

• Возвращаемое значение: задайте $returnдля свойства name в Function. JSON .Return value: Set the name property in function.json to $return. В этой конфигурации возвращаемое значение функции сохраняется как сообщение концентратора событий.With this configuration, the function's return value is persisted as an Event Hub message.

• Императив: передайте значение в метод Set параметра, объявленного как тип out .Imperative: Pass a value to the set method of the parameter declared as an Out type. Значение, передаваемое в set, сохраняется как сообщение концентратора событий.The value passed to set is persisted as an Event Hub message.

Существует два варианта вывода сообщения концентратора событий из функции с помощью аннотации евенсубаутпут :There are two options for outputting an Event Hub message from a function by using the EventHubOutput annotation:

• Возвращаемое значение: применяя заметку к самой функции, возвращаемое значение функции сохраняется как сообщение концентратора событий.Return value: By applying the annotation to the function itself, the return value of the function is persisted as an Event Hub message.

• Императивное: чтобы явно задать значение сообщения, примените заметку к конкретному параметру типа OutputBinding<T>, где T является POJO или любым собственным типом Java.Imperative: To explicitly set the message value, apply the annotation to a specific parameter of the type OutputBinding<T>, where T is a POJO or any native Java type. При такой конфигурации передача значения методу setValue сохраняет значение как сообщение концентратора событий.With this configuration, passing a value to the setValue method persists the value as an Event Hub message.