Share via


CreateTopicOptions Class

Definition

Represents the options that can be specified for the creation of a topic.

public class CreateTopicOptions : IEquatable<Azure.Messaging.ServiceBus.Administration.CreateTopicOptions>
type CreateTopicOptions = class
    interface IEquatable<CreateTopicOptions>
Public Class CreateTopicOptions
Implements IEquatable(Of CreateTopicOptions)
Inheritance
CreateTopicOptions
Implements

Constructors

CreateTopicOptions(String)

Initializes a new instance of CreateTopicOptions with the specified relative name.

CreateTopicOptions(TopicProperties)

Initializes a new instance of CreateTopicOptions based on the specified TopicProperties instance. This is useful for creating a new topic based on the properties of an existing topic.

Properties

AuthorizationRules

The AuthorizationRules on the topic to control user access at entity level.

AutoDeleteOnIdle

The TimeSpan idle interval after which the topic is automatically deleted.

DefaultMessageTimeToLive

The default time to live value for the messages. This is the duration after which the message expires, starting from when the message is sent to Service Bus.

DuplicateDetectionHistoryTimeWindow

The TimeSpan duration of duplicate detection history that is maintained by the service.

EnableBatchedOperations

Indicates whether server-side batched operations are enabled.

EnablePartitioning

Indicates whether the topic is to be partitioned across multiple message brokers.

MaxMessageSizeInKilobytes

Gets or sets the maximum message size, in kilobytes, for messages sent to this topic. This feature is only available when using a Premium namespace and service version "2021-05" or higher. https://learn.microsoft.com/azure/service-bus-messaging/service-bus-premium-messaging

MaxSizeInMegabytes

The maximum size of the topic in megabytes, which is the size of memory allocated for the topic.

Name

Name of the topic relative to the namespace base address.

RequiresDuplicateDetection

This value indicates if the topic requires guard against duplicate messages. If true, duplicate messages having same MessageId and sent to topic within duration of DuplicateDetectionHistoryTimeWindow will be discarded.

Status

The current status of the topic (Enabled / Disabled).

SupportOrdering

Defines whether ordering needs to be maintained. If true, messages sent to topic will be forwarded to the subscription in order. For partitioned topics, defaults to false, and setting it to true has no effect.

UserMetadata

Custom metadata that user can associate with the topic.

Methods

Equals(CreateTopicOptions)

Determines whether the specified object is equal to the current object.

Equals(Object)

Determines whether the specified object is equal to the current object.

GetHashCode()

Returns a hash code for this instance.

Operators

Equality(CreateTopicOptions, CreateTopicOptions)
Inequality(CreateTopicOptions, CreateTopicOptions)

Applies to