SubscriptionDescription Class

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Represents a description of the subscription.

[System.Runtime.Serialization.DataContract(Name="SubscriptionDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class SubscriptionDescription : Microsoft.ServiceBus.Messaging.EntityDescription

[<System.Runtime.Serialization.DataContract(Name="SubscriptionDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>]
type SubscriptionDescription = class
    inherit EntityDescription

Public NotInheritable Class SubscriptionDescription
Inherits EntityDescription

Inheritance

Object

EntityDescription

SubscriptionDescription

Attributes

DataContractAttribute

Constructors

SubscriptionDescription(String, String)

Initializes a new instance of the SubscriptionDescription class.

Fields

MessageTimeToLiveDefaultValue

The message time to live default value

Properties

AccessedAt	Gets the last time a there was a receive request to this subscription.
AutoDeleteOnIdle	Gets or sets the TimeSpan idle interval after which the subscription is automatically deleted. The minimum duration is 5 minutes.
AvailabilityStatus	Gets the entity availability status for the messaging.
ClientAffineProperties
CreatedAt	Gets the exact time the message was created.
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	Gets or sets a value that indicates whether the batched operations are enabled.
EnableDeadLetteringOnFilterEvaluationExceptions	Gets or sets the value that indicates if a subscription has dead letter support on Filter evaluation exceptions.
EnableDeadLetteringOnMessageExpiration	Gets or sets the value that indicates if a subscription has dead letter support when a message expires.
ExtensionData	Gets or sets the structure that contains extra data. (Inherited from EntityDescription)
ForwardDeadLetteredMessagesTo	Gets or sets the path to the recipient to which the dead lettered messages are forwarded.
ForwardTo	Gets or sets the path to the recipient to which the message is forwarded.
IsClientAffine
IsReadOnly	Gets or sets a value that indicates whether the entity description is read-only. (Inherited from EntityDescription)
LockDuration	Gets or sets the lock duration time span for the subscription.
MaxDeliveryCount	Gets or sets the number of maximum deliveries.
MessageCount	Gets the number of messages.
MessageCountDetails	Gets message details about the subscription.
Name	Gets the name of the subscription description.
RequiresSession	Gets or sets the value indicating if a subscription supports the concept of session.
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	Gets the path of the topic that this subscription description belongs to.
UpdatedAt	Gets the exact time the message has been updated.
UserMetadata	Gets or sets the user metadata.

Methods

ThrowIfReadOnly()

Throws an exception if the entity description is read-only. (Inherited from EntityDescription)