Microsoft.ServiceBus.Messaging Namespace
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.
Classes
AllowRule |
Represents the rule to allow. |
AuthorizationRule |
Defines the Azure Service Bus authorization rule that is used to determine whether an operation is permissible or not. |
AuthorizationRules |
Represents a collection of AuthorizationRule. |
BrokeredMessage |
Represents the unit of communication between Service Bus clients. |
BrokeredMessageProperty |
Represents the property bag for a BrokeredMessage. |
ClientAffineProperties | |
ClientEntity |
A data structure that represents the events sent and received from an Event Hub stream. |
ConsumerGroupDescription |
Represents a description of the consumer group. |
CorrelationFilter |
Represents the correlation filter expression. |
DefaultEventProcessorFactory<T> |
Represents the factory for the default event processor. |
DuplicateMessageException |
Exception for signaling message duplicate errors. |
EntityDescription |
Represents the description of an entity. |
EntityMetadataUpdatedException |
Thrown if entity metadata has changed. |
EventData |
Represents the event sent and received from an Event Hubs stream. It contains the body of the event, a user-defined property bag, and various metadata describing the event, such as its offset in the partition and its number in the stream sequence. Partitions are filled with a sequence of event data. |
EventDataBatch |
A helper class for creating a batch of EventData objects to be used for SendBatch or SendBatchAsync call. |
EventDataSystemPropertyNames |
Provides the names (as fields) of all the system properties that Service Bus automatically updates. |
EventHubClient |
An anchor class used to send and receive events to and from an Event Hub. |
EventHubConsumerGroup |
Represents the consumer group within an Event Hub. This class creates receivers for a specific consumer group within an Event Hub. This can be the default consumer group or another user-created consumer group. |
EventHubDescription |
Represents the metadata description of an Event Hub. |
EventHubReceiver |
A client class used in receive operations related to an Event Hub consumer group. Represents a logical receiver connection to a specific Event Hub partition within a consumer group. |
EventHubRuntimeInformation |
Returns Event Hubs runtime information, which is required for creating EventHubSender or EventHubReceiver objects. |
EventHubSender |
A client class used in send operations for an Event Hub. Represents a logical sender connection to a specific Event Hub partition. |
EventPosition |
Defines a position of an EventData in the event hub partition. The position can be one of Offset, SequenceNumber or EnqueuedTimeUtc. |
EventProcessorFaultedEventArgs | |
EventProcessorHost |
A very simple host for processing EventHub messages. It takes care of distributing EventHub partitions among EventProcessorHost instances. It creates an Azure Block Blob for each partition in EventHub and use these blobs for managing lease for a partition. Every EventProcessorHost instance is performing the following two tasks: 1) Renew Leases: It keeps track of leases currently owned by the host and continuously keeps on renewing the leases. 2) Acquire Leases: Each instance continuously polls all the lease blobs to check if there are any leases it should acquire for the system to get into balanced state. Client application needs to implement IEventProcessor and register processor implementation with EventProcessorHost. |
EventProcessorOptions |
Defines the runtime options when registering an IEventProcessor interface with an EventHubConsumerGroup. This is also the mechanism for catching exceptions from an IEventProcessor instance used by an EventProcessorHost object. |
ExceptionReceivedEventArgs |
Provides data for the ExceptionReceived event. |
FalseFilter |
Represents the false filter expression. |
Filter |
Describes a filter expression that is evaluated against a BrokeredMessage. |
FilterException |
The exception that is thrown for signaling filter action errors. |
InternalServerErrorException | |
IpFilterAuthorizationRule | |
Lease |
Contains partition ownership information. |
LeaseCannotBeAcquiredException | |
LeaseLostException |
Represents an exception that occurs when the service lease has been lost. |
ManagementStrings |
Provides string constants used in Microsoft Azure Service Bus Messaging. |
MessageCountDetails |
This class contains properties that enable you to retrieve details of messages from sub-queues of primary messaging entities (queues, topics, subscriptions). |
MessageLockLostException |
The exception that is thrown to signal message lock lost errors. |
MessageNotFoundException |
The exception that is thrown to signal message not found errors. |
MessageReceiver |
The MessageReceiver class is used to receive messages from the message container and acknowledge them. |
MessageSender |
The MessageSender class is used to send messages from the Service Bus. |
MessageSession |
Represents a message session that allows grouping of related messages for processing in a single transaction. |
MessageSessionAsyncHandler |
Represents the asynchronous handler associated with the message session. |
MessageSessionHandler |
Represents the handler associated with the message session. |
MessageSizeExceededException |
Represents an exception occurred when the size of the message exceeded the maximum allowed size. |
MessageStoreLockLostException |
Represents the exception that is thrown for signaling message store lock lost errors. |
MessagingCommunicationException |
The exception that is thrown to signal messaging communication errors. |
MessagingEntityAlreadyExistsException |
Represents the exception that is thrown for signaling messaging entity already exists errors. |
MessagingEntityClient |
This is the base abstract class that all clients for messsaging entities like topics, queues, and subscriptions. |
MessagingEntityDisabledException |
Exception for signaling messaging entity disabled errors. |
MessagingEntityNotFoundException |
The exception that is thrown for signaling messaging entity not found errors. |
MessagingException |
Represents the exception that is thrown for signaling messaging errors. |
MessagingExceptionDetail |
Provides the details of the messaging exception. |
MessagingExceptionHelper | |
MessagingFactory |
The MessagingFactory class is the anchor class used for run time operations to send and receive to and from queues, topics, or subscriptions. |
MessagingFactorySettings |
Represents the messaging factory settings. |
NamespaceInfo |
Represents metadata related to a messaging namespace. |
NetMessagingBinding |
Represents the binding that is used for net messaging. |
NetMessagingTransportBindingElement |
Represents the binding element used to specify a net messaging transport for transmitting messages on the Service Bus. |
NetMessagingTransportSettings |
Represents .NET messaging transport settings. |
NoMatchingSubscriptionException |
The exception that is thrown when subscription matching resulted no match. |
OnMessageOptions |
Provides options associated with message pump processing using OnMessage(Action<BrokeredMessage>) and OnMessage(Action<BrokeredMessage>). |
OnShardMessageOptions |
Represents the available options for the shard message. |
PairedMessagingFactoryException |
Represents the exception occurred for the paired messaging factory. |
PairedNamespaceEventArgs |
Represents the event arguments associated with paired namespace for the service bus messaging. |
PairedNamespaceOptions |
Represents the options for the paired namespace for the service bus messaging. |
PartitionContext |
Encapsulates information related to an Event Hubs partition used by IEventProcessor. |
PartitionDescription |
Represents the metadata and approximate runtime information for a logical partition of an Event Hub. |
PartitionManagerOptions |
Options to control various aspects of partition distribution happening within EventProcessorHost instance. |
PartitionNotOwnedException |
Represents the exception that is thrown for signaling partition not owned errors. |
PartitionRuntimeInformation |
Represents the approximate runtime information for a logical partition of an Event Hub. |
PrivateEndpointAuthorizationRule | |
PublisherRevokedException |
Exception for signaling revoked publisher errors. |
QueueClient |
Represents the queue client object. |
QueueDescription |
Represents the metadata description of the queue. |
QuotaExceededException |
The exception that is thrown for signaling quota exceeded errors. |
ReceiverDisconnectedException |
This exception is thrown if two or more EventHubReceiver objects connect to the same Event Hubs partition with different epoch values. |
ReceiverOptions |
Represents options can be set during the creation of a event hub receiver. |
ReceiverRuntimeInfo |
Represents the approximate receiver runtime information for a logical partition of an Event Hub. |
RelayDescription |
Represents a WCF Relay description. |
RevokedPublisherDescription | |
RuleAction |
Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. |
RuleActionException |
The exception that is thrown for signaling filter action errors and is thrown when a filter related operation fails. |
RuleDescription |
Represents a description of a rule. |
SendAvailabilityBacklogException |
Represents the exception occurred during the sending of availability backlogs. |
SendAvailabilityMessagingException |
Represents the exceptions occurred during the sending the availability for the messaging. |
SendAvailabilityPairedNamespaceOptions |
Represents the options for the sending the availability of paired namespace. |
ServerBusyException |
Represents the exception that is thrown when a server is overloaded with logical operations. |
SessionCannotBeLockedException |
Represents the exception that is thrown when a message cannot acquire lock on a session. |
SessionHandlerOptions |
Represents the options for the session handler. |
SessionLockLostException |
The exception that is thrown to signal session lock lost errors.In the case of partitioned messaging entities, partitions sometimes move to achieve load balancing across Service Bus nodes; for example, when a node restarts or new nodes are added to share the load. When that happens, session locks can be lost, but messages are never lost. If a partition moves after the session is locked, then the acknowledge/complete message processing call fails, because the lock is lost. However, the message remains and you can try to read it again. Thus, you may receive a SessionLockLostException exception even though the message itself is not lost. In this case, you can retry the message processing operation. |
SharedAccessAuthorizationRule |
Defines the authorization rule for shared access operation. |
SqlFilter |
Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. |
SqlRuleAction |
Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage. |
SubscriptionClient |
Represents the anchor class used in run-time operations related to a topic subscription. |
SubscriptionDescription |
Represents a description of the subscription. |
TopicClient |
An anchor class used to access a TopicDescription to perform run-time operations. |
TopicDescription |
Represents a description of the topic. |
TransactionSizeExceededException |
Represents an exception when the transaction size exceeds. |
TrueFilter |
Matches a filter expression. |
VirtualNetworkAuthorizationRule |
Interfaces
ICheckpointManager |
Provides methods for running checkpoint asynchronously. Extensibility is provided to specify host-specific storage for storing the offset. This is provided when RegisterProcessorAsync<T>(Lease, ICheckpointManager) is called, to checkpoint the offset position using CheckpointAsync(EventData). |
IEventProcessor |
Provides methods for event processors. Applications must implement this interface, which enables the handling of events from Event Hubs. This interface is the main extensibility point for the EventProcessorHost and RegisterProcessor<T>(Lease, ICheckpointManager). |
IEventProcessorFactory |
An interface that provides a factory for creating instances of IEventProcessor. |
IMessageSessionAsyncHandler |
Represents an interface for the asynchronous handler for the message session. |
IMessageSessionAsyncHandlerFactory |
Represents an interface for the handler factory associated with the message session. |
IMessageSessionHandler |
Represents an interface for the handler associated with the message session. |
IMessageSessionHandlerFactory |
Represents an interface for the handler factory associated with the message session. |
Enums
AccessCheckResult | |
AccessRights |
Specifies the possible access rights for a user. |
AllowRuleClaimType |
Specifies an enumeration of AllowRuleClaim type. |
CloseReason |
Enumerates the reason for closing of session. |
CursorType |
Enumerates the type of messaging cursor. |
EntityAvailabilityStatus |
Enumerates the status of the entity availability. |
EntityStatus |
Enumerates the possible values for the status of a messaging entity. |
IpFilterActionType |
Represent the type of action the ip that match the IpFilter is applied to. |
MessageState |
Enumerates a message state. |
MessagingExceptionDetail.ErrorLevelType |
Enumerates the types of error level for the messaging communication. |
MessagingSKUs |
Specifies the SKU of the messaging namespace. |
ReceiveMode |
Enumerates the values for the receive mode. The default is PeekLock. |
TileType |
Enumerates types of messaging tile. |
ToastType |
Enumerates the types of image and text for toast notification. |
TransportType |
An enumeration that sets the messaging protocol to either NetMessaging (a proprietary protocol to Azure Service Bus) or AMQP (an industry standard). |