TopicDescription TopicDescription TopicDescription Class


Represents a description of the topic.

[System.Runtime.Serialization.DataContract(Name="TopicDescription", Namespace="")]
public sealed class TopicDescription : Microsoft.ServiceBus.Messaging.EntityDescription
type TopicDescription = class
    inherit EntityDescription
    interface IResourceDescription
Public NotInheritable Class TopicDescription
Inherits EntityDescription


TopicDescription(String) TopicDescription(String) TopicDescription(String)

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


MessageTimeToLiveDefaultValue MessageTimeToLiveDefaultValue MessageTimeToLiveDefaultValue

The message time to live default value


AccessedAt AccessedAt AccessedAt

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

Authorization Authorization Authorization

Gets the authorization rules for the description.

AutoDeleteOnIdle AutoDeleteOnIdle AutoDeleteOnIdle

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

AvailabilityStatus AvailabilityStatus AvailabilityStatus

Gets the status of the availability of this instance.

CreatedAt CreatedAt CreatedAt

Gets the time and date when the topic was created.

DefaultMessageTimeToLive 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.

DuplicateDetectionHistoryTimeWindow DuplicateDetectionHistoryTimeWindow DuplicateDetectionHistoryTimeWindow

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

EnableBatchedOperations EnableBatchedOperations EnableBatchedOperations

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

EnableExpress 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.

EnableFilteringMessagesBeforePublishing EnableFilteringMessagesBeforePublishing EnableFilteringMessagesBeforePublishing

Gets or sets whether messages should be filtered before publishing.

EnablePartitioning 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.

ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data.

(Inherited from EntityDescription)
IsAnonymousAccessible IsAnonymousAccessible IsAnonymousAccessible

Gets whether anonymous access is allowed.

IsReadOnly IsReadOnly IsReadOnly

Gets or sets a value that indicates whether the entity description is read-only.

(Inherited from EntityDescription)
MaxSizeInMegabytes MaxSizeInMegabytes MaxSizeInMegabytes

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

MessageCountDetails MessageCountDetails MessageCountDetails

Gets message details about the topic.

Path Path Path

Gets the path of the topic.

RequiresDuplicateDetection RequiresDuplicateDetection RequiresDuplicateDetection

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

SizeInBytes SizeInBytes SizeInBytes

Gets the size of the topic in bytes.

Status 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.

SubscriptionCount SubscriptionCount SubscriptionCount

Gets then number of subscriptions.

SupportOrdering SupportOrdering SupportOrdering

Gets or sets the support ordering method.

UpdatedAt UpdatedAt UpdatedAt

Gets the time and date when the topic was updated.

UserMetadata UserMetadata UserMetadata

Gets or sets the user metadata associated with the description.


ThrowIfReadOnly() ThrowIfReadOnly() ThrowIfReadOnly()

Throws an exception if the entity description is read-only.

(Inherited from EntityDescription)

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to