Share via

ServiceBusMessage.PartitionKey Property

  • Reference

Definition

Namespace:
Azure.Messaging.ServiceBus
Assembly:
Azure.Messaging.ServiceBus.dll
Package:
Azure.Messaging.ServiceBus v7.18.2
Package:
Azure.Messaging.ServiceBus v7.18.0-beta.1
Source:
ServiceBusMessage.cs
Source:
ServiceBusMessage.cs

Gets or sets a partition key for sending a message to a partitioned entity.

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

Property Value

String

The partition key. Maximum length is 128 characters.

Remarks

For partitioned entities, setting this value enables assigning related messages to the same internal partition, so that submission sequence order is correctly recorded. The partition is chosen by a hash function over this value and cannot be chosen directly. For session-aware entities, the SessionId property overrides this value.

Applies to