SubscriptionDescription SubscriptionDescription SubscriptionDescription Class


Represents a description of the subscription.

[System.Runtime.Serialization.DataContract(Name="SubscriptionDescription", Namespace="")]
public sealed class SubscriptionDescription : Microsoft.ServiceBus.Messaging.EntityDescription
type SubscriptionDescription = class
    inherit EntityDescription
    interface IResourceDescription
Public NotInheritable Class SubscriptionDescription
Inherits EntityDescription


SubscriptionDescription(String, String) SubscriptionDescription(String, String) SubscriptionDescription(String, String)

Initializes a new instance of the SubscriptionDescription class.


MessageTimeToLiveDefaultValue MessageTimeToLiveDefaultValue MessageTimeToLiveDefaultValue

The message time to live default value


AccessedAt AccessedAt AccessedAt

Gets the last time a there was a receive request to this subscription.

AutoDeleteOnIdle AutoDeleteOnIdle AutoDeleteOnIdle

Gets or sets the TimeSpan idle interval after which the subscription is automatically deleted. The minimum duration is 5 minutes.

AvailabilityStatus AvailabilityStatus AvailabilityStatus

Gets the entity availability status for the messaging.

CreatedAt CreatedAt CreatedAt

Gets the exact time the message was created.

DefaultMessageTimeToLive DefaultMessageTimeToLive DefaultMessageTimeToLive

Gets 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.

EnableBatchedOperations EnableBatchedOperations EnableBatchedOperations

Gets or sets a value that indicates whether the batched operations are enabled.

EnableDeadLetteringOnFilterEvaluationExceptions EnableDeadLetteringOnFilterEvaluationExceptions EnableDeadLetteringOnFilterEvaluationExceptions

Gets or sets the value that indicates if a subscription has dead letter support on Filter evaluation exceptions.

EnableDeadLetteringOnMessageExpiration EnableDeadLetteringOnMessageExpiration EnableDeadLetteringOnMessageExpiration

Gets or sets the value that indicates if a subscription has dead letter support when a message expires.

ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data.

(Inherited from EntityDescription)
ForwardDeadLetteredMessagesTo ForwardDeadLetteredMessagesTo ForwardDeadLetteredMessagesTo

Gets or sets the path to the recipient to which the dead lettered messages are forwarded.

ForwardTo ForwardTo ForwardTo

Gets or sets the path to the recipient to which the message is forwarded.

IsReadOnly IsReadOnly IsReadOnly

Gets or sets a value that indicates whether the entity description is read-only.

(Inherited from EntityDescription)
LockDuration LockDuration LockDuration

Gets or sets the lock duration time span for the subscription.

MaxDeliveryCount MaxDeliveryCount MaxDeliveryCount

Gets or sets the number of maximum deliveries.

MessageCount MessageCount MessageCount

Gets the number of messages.

MessageCountDetails MessageCountDetails MessageCountDetails

Gets message details about the subscription.

Name Name Name

Gets the name of the subscription description.

RequiresSession RequiresSession RequiresSession

Gets or sets the value indicating if a subscription supports the concept of session.

Status Status Status

Gets or sets the current status of the subscription (enabled or disabled). When an entity is disabled, that entity cannot send or receive messages.

TopicPath TopicPath TopicPath

Gets the path of the topic that this subscription description belongs to.

UpdatedAt UpdatedAt UpdatedAt

Gets the exact time the message has been updated.

UserMetadata UserMetadata UserMetadata

Gets or sets the user metadata.


ThrowIfReadOnly() ThrowIfReadOnly() ThrowIfReadOnly()

Throws an exception if the entity description is read-only.

(Inherited from EntityDescription)

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to