Share via

EventData.PartitionKey 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

The partition hashing key applied to the batch that the associated EventData, was published with.

public string PartitionKey { get; }
member this.PartitionKey : string
Public ReadOnly Property PartitionKey As String

Property Value

String

This value is read-only and will only be populated for events that have been read from Event Hubs. The default value when not populated is null.

Remarks

To specify a partition key when publishing an event, specify your key in the SendEventOptions and use the SendAsync(IEnumerable<EventData>, SendEventOptions, CancellationToken) overload.

Applies to