You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Azure Event Hubs client library for .NET - version 5.9.2
11
+
# Azure Event Hubs client library for .NET - version 5.9.3
12
12
13
13
14
14
Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers. 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. If you would like to know more about Azure Event Hubs, you may wish to review: [What is Event Hubs](/azure/event-hubs/event-hubs-about).
@@ -23,7 +23,7 @@ The Azure Event Hubs client library allows for publishing and consuming of Azure
23
23
24
24
- Receive events from one or more publishers, transform them to better meet the needs of your ecosystem, then publish the transformed events to a new stream for consumers to observe.
@@ -38,7 +38,7 @@ The Azure Event Hubs client library allows for publishing and consuming of Azure
38
38
Visual Studio users wishing to take full advantage of the C# 8.0 syntax will need to use Visual Studio 2019 or later. Visual Studio 2019, including the free Community edition, can be downloaded [here](https://visualstudio.microsoft.com). Users of Visual Studio 2017 can take advantage of the C# 8 syntax by making use of the [Microsoft.Net.Compilers NuGet package](https://www.nuget.org/packages/Microsoft.Net.Compilers/) and setting the language version, though the editing experience may not be ideal.
39
39
40
40
You can still use the library with previous C# language versions, but will need to manage asynchronous enumerable and asynchronous disposable members manually rather than benefiting from the new syntax. You may still target any framework version supported by your .NET Core SDK, including earlier versions of .NET Core or the .NET framework. For more information, see: [how to specify target frameworks](/dotnet/standard/frameworks#how-to-specify-target-frameworks).
41
-
**Important Note:** In order to build or run the [examples](#examples) and the [samples](#next-steps) without modification, use of C# 11.0 is necessary. You can still run the samples if you decide to tweak them for other language versions. An example of doing so is available in the sample: [Earlier Language Versions](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample07_EarlierLanguageVersions.md).
41
+
**Important Note:** In order to build or run the [examples](#examples) and the [samples](#next-steps) without modification, use of C# 11.0 is necessary. You can still run the samples if you decide to tweak them for other language versions. An example of doing so is available in the sample: [Earlier Language Versions](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample07_EarlierLanguageVersions.md).
42
42
43
43
To quickly create a basic set of Event Hubs resources in Azure and to receive a connection string for them, you can deploy our sample template by clicking:
44
44
@@ -69,7 +69,7 @@ var eventHubName = "<< NAME OF THE EVENT HUB >>";
For examples of authenticating the Event Hubs clients with credential types, see [Using an Azure Active Directory (AAD) principal](#using-an-active-directory-principal-with-the-event-hub-clients) or the [Identity and Shared Access Credentials](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample06_IdentityAndSharedAccessCredentials.md) sample.
72
+
For examples of authenticating the Event Hubs clients with credential types, see [Using an Azure Active Directory (AAD) principal](#using-an-active-directory-principal-with-the-event-hub-clients) or the [Identity and Shared Access Credentials](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample06_IdentityAndSharedAccessCredentials.md) sample.
73
73
74
74
For examples of authenticating the Event Hubs clients for an ASP.NET Core application, see [Registering with ASP.NET Core dependency injection](#registering-with-aspnet-core-dependency-injection).
75
75
@@ -100,8 +100,8 @@ The data model types, such as `EventData` and `EventDataBatch` are not thread-sa
@@ -154,7 +154,7 @@ await using (var producer = new EventHubProducerClient(connectionString, eventHu
154
154
155
155
In order to read events from an Event Hub, you'll need to create an `EventHubConsumerClient` for a given consumer group. When an Event Hub is created, it provides a default consumer group that can be used to get started with exploring Event Hubs. In our example, we will focus on reading all events that have been published to the Event Hub using an iterator.
156
156
157
-
**Note:** It is important to note that this approach to consuming is intended to improve the experience of exploring the Event Hubs client library and prototyping. It is recommended that it not be used in production scenarios. For production use, we recommend using the [Event Processor Client](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs.Processor), as it provides a more robust and performant experience.
157
+
**Note:** It is important to note that this approach to consuming is intended to improve the experience of exploring the Event Hubs client library and prototyping. It is recommended that it not be used in production scenarios. For production use, we recommend using the [Event Processor Client](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs.Processor), as it provides a more robust and performant experience.
158
158
159
159
```C# Snippet:EventHubs_ReadMe_Read
160
160
varconnectionString="<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>";
@@ -215,7 +215,7 @@ await using (var consumer = new EventHubConsumerClient(consumerGroup, connection
215
215
216
216
### Process events using an Event Processor client
217
217
218
-
For the majority of production scenarios, it is recommended that the [Event Processor Client](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs.Processor) be used for reading and processing events. The processor is intended to provide a robust experience for processing events across all partitions of an Event Hub in a performant and fault tolerant manner while providing a means to persist its state. Event Processor clients are also capable of working cooperatively within the context of a consumer group for a given Event Hub, where they will automatically manage distribution and balancing of work as instances become available or unavailable for the group.
218
+
For the majority of production scenarios, it is recommended that the [Event Processor Client](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs.Processor) be used for reading and processing events. The processor is intended to provide a robust experience for processing events across all partitions of an Event Hub in a performant and fault tolerant manner while providing a means to persist its state. Event Processor clients are also capable of working cooperatively within the context of a consumer group for a given Event Hub, where they will automatically manage distribution and balancing of work as instances become available or unavailable for the group.
219
219
220
220
Since the `EventProcessorClient` has a dependency on Azure Storage blobs for persistence of its state, you'll need to provide a `BlobContainerClient` for the processor, which has been configured for the storage account and container that should be used.
221
221
@@ -266,11 +266,11 @@ finally
266
266
}
267
267
```
268
268
269
-
More details can be found in the Event Processor Client [README](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs.Processor/README.md) and the accompanying [samples](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs.Processor/samples).
269
+
More details can be found in the Event Processor Client [README](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs.Processor/README.md) and the accompanying [samples](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs.Processor/samples).
270
270
271
271
### Using an Active Directory principal with the Event Hub clients
272
272
273
-
The [Azure Identity library](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/identity/Azure.Identity/README.md) provides Azure Active Directory (AAD) authentication support which can be used for the Azure client libraries, including Event Hubs.
273
+
The [Azure Identity library](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/identity/Azure.Identity/README.md) provides Azure Active Directory (AAD) authentication support which can be used for the Azure client libraries, including Event Hubs.
274
274
275
275
To make use of an Active Directory principal, one of the available credentials from the `Azure.Identity` library is specified when creating the Event Hubs client. In addition, the fully qualified Event Hubs namespace and the name of desired Event Hub are supplied in lieu of the Event Hubs connection string. For illustration, the `EventHubProducerClient` is demonstrated in these examples, but the concept and form are common across clients.
276
276
@@ -357,19 +357,19 @@ For more details, see [Dependency injection with the Azure SDK for .NET](/dotnet
357
357
358
358
## Troubleshooting
359
359
360
-
For detailed troubleshooting information, please refer to the [Event Hubs Troubleshooting Guide](https://github.com/Azure/azure-sdk-for-net/tree/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs/TROUBLESHOOTING.md).
360
+
For detailed troubleshooting information, please refer to the [Event Hubs Troubleshooting Guide](https://github.com/Azure/azure-sdk-for-net/tree/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs/TROUBLESHOOTING.md).
361
361
362
362
### Logging and diagnostics
363
363
364
364
The Event Hubs client library is fully instrumented for logging information at various levels of detail using the .NET `EventSource` to emit information. Logging is performed for each operation and follows the pattern of marking the starting point of the operation, it's completion, and any exceptions encountered. Additional information that may offer insight is also logged in the context of the associated operation.
365
365
366
-
The Event Hubs client logs are available to any `EventListener` by opting into the source named "Azure-Messaging-EventHubs" or opting into all sources that have the trait "AzureEventSource". To make capturing logs from the Azure client libraries easier, the `Azure.Core` library used by Event Hubs offers an `AzureEventSourceListener`. More information can be found in [Capturing Event Hubs logs using the AzureEventSourceListener](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample10_AzureEventSourceListener.md).
366
+
The Event Hubs client logs are available to any `EventListener` by opting into the source named "Azure-Messaging-EventHubs" or opting into all sources that have the trait "AzureEventSource". To make capturing logs from the Azure client libraries easier, the `Azure.Core` library used by Event Hubs offers an `AzureEventSourceListener`. More information can be found in [Capturing Event Hubs logs using the AzureEventSourceListener](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample10_AzureEventSourceListener.md).
367
367
368
-
The Event Hubs client library is also instrumented for distributed tracing using Application Insights or OpenTelemetry. More information can be found in the [Azure.Core Diagnostics sample](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/core/Azure.Core/samples/Diagnostics.md#distributed-tracing).
368
+
The Event Hubs client library is also instrumented for distributed tracing using Application Insights or OpenTelemetry. More information can be found in the [Azure.Core Diagnostics sample](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/core/Azure.Core/samples/Diagnostics.md#distributed-tracing).
369
369
370
370
## Next steps
371
371
372
-
Beyond the introductory scenarios discussed, the Azure Event Hubs client library offers support for additional scenarios to help take advantage of the full feature set of the Azure Event Hubs service. In order to help explore some of these scenarios, the Event Hubs client library offers a project of samples to serve as an illustration for common scenarios. Please see the samples [README](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs/samples/README.md) for details.
372
+
Beyond the introductory scenarios discussed, the Azure Event Hubs client library offers support for additional scenarios to help take advantage of the full feature set of the Azure Event Hubs service. In order to help explore some of these scenarios, the Event Hubs client library offers a project of samples to serve as an illustration for common scenarios. Please see the samples [README](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs/samples/README.md) for details.
373
373
374
374
## Contributing
375
375
@@ -379,7 +379,7 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
379
379
380
380
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
381
381
382
-
Please see our [contributing guide](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.2/sdk/eventhub/Azure.Messaging.EventHubs/CONTRIBUTING.md) for more information.
382
+
Please see our [contributing guide](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Messaging.EventHubs_5.9.3/sdk/eventhub/Azure.Messaging.EventHubs/CONTRIBUTING.md) for more information.
0 commit comments