SubscriptionDescription Class

Definition

Represents the metadata description of the subscription.

public class SubscriptionDescription : IEquatable<Microsoft.Azure.ServiceBus.Management.SubscriptionDescription>
type SubscriptionDescription = class
    interface IEquatable<SubscriptionDescription>
Public Class SubscriptionDescription
Implements IEquatable(Of SubscriptionDescription)
Inheritance
SubscriptionDescription
Implements

Constructors

SubscriptionDescription(String, String)

Initializes a new instance of SubscriptionDescription class with the specified name and topic path.

Properties

AutoDeleteOnIdle

The TimeSpan idle interval after which the subscription is automatically deleted.

DefaultMessageTimeToLive

The default time to live value for the messages. This is the duration after which the message expires, starting from when the message is sent to Service Bus.

EnableBatchedOperations

Indicates whether server-side batched operations are enabled.

EnableDeadLetteringOnFilterEvaluationExceptions

indicates whether messages need to be forwarded to dead-letter sub queue when subscription rule evaluation fails.

EnableDeadLetteringOnMessageExpiration

Indicates whether this subscription has dead letter support when a message expires.

ForwardDeadLetteredMessagesTo

The path of the recipient entity to which all the dead-lettered messages of this subscription are forwarded to.

ForwardTo

The path of the recipient entity to which all the messages sent to the subscription are forwarded to.

LockDuration

Duration of a peek lock receive. i.e., the amount of time that the message is locked by a given receiver so that no other receiver receives the same message.

MaxDeliveryCount

The maximum delivery count of a message before it is dead-lettered.

RequiresSession

This indicates whether the subscription supports the concept of session. Sessionful-messages follow FIFO ordering.

Status

The current status of the subscription (Enabled / Disabled).

SubscriptionName

Name of the subscription.

TopicPath

Path of the topic under which subscription exists.

UserMetadata

Custom metdata that user can associate with the description.

Methods

Equals(Object)
Equals(SubscriptionDescription)
GetHashCode()

Operators

Equality(SubscriptionDescription, SubscriptionDescription)
Inequality(SubscriptionDescription, SubscriptionDescription)

Applies to