☁️ .NET Standard client library for Azure Event Hubs
Clone or download

readme.md

Microsoft Azure Event Hubs

Microsoft Azure Event Hubs Client for .NET

Build/Package Status
master Build status codecov
dev Build status codecov
Microsoft.Azure.EventHubs NuGet Version and Downloads count
Microsoft.Azure.EventHubs.Processor NuGet Version and Downloads count

This library is built using .NET Standard 2.0. For more information on what platforms are supported see .NET Platforms Support.

Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them into multiple applications. This lets you process and analyze the massive amounts of data produced by your connected devices and applications. Once Event Hubs has collected the data, you can retrieve, transform and store it by using any real-time analytics provider or with batching/storage adapters.

Refer to the online documentation to learn more about Event Hubs in general.

How to provide feedback

See our Contribution Guidelines.

Overview

The .NET client library for Azure Event Hubs allows for both sending events to and receiving events from an Azure Event Hub.

An event publisher is a source of telemetry data, diagnostics information, usage logs, or other log data, as part of an embedded device solution, a mobile device application, a game title running on a console or other device, some client or server based business solution, or a web site.

An event consumer picks up such information from the Event Hub and processes it. Processing may involve aggregation, complex computation and filtering. Processing may also involve distribution or storage of the information in a raw or transformed fashion. Event Hub consumers are often robust and high-scale platform infrastructure parts with built-in analytics capabilites, like Azure Stream Analytics, Apache Spark, or Apache Storm.

Most applications will act either as an event publisher or an event consumer, but rarely both. The exception are event consumers that filter and/or transform event streams and then forward them on to another Event Hub; an example for such is Azure Stream Analytics.

FAQ

Where can I find examples that use this library?

https://github.com/Azure/azure-event-hubs/tree/master/samples

How to build client libraries on Visual Studio 2017?

Make sure you have .NET Core Cross-Platform Development SDK installed. If it is missing, you can install the SDK by running Visual Studio Installer. See https://www.microsoft.com/net/core#windowscmd for VS 2017 and SDK installation.

How do I run the unit tests?

In order to run the unit tests, you will need to do the following:

  1. Deploy the Azure Resource Manager template located at /build/azuredeploy.json by clicking the following button:

    Running the above template will provision an Event Hubs namespace along with the required entities to successfully run the unit tests.

  2. Add an Environment Variable named azure-event-hubs-dotnet/connectionstring and set the value as the connection string of the newly created namespace. Please note that if you are using Visual Studio, you must restart Visual Studio in order to use new Environment Variables.

  3. Add an Environment Variable named azure-event-hubs-dotnet/storageconnectionstring and set the value as the connection string of the newly created storage account.

Once you have completed the above, you can run dotnet test from the /test/Microsoft.Azure.EventHubs.Tests directory.

Can I manage Event Hubs entities with this library?

The standard way to manage Azure resources is by using Azure Resource Manager. In order to use functionality that previously existed in the .NET Framework Service Bus client library, you will need to use the Microsoft.Azure.Management.EventHub library. This will enable use cases that dynamically create/read/update/delete resources. The following links will provide more information on the new library and how to use it.