SALES: 1-800-867-1380

SubscriptionDescription Class

Represents a description of the subscription.


Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

[DataContractAttribute(Name = "SubscriptionDescription", Namespace = "")]
public sealed class SubscriptionDescription : EntityDescription

The SubscriptionDescription type exposes the following members.

Public methodSubscriptionDescriptionInitializes a new instance of the SubscriptionDescription class.

Public propertyAccessedAtGets the last time a there was a receive request to this subscription.
Public propertyAutoDeleteOnIdleGets or sets the TimeSpan idle interval after which the subscription is automatically deleted. The minimum duration is 5 minutes.
Public propertyAvailabilityStatusGets the entity availability status for the messaging.
Public propertyCreatedAtGets the exact time the message was created.
Public propertyDefaultMessageTimeToLiveGets or sets the default message time to live value. This is the duration after which the message expires, starting from when the message is sent to the Service Bus. This is the default value used when TimeToLive is not set on a message itself.Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages.A message can have a lower TimeToLive value than that specified here, but by default TimeToLive is set to MaxValue. Therefore, this property becomes the default time to live value applied to messages.
Public propertyEnableBatchedOperationsGets or sets a value that indicates whether the batched operations are enabled.
Public propertyEnableDeadLetteringOnFilterEvaluationExceptionsGets or sets the value that indicates if a subscription has dead letter support on Filter evaluation exceptions.
Public propertyEnableDeadLetteringOnMessageExpirationGets or sets the value that indicates if a subscription has dead letter support when a message expires.
Public propertyExtensionDataGets or sets the structure that contains extra data. (Inherited from EntityDescription.)
Public propertyForwardDeadLetteredMessagesToGets or sets the path to the recipient to which the dead lettered messages are forwarded.
Public propertyForwardToGets or sets the path to the recipient to which the message is forwarded.
Public propertyIsReadOnlyGets or sets a value that indicates whether the entity description is read-only. (Inherited from EntityDescription.)
Public propertyLockDurationGets or sets the lock duration time span for the subscription.
Public propertyMaxDeliveryCountGets or sets the number of maximum deliveries.
Public propertyMessageCountGets the number of messages.
Public propertyMessageCountDetailsGets message details about the subscription.
Public propertyNameGets the name of the subscription description.
Public propertyRequiresSessionGets or sets the value indicating if a subscription supports the concept of session.
Public propertyStatusGets or sets the current status of the subscription (enabled or disabled). When an entity is disabled, that entity cannot send or receive messages.
Public propertyTopicPathGets the path of the topic that this subscription description belongs to.
Public propertyUpdatedAtGets the exact time the message has been updated.
Public propertyUserMetadataGets or sets the user metadata.

Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)

Public fieldStatic memberMessageTimeToLiveDefaultValueSpecifies the message time to live default value.


Entity names are case-insensitive; for example MYSUBSCRIPTION is the same as mysubscription. Therefore, you should use IgnoreCase in any comparison of entity names.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft