Share via


SbQueueProperties Class

Definition

The Queue Properties definition.

[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.SbQueuePropertiesTypeConverter))]
public class SbQueueProperties : Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.ISbQueueProperties
[<Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.SbQueuePropertiesTypeConverter))>]
type SbQueueProperties = class
    interface ISbQueueProperties
    interface IJsonSerializable
Public Class SbQueueProperties
Implements ISbQueueProperties
Inheritance
SbQueueProperties
Attributes
Implements

Constructors

SbQueueProperties()

Creates an new SbQueueProperties instance.

Properties

AccessedAt

Last time a message was sent, or the last time there was a receive request to this queue.

AutoDeleteOnIdle

ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

CountDetailActiveMessageCount

Number of active messages in the queue, topic, or subscription.

CountDetailDeadLetterMessageCount

Number of messages that are dead lettered.

CountDetailScheduledMessageCount

Number of scheduled messages.

CountDetailTransferDeadLetterMessageCount

Number of messages transferred into dead letters.

CountDetailTransferMessageCount

Number of messages transferred to another queue, topic, or subscription.

CreatedAt

The exact time the message was created.

DeadLetteringOnMessageExpiration

A value that indicates whether this queue has dead letter support when a message expires.

DefaultMessageTimeToLive

ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

DuplicateDetectionHistoryTimeWindow

ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

EnableBatchedOperations

Value that indicates whether server-side batched operations are enabled.

EnableExpress

A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

EnablePartitioning

A value that indicates whether the queue is to be partitioned across multiple message brokers.

ForwardDeadLetteredMessagesTo

Queue/Topic name to forward the Dead Letter message

ForwardTo

Queue/Topic name to forward the messages

LockDuration

ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

MaxDeliveryCount

The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

MaxMessageSizeInKilobytes

Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.

MaxSizeInMegabytes

The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

MessageCount

The number of messages in the queue.

RequiresDuplicateDetection

A value indicating if this queue requires duplicate detection.

RequiresSession

A value that indicates whether the queue supports the concept of sessions.

SizeInByte

The size of the queue, in bytes.

Status

Enumerates the possible values for the status of a messaging entity.

UpdatedAt

The exact time the message was updated.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of SbQueueProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of SbQueueProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.ISbQueueProperties.

FromJsonString(String)

Creates a new instance of SbQueueProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of SbQueueProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to