Subscription​Description Class

Definition

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
Inheritance
SubscriptionDescription
Attributes
System.Runtime.Serialization.DataContract

Inherited Members

Microsoft.ServiceBus.Messaging.EntityDescription

Constructors

Subscription​Description(​String, ​String)

Initializes a new instance of the SubscriptionDescription class.

Fields

Message​Time​To​Live​Default​Value

The message time to live default value

Properties

Accessed​At

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

Auto​Delete​On​Idle

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

Availability​Status

Gets the entity availability status for the messaging.

Created​At

Gets the exact time the message was created.

Default​Message​Time​To​Live

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.

Enable​Batched​Operations

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

Enable​Dead​Lettering​On​Filter​Evaluation​Exceptions

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

Enable​Dead​Lettering​On​Message​Expiration

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

Forward​Dead​Lettered​Messages​To

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

Forward​To

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

Lock​Duration

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

Max​Delivery​Count

Gets or sets the number of maximum deliveries.

Message​Count

Gets the number of messages.

Message​Count​Details

Gets message details about the subscription.

Name

Gets the name of the subscription description.

Requires​Session

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.

Topic​Path

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

Updated​At

Gets the exact time the message has been updated.

User​Metadata

Gets or sets the user metadata.