SubscriptionDescription SubscriptionDescription Class

Represents a description of the subscription.

Syntax

Declaration

[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 Hierarchy

Constructors summary

Initializes a new instance of the SubscriptionDescription class.

Fields summary

The message time to live default value

Properties summary

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

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

Gets the entity availability status for the messaging.

Gets the exact time the message was created.

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.

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

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

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

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

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

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

Gets or sets the number of maximum deliveries.

Gets the number of messages.

Gets message details about the subscription.

Gets the name of the subscription description.

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

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

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

Gets the exact time the message has been updated.

Gets or sets the user metadata.

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

Fields

  • MessageTimeToLiveDefaultValue
    MessageTimeToLiveDefaultValue

    The message time to live default value

    public static readonly TimeSpan MessageTimeToLiveDefaultValuePublic Shared ReadOnly MessageTimeToLiveDefaultValue As TimeSpan

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

    Property Value

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

  • 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

    Property Value

  • AvailabilityStatus
    AvailabilityStatus

    Gets the entity availability status for the messaging.

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

    Property Value

  • CreatedAt
    CreatedAt

    Gets the exact time the message was created.

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

    Property Value

  • 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

    Property Value

  • 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

    Property Value

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

  • 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

    Property Value

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

  • 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

    Property Value

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

  • 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

    Property Value

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

  • 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

    Property Value

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

  • LockDuration
    LockDuration

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

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

    Property Value

  • MaxDeliveryCount
    MaxDeliveryCount

    Gets or sets the number of maximum deliveries.

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

    Property Value

  • MessageCount
    MessageCount

    Gets the number of messages.

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

    Property Value

  • MessageCountDetails
    MessageCountDetails

    Gets message details about the subscription.

    public MessageCountDetails MessageCountDetails { get; }Public ReadOnly Property MessageCountDetails As MessageCountDetails

    Property Value

  • Name
    Name

    Gets the name of the subscription description.

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

    Property Value

  • 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

    Property Value

  • 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

    Property Value

  • TopicPath
    TopicPath

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

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

    Property Value

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

  • UpdatedAt
    UpdatedAt

    Gets the exact time the message has been updated.

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

    Property Value

  • UserMetadata
    UserMetadata

    Gets or sets the user metadata.

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

    Property Value

Details

Assembly

Microsoft.ServiceBus.dll