SendEventOptions Class

  • Reference

Definition

Namespace:
Azure.Messaging.EventHubs.Producer
Assembly:
Azure.Messaging.EventHubs.dll
Package:
Azure.Messaging.EventHubs v5.11.2
Source:
SendEventOptions.cs

The set of options that can be specified to influence the way in which events are published to the Event Hubs service.

public class SendEventOptions
type SendEventOptions = class
Public Class SendEventOptions
Inheritance
Object
SendEventOptions
Derived

Constructors

SendEventOptions()

Initializes a new instance of the SendEventOptions class.

Properties

PartitionId

If specified, events be published to this specific partition. If the identifier is not specified, Event Hubs will be responsible for assigning events automatically to an available partition.
PartitionKey

Allows a hashing key to be provided for the batch of events, which instructs Event Hubs to map the key to an automatically-assigned partition.

The selection of a partition is stable for a given partition key. Should any other events be published using the same exact partition key, Event Hubs will assign the same partition to them.

The partition key should be specified when there is a need to group events together, but the partition to which they are assigned is unimportant. If ensuring that a batch of events is assigned a specific partition, it is recommended that the PartitionId be assigned instead.

Applies to