TopicDescription TopicDescription Class

Represents a description of the topic.

Syntax

Declaration

[DataContract(Name = "TopicDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class TopicDescription : EntityDescription, IExtensibleDataObject, IResourceDescription<DataContract(Name:="TopicDescription", Namespace:="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>
Public NotInheritable Class TopicDescription
    Inherits EntityDescription
    Implements IExtensibleDataObject, IResourceDescription

Inheritance Hierarchy

Constructors summary

Initializes a new instance of the TopicDescription class with the specified relative path.

Fields summary

The message time to live default value

Properties summary

Gets the time and date at which a message was last sent to the topic.

Gets the authorization rules for the description.

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

Gets the status of the availability of this instance.

Gets the time and date when the topic was created.

Gets or sets the default message time to live value for a topic. 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.

Gets or sets the TimeSpan structure that defines the duration of the duplicate detection history.

Gets or sets a value that indicates whether server-side batched operations are enabled.

Gets or sets a value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

Gets or sets whether messages should be filtered before publishing.

Gets or sets whether to enable the topic to be partitioned across multiple message brokers. An express topic holds a message in memory temporarily before writing it to persistent storage.

Gets whether anonymous access is allowed.

Gets or sets the maximum size of the topic in megabytes, which is the size of memory allocated for the topic.

Gets message details about the topic.

Gets the path of the topic.

Gets or sets the value that indicates whether a topic requires duplication detection.

Gets the size of the topic in bytes.

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

Gets then number of subscriptions.

Gets or sets the support ordering method.

Gets the time and date when the topic was updated.

Gets or sets the user metadata associated with the description.

Constructors

  • TopicDescription(String)
    TopicDescription(String)

    Initializes a new instance of the TopicDescription class with the specified relative path.

    public TopicDescription(string path)Public Sub New(path As String)

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

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 time and date at which a message was last sent to the topic.

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

    Property Value

    • The time and date at which a message was last sent to the topic.

  • Authorization
    Authorization

    Gets the authorization rules for the description.

    public AuthorizationRules Authorization { get; }Public ReadOnly Property Authorization As AuthorizationRules

    Property Value

  • AutoDeleteOnIdle
    AutoDeleteOnIdle

    Gets or sets the TimeSpan idle interval after which the topic 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 status of the availability of this instance.

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

    Property Value

  • CreatedAt
    CreatedAt

    Gets the time and date when the topic 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 for a topic. 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.

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

    Property Value

  • DuplicateDetectionHistoryTimeWindow
    DuplicateDetectionHistoryTimeWindow

    Gets or sets the TimeSpan structure that defines the duration of the duplicate detection history.

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

    Property Value

  • EnableBatchedOperations
    EnableBatchedOperations

    Gets or sets a value that indicates whether server-side 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.

  • EnableExpress
    EnableExpress

    Gets or sets a value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

    public bool EnableExpress { get; set; }Public Property EnableExpress As Boolean

    Property Value

    • true if the Express Entities are enabled; otherwise, false.

  • EnableFilteringMessagesBeforePublishing
    EnableFilteringMessagesBeforePublishing

    Gets or sets whether messages should be filtered before publishing.

    public bool EnableFilteringMessagesBeforePublishing { get; set; }Public Property EnableFilteringMessagesBeforePublishing As Boolean

    Property Value

    • true if message filtering is enabled before publishing; otherwise, false.

    Exceptions

    Remarks

    This feature is recommended to be used only for development and testing purposes.
    For example, when new Rules or Filters are being added to the topic, this feature can be used to verify that the new filter expression is working as expected. Once tested and working fine, the feature should be turned off in production.

  • EnablePartitioning
    EnablePartitioning

    Gets or sets whether to enable the topic to be partitioned across multiple message brokers. An express topic holds a message in memory temporarily before writing it to persistent storage.

    public bool EnablePartitioning { get; set; }Public Property EnablePartitioning As Boolean

    Property Value

    • true to enable the topic to be partitioned across multiple message brokers; otherwise, false.

  • IsAnonymousAccessible
    IsAnonymousAccessible

    Gets whether anonymous access is allowed.

    public bool IsAnonymousAccessible { get; set; }Public Property IsAnonymousAccessible As Boolean

    Property Value

    • true if anonymous access is allowed; otherwise, false.

  • MaxSizeInMegabytes
    MaxSizeInMegabytes

    Gets or sets the maximum size of the topic in megabytes, which is the size of memory allocated for the topic.

    public long MaxSizeInMegabytes { get; set; }Public Property MaxSizeInMegabytes As Long

    Property Value

  • MessageCountDetails
    MessageCountDetails

    Gets message details about the topic.

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

    Property Value

  • Path
    Path

    Gets the path of the topic.

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

    Property Value

  • RequiresDuplicateDetection
    RequiresDuplicateDetection

    Gets or sets the value that indicates whether a topic requires duplication detection.

    public bool RequiresDuplicateDetection { get; set; }Public Property RequiresDuplicateDetection As Boolean

    Property Value

    • true if a topic requires duplication detection; otherwise, false.

  • SizeInBytes
    SizeInBytes

    Gets the size of the topic in bytes.

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

    Property Value

  • Status
    Status

    Gets or sets the current status of the topic (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

  • SubscriptionCount
    SubscriptionCount

    Gets then number of subscriptions.

    public int SubscriptionCount { get; }Public ReadOnly Property SubscriptionCount As Integer

    Property Value

  • SupportOrdering
    SupportOrdering

    Gets or sets the support ordering method.

    public bool SupportOrdering { get; set; }Public Property SupportOrdering As Boolean

    Property Value

  • UpdatedAt
    UpdatedAt

    Gets the time and date when the topic was updated.

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

    Property Value

  • UserMetadata
    UserMetadata

    Gets or sets the user metadata associated with the description.

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

    Property Value

    • The user metadata associated with the description.

Details

Assembly

Microsoft.ServiceBus.dll