SubscriptionDescription SubscriptionDescription Class

Definition

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, IResourceDescription<DataContract(Name:="SubscriptionDescription", Namespace:="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>
Public NotInheritable Class SubscriptionDescription
    Inherits EntityDescription
    Implements IExtensibleDataObject, IResourceDescription
Inheritance
SubscriptionDescriptionSubscriptionDescription
Attributes

Inherited Members

Microsoft.ServiceBus.Messaging.EntityDescription

System.Object

Constructors

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

Initializes a new instance of the SubscriptionDescription class.

public SubscriptionDescription(string topicPath, string subscriptionName)Public Sub New(topicPath As String, subscriptionName As String)
Parameters
topicPath
String String

The topic path.

subscriptionName
String String

The subscription name.

Attributes

Fields

MessageTimeToLiveDefaultValue MessageTimeToLiveDefaultValue

The message time to live default value

public static readonly TimeSpan MessageTimeToLiveDefaultValuePublic Shared ReadOnly MessageTimeToLiveDefaultValue As TimeSpan
Attributes

Properties

AccessedAt AccessedAt

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

public DateTime AccessedAt { get; }Public ReadOnly Property AccessedAt As Date
Value
DateTime DateTime

The last time a there was a receive request to this subscription.

Attributes

AutoDeleteOnIdle 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; }Public Property AutoDeleteOnIdle As TimeSpan
Value
TimeSpan TimeSpan

The auto delete on idle time span for the subscription.

Attributes

AvailabilityStatus AvailabilityStatus

Gets the entity availability status for the messaging.

public EntityAvailabilityStatus AvailabilityStatus { get; }Public ReadOnly Property AvailabilityStatus As EntityAvailabilityStatus
Value
EntityAvailabilityStatus EntityAvailabilityStatus

The entity availability status for the messaging.

Attributes

CreatedAt CreatedAt

Gets the exact time the message was created.

public DateTime CreatedAt { get; }Public ReadOnly Property CreatedAt As Date
Value
DateTime DateTime

The time the message was created.

Attributes

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.

public TimeSpan DefaultMessageTimeToLive { get; set; }Public Property DefaultMessageTimeToLive As TimeSpan
Value
TimeSpan TimeSpan

The default message time to live for a subscription.

Attributes

EnableBatchedOperations EnableBatchedOperations

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

public bool EnableBatchedOperations { get; set; }Public Property EnableBatchedOperations As Boolean
Value
Boolean Boolean

true if the batched operations are enabled; otherwise, false.

Attributes

EnableDeadLetteringOnFilterEvaluationExceptions EnableDeadLetteringOnFilterEvaluationExceptions

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

public bool EnableDeadLetteringOnFilterEvaluationExceptions { get; set; }Public Property EnableDeadLetteringOnFilterEvaluationExceptions As Boolean
Value
Boolean Boolean

true if a subscription has dead letter support on Filter evaluation exceptions; otherwise, false.

Attributes

EnableDeadLetteringOnMessageExpiration EnableDeadLetteringOnMessageExpiration

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

public bool EnableDeadLetteringOnMessageExpiration { get; set; }Public Property EnableDeadLetteringOnMessageExpiration As Boolean
Value
Boolean Boolean

true if a subscription has dead letter support when a message expires; otherwise, false.

Attributes

ForwardDeadLetteredMessagesTo ForwardDeadLetteredMessagesTo

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

public string ForwardDeadLetteredMessagesTo { get; set; }Public Property ForwardDeadLetteredMessagesTo As String
Value
String String

The path to the recipient to which the dead lettered messages are forwarded.

Attributes

ForwardTo ForwardTo

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

public string ForwardTo { get; set; }Public Property ForwardTo As String
Value
String String

The path to the recipient to which the message is forwarded.

Attributes

LockDuration LockDuration

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

public TimeSpan LockDuration { get; set; }Public Property LockDuration As TimeSpan
Value
TimeSpan TimeSpan

The lock duration time span for the subscription.

Attributes

MaxDeliveryCount MaxDeliveryCount

Gets or sets the number of maximum deliveries.

public int MaxDeliveryCount { get; set; }Public Property MaxDeliveryCount As Integer
Value
Int32 Int32

The number of maximum deliveries.

Attributes

MessageCount MessageCount

Gets the number of messages.

public long MessageCount { get; }Public ReadOnly Property MessageCount As Long
Value
Int64 Int64

The number of messages.

Attributes

MessageCountDetails MessageCountDetails

Gets message details about the subscription.

public MessageCountDetails MessageCountDetails { get; }Public ReadOnly Property MessageCountDetails As MessageCountDetails
Value
MessageCountDetails 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.

Attributes

Name Name

Gets the name of the subscription description.

public string Name { get; set; }Public Property Name As String
Value
String String

The name of the subscription description.

Attributes

RequiresSession RequiresSession

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

public bool RequiresSession { get; set; }Public Property RequiresSession As Boolean
Value
Boolean Boolean

true if the receiver application can only receive from the queue through a MessageSession; false if a queue cannot receive using MessageSession.

Attributes

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.

public EntityStatus Status { get; set; }Public Property Status As EntityStatus
Value
EntityStatus EntityStatus

The current status of the subscription.

Attributes

TopicPath TopicPath

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

public string TopicPath { get; set; }Public Property TopicPath As String
Value
String String

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

Attributes

Remarks

This is a relative path to the Address.

UpdatedAt UpdatedAt

Gets the exact time the message has been updated.

public DateTime UpdatedAt { get; }Public ReadOnly Property UpdatedAt As Date
Value
DateTime DateTime

The time the message has been updated.

Attributes

UserMetadata UserMetadata

Gets or sets the user metadata.

public string UserMetadata { get; set; }Public Property UserMetadata As String
Value
String String

The user metadata.

Attributes