Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

SendEventOptions Class

Definition

Namespace:
Azure.Messaging.EventHubs.Producer
Assembly:
Azure.Messaging.EventHubs.dll
Package:
Azure.Messaging.EventHubs v5.12.2
Package:
Azure.Messaging.EventHubs v5.12.0-beta.2
Source:
SendEventOptions.cs
Source:
SendEventOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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
SendEventOptions
Derived

Constructors

Name Description
SendEventOptions()

Initializes a new instance of the SendEventOptions class.

Properties

Name Description
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


Feedback

Was this page helpful?