Class SubscriptionDescription
- Namespace
- Microsoft.ServiceBus.Messaging
- Assembly
- Microsoft.ServiceBus.dll
Represents a description of the subscription.
[DataContract(Name = "SubscriptionDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class SubscriptionDescription : EntityDescription, IExtensibleDataObject- Inheritance
-
SubscriptionDescription
- Implements
-
IExtensibleDataObject
- Inherited Members
Constructors
SubscriptionDescription(string, string)
Initializes a new instance of the SubscriptionDescription class.
public SubscriptionDescription(string topicPath, string subscriptionName)Parameters
Fields
MessageTimeToLiveDefaultValue
Specifies the message time to live default value.
public static readonly TimeSpan MessageTimeToLiveDefaultValueField Value
Properties
AccessedAt
Gets the last time a there was a receive request to this subscription.
public DateTime AccessedAt { get; }Property Value
- DateTime
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.
public TimeSpan AutoDeleteOnIdle { get; set; }Property Value
- TimeSpan
The auto delete on idle time span for the subscription.
AvailabilityStatus
Gets the entity availability status for the messaging.
public EntityAvailabilityStatus AvailabilityStatus { get; }Property Value
- EntityAvailabilityStatus
The entity availability status for the messaging.
CreatedAt
Gets the exact time the message was created.
public DateTime CreatedAt { get; }Property Value
- DateTime
The 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 System.TimeSpan.MaxValue. Therefore, this property becomes the default time to live value applied to messages.
public TimeSpan DefaultMessageTimeToLive { get; set; }Property Value
- TimeSpan
The default message time to live for a subscription.
EnableBatchedOperations
Gets or sets a value that indicates whether the batched operations are enabled.
public bool EnableBatchedOperations { get; set; }Property Value
- bool
true if the batched operations are enabled; otherwise, false.
EnableDeadLetteringOnFilterEvaluationExceptions
Gets or sets the value that indicates if a subscription has dead letter support on Filter evaluation exceptions.
public bool EnableDeadLetteringOnFilterEvaluationExceptions { get; set; }Property Value
- bool
true if a subscription has dead letter support on Filter evaluation exceptions; otherwise, false.
EnableDeadLetteringOnMessageExpiration
Gets or sets the value that indicates if a subscription has dead letter support when a message expires.
public bool EnableDeadLetteringOnMessageExpiration { get; set; }Property Value
- bool
true if a subscription has dead letter support when a message expires; otherwise, false.
ForwardDeadLetteredMessagesTo
Gets or sets the path to the recipient to which the dead lettered messages are forwarded.
public string ForwardDeadLetteredMessagesTo { get; set; }Property Value
- string
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.
public string ForwardTo { get; set; }Property Value
- string
The path to the recipient to which the message is forwarded.
LockDuration
Gets or sets the lock duration time span for the subscription.
public TimeSpan LockDuration { get; set; }Property Value
- TimeSpan
The lock duration time span for the subscription.
MaxDeliveryCount
Gets or sets the number of maximum deliveries.
public int MaxDeliveryCount { get; set; }Property Value
- int
The number of maximum deliveries.
MessageCount
Gets the number of messages.
public long MessageCount { get; }Property Value
- long
The number of messages.
MessageCountDetails
Gets message details about the subscription.
public MessageCountDetails MessageCountDetails { get; }Property Value
- MessageCountDetails
Returns MessageCountDetails with the number of active messages, dead letters, scheduled messages, messages transferred to other queues, subscriptions, or topics, and the number of messages transferred to the dead letter queue.
Name
Gets the name of the subscription description.
public string Name { get; set; }Property Value
- string
The name of the subscription description.
RequiresSession
Gets or sets the value indicating if a subscription supports the concept of session.
public bool RequiresSession { get; set; }Property Value
- bool
true if the receiver application can only receive from the queue through a Microsoft.ServiceBus.Messaging.SessionReceiver; false if a queue cannot receive using Microsoft.ServiceBus.Messaging.SessionReceiver.
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.
public EntityStatus Status { get; set; }Property Value
- EntityStatus
The current status of the subscription.
TopicPath
Gets the path of the topic that this subscription description belongs to.
public string TopicPath { get; set; }Property Value
- string
The path of the topic that this subscription description belongs to.
UpdatedAt
Gets the exact time the message has been updated.
public DateTime UpdatedAt { get; }Property Value
- DateTime
The time the message has been updated.
UserMetadata
Gets or sets the user metadata.
public string UserMetadata { get; set; }Property Value
- string
The user metadata.