CreateQueueOptions Class

Reference

Definition

Namespace:: Azure.Messaging.ServiceBus.Administration

Assembly:: Azure.Messaging.ServiceBus.dll

Package:: Azure.Messaging.ServiceBus v7.18.2

Package:: Azure.Messaging.ServiceBus v7.18.0-beta.1

Source:: CreateQueueOptions.cs

Source:: CreateQueueOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class CreateQueueOptions : IEquatable<Azure.Messaging.ServiceBus.Administration.CreateQueueOptions>

type CreateQueueOptions = class
    interface IEquatable<CreateQueueOptions>

Public Class CreateQueueOptions
Implements IEquatable(Of CreateQueueOptions)

Inheritance: Object
CreateQueueOptions

Implements: IEquatable<CreateQueueOptions>

Constructors

CreateQueueOptions(QueueProperties)	Initializes a new instance of CreateQueueOptions based on the specified QueueProperties instance. This is useful for creating a new queue based on the properties of an existing queue.
CreateQueueOptions(String)	Initializes a new instance of CreateQueueOptions with the specified relative name.

Properties

AuthorizationRules	The AuthorizationRules on the queue to control user access at entity level.
AutoDeleteOnIdle	The TimeSpan idle interval after which the queue is automatically deleted.
DeadLetteringOnMessageExpiration	Indicates whether this queue has dead letter support when a message expires.
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 queue is to be partitioned across multiple message brokers.
ForwardDeadLetteredMessagesTo	The name of the recipient entity to which all the dead-lettered messages of this queue are forwarded to.
ForwardTo	The name of the recipient entity to which all the messages sent to the queue are forwarded to.
LockDuration	Duration of a peek lock receive. i.e., the amount of time that the message is locked by a given receiver so that no other receiver receives the same message.
MaxDeliveryCount	The maximum delivery count of a message before it is dead-lettered.
MaxMessageSizeInKilobytes	Gets or sets the maximum message size, in kilobytes, for messages sent to this queue. This feature is only available when using a Premium namespace and service version "2021-05" or higher. https://zcusa.951200.xyz/azure/service-bus-messaging/service-bus-premium-messaging
MaxSizeInMegabytes	The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
Name	Name of the queue relative to the namespace base address.
RequiresDuplicateDetection	This value indicates if the queue requires guard against duplicate messages. If true, duplicate messages having same MessageId and sent to queue within duration of DuplicateDetectionHistoryTimeWindow will be discarded.
RequiresSession	This indicates whether the queue supports the concept of session. Sessionful-messages follow FIFO ordering.
Status	The current status of the queue (Enabled / Disabled).
UserMetadata	Custom metadata that user can associate with the queue.

Methods

Equals(CreateQueueOptions)	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(CreateQueueOptions, CreateQueueOptions)
Inequality(CreateQueueOptions, CreateQueueOptions)

Applies to

Share via