EventData.GetRawAmqpMessage Method

  • 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 event representation in the AMQP protocol format. This allows access to protocol information that is not relevant to Event Hubs and is not exposed by EventData directly. This information can be helpful when exchanging data with other message brokers or clients that do not use one of the Event Hubs SDKs.

public Azure.Core.Amqp.AmqpAnnotatedMessage GetRawAmqpMessage ();
member this.GetRawAmqpMessage : unit -> Azure.Core.Amqp.AmqpAnnotatedMessage
Public Function GetRawAmqpMessage () As AmqpAnnotatedMessage

Returns

AmqpAnnotatedMessage

The event, as an AmqpAnnotatedMessage.

Remarks

Manipulating the raw AMQP message is an advanced operation recommended only for those with knowledge of the AMQP protocol and have a need outside of the normal operation of Event Hubs, such as inter-operating with another message broker.

When making direct changes to the AMQP message, it is possible to cause issues with the Event Hubs client library, such as invalidating the size calculations performed by the EventDataBatch resulting in a batch that cannot be successfully published.

Applies to