Azure.Messaging.ServiceBus Namespace - Azure for .NET Developers (original) (raw)
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
| Name | Description |
|---|---|
| CreateMessageBatchOptions | The set of options that can be specified to influence the way in which an service bus message batch behaves and is sent to the Queue/Topic. |
| MessageLockLostEventArgs | This type represents the event args relating to the message lock lost event. |
| ProcessErrorEventArgs | Contains information about the entity whose processing threw an exception, as well as the exception that has been thrown. |
| ProcessMessageEventArgs | The ProcessMessageEventArgs contain event args that are specific to the ServiceBusReceivedMessage that is being processed. |
| ProcessorReceiveActions | A set of receive-related actions that can be performed from the processor message callback. |
| ProcessSessionEventArgs | The ProcessSessionEventArgs contain event args related to the session being processed. |
| ProcessSessionMessageEventArgs | The ProcessSessionMessageEventArgs contain event args that are specific to the ServiceBusReceivedMessage and session that is being processed. |
| ServiceBusClient | The ServiceBusClient is the top-level client through which all Service Bus entities can be interacted with. Any lower level types retrieved from here, such as ServiceBusSender and ServiceBusReceiver will share the same AMQP connection. Disposing the ServiceBusClient will cause the AMQP connection to close. |
| ServiceBusClientOptions | The set of options that can be specified when creating an Azure.Messaging.ServiceBus.ServiceBusConnectionto configure its behavior. |
| ServiceBusConnectionStringProperties | The set of properties that comprise a Service Bus connection string. |
| ServiceBusException | Serves as a basis for exceptions produced within the Service Bus context. |
| ServiceBusMessage | The ServiceBusMessage is used to send data to Service Bus Queues and Topics. When receiving messages, the ServiceBusReceivedMessage is used. |
| ServiceBusMessageBatch | A set of ServiceBusMessage with size constraints known up-front, intended to be sent to the Queue/Topic as a single batch. A ServiceBusMessageBatch can be created usingCreateMessageBatchAsync(CancellationToken). Messages can be added to the batch using the TryAddMessage(ServiceBusMessage) method on the batch. |
| ServiceBusModelFactory | This class contains methods to create certain ServiceBus models. |
| ServiceBusProcessor | The ServiceBusProcessor provides an abstraction around a set of ServiceBusReceiverthat allows using an event based model for processing received ServiceBusReceivedMessage. It is constructed by calling CreateProcessor(String, ServiceBusProcessorOptions). The message handler is specified with the ProcessMessageAsyncproperty. The error handler is specified with the ProcessErrorAsync property. To start processing after the handlers have been specified, call StartProcessingAsync(CancellationToken). |
| ServiceBusProcessorOptions | The set of options that can be specified when creating aServiceBusProcessor to configure its behavior. |
| ServiceBusReceivedMessage | The ServiceBusReceivedMessage is used to receive data from Service Bus Queues and Subscriptions. When sending messages, the ServiceBusMessage is used. |
| ServiceBusReceiver | The ServiceBusReceiver is responsible for receivingServiceBusReceivedMessage and settling messages from Queues and Subscriptions. It is constructed by calling CreateReceiver(String, ServiceBusReceiverOptions). |
| ServiceBusReceiverOptions | The set of options that can be specified when creating a ServiceBusReceiverto configure its behavior. |
| ServiceBusRetryOptions | The set of options that can be specified to influence how retry attempts are made, and a failure is eligible to be retried. |
| ServiceBusRetryPolicy | An abstract representation of a policy to govern retrying of messaging operations. |
| ServiceBusRuleManager | The ServiceBusRuleManager allows rules for a subscription to be managed. The rule manager requires only Listen claims, whereas the ServiceBusAdministrationClient requires Manage claims. |
| ServiceBusSender | A client responsible for sending ServiceBusMessage to a specific Service Bus entity (Queue or Topic). It can be used for both session and non-session entities. It is constructed by calling CreateSender(String). |
| ServiceBusSenderOptions | The set of options that can be specified when creating a ServiceBusSenderto configure its behavior. |
| ServiceBusSessionProcessor | The ServiceBusSessionProcessor provides an abstraction around a set of ServiceBusSessionReceiver that allows using an event based model for processing received ServiceBusReceivedMessage. It is constructed by calling CreateSessionProcessor(String, ServiceBusSessionProcessorOptions). The message handler is specified with the ProcessMessageAsyncproperty. The error handler is specified with the ProcessErrorAsync property. To start processing after the handlers have been specified, call StartProcessingAsync(CancellationToken). |
| ServiceBusSessionProcessorOptions | The set of options that can be specified when creating aServiceBusSessionProcessor to configure its behavior. |
| ServiceBusSessionReceiver | The ServiceBusSessionReceiver is responsible for receiving ServiceBusReceivedMessageand settling messages from session-enabled Queues and Subscriptions. It is constructed by callingAcceptNextSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken). |
| ServiceBusSessionReceiverOptions | The set of options that can be specified when creating a ServiceBusSessionReceiverto configure its behavior. |
| SessionLockLostEventArgs | This type represents the event args relating to the session lock lost event. |
Enums
| Name | Description |
|---|---|
| ServiceBusErrorSource | The source of the error when ProcessErrorEventArgs is raised. |
| ServiceBusFailureReason | The set of well-known reasons for an Service Bus operation failure that was the cause of an exception. |
| ServiceBusMessageState | Represents the message state of the ServiceBusReceivedMessage |
| ServiceBusReceiveMode | The mode in which to receive messages. |
| ServiceBusRetryMode | The type of approach to apply when calculating the delay between retry attempts. |
| ServiceBusTransportType | Specifies the type of protocol and transport that will be used for communicating with Azure Service Bus. |
| SubQueue | Represents the possible system subqueues that can be received from. |