EventData.CorrelationId Property

  • Reference

Definition

Namespace:
Azure.Messaging.EventHubs
Assembly:
Azure.Messaging.EventHubs.dll
Package:
Azure.Messaging.EventHubs v5.11.5
Package:
Azure.Messaging.EventHubs v5.12.0-beta.1
Source:
EventData.cs
Source:
EventData.cs

An application-defined value that represents the context to use for correlation across one or more operations. The identifier is a free-form value and may reflect a unique identity or a shared data element with significance to the application.

public string CorrelationId { get; set; }
member this.CorrelationId : string with get, set
Public Property CorrelationId As String

Property Value

String

Remarks

The CorrelationId is intended to enable tracing of data within an application, such as an event's path from producer to consumer.

Event Hubs does not read, generate, or populate this value. It does not influence Event Hubs telemetry, distributed tracing, or logging.

Applies to