TopicDescription TopicDescription Class

Definition

Represents a description of the topic.

[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
TopicDescriptionTopicDescription
Attributes

Inherited Members

Microsoft.ServiceBus.Messaging.EntityDescription

System.Object

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
String String

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

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

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

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

Attributes

Authorization Authorization

Gets the authorization rules for the description.

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

The authorization rules for the description.

Attributes

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
Value
TimeSpan TimeSpan

The auto delete on idle time span for the topic.

Attributes

AvailabilityStatus AvailabilityStatus

Gets the status of the availability of this instance.

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

The status of the availability of this instance.

Attributes

CreatedAt CreatedAt

Gets the time and date when the topic was created.

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

The time and date when the topic was created.

Attributes

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
Value
TimeSpan TimeSpan

The default message time to live for a topic.

Attributes

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
Value
TimeSpan TimeSpan

The TimeSpan structure that defines the duration of the duplicate detection history.

Attributes

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
Value
Boolean Boolean

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

Attributes

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
Value
Boolean Boolean

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

Attributes

EnableFilteringMessagesBeforePublishing EnableFilteringMessagesBeforePublishing

Gets or sets whether messages should be filtered before publishing.

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

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

Attributes
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
Value
Boolean Boolean

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

Attributes

IsAnonymousAccessible IsAnonymousAccessible

Gets whether anonymous access is allowed.

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

true if anonymous access is allowed; otherwise, false.

Attributes

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
Value
Int64 Int64

The maximum size in megabytes.

Attributes

MessageCountDetails MessageCountDetails

Gets message details about the topic.

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

The MessageCountDetails that contains 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

Path Path

Gets the path of the topic.

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

The path of the topic.

Attributes

Remarks

This is a relative path to the Address.

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
Value
Boolean Boolean

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

Attributes

SizeInBytes SizeInBytes

Gets the size of the topic in bytes.

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

The size of the topic in bytes.

Attributes

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
Value
EntityStatus EntityStatus

The status of the topic.

Attributes

SubscriptionCount SubscriptionCount

Gets then number of subscriptions.

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

An Int32 that represents the number of subscriptions.

Attributes

SupportOrdering SupportOrdering

Gets or sets the support ordering method.

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

The support ordering method.

Attributes

UpdatedAt UpdatedAt

Gets the time and date when the topic was updated.

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

The time and date when the topic was updated.

Attributes

UserMetadata UserMetadata

Gets or sets the user metadata associated with the description.

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

The user metadata associated with the description.

Attributes