Share via


ServiceBusQueueData Class

Definition

A class representing the ServiceBusQueue data model. Description of queue Resource.

public class ServiceBusQueueData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ServiceBus.ServiceBusQueueData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ServiceBus.ServiceBusQueueData>
type ServiceBusQueueData = class
    inherit ResourceData
    interface IJsonModel<ServiceBusQueueData>
    interface IPersistableModel<ServiceBusQueueData>
Public Class ServiceBusQueueData
Inherits ResourceData
Implements IJsonModel(Of ServiceBusQueueData), IPersistableModel(Of ServiceBusQueueData)
Inheritance
ServiceBusQueueData
Implements

Constructors

ServiceBusQueueData()

Initializes a new instance of ServiceBusQueueData.

Properties

AccessedOn

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.

CountDetails

Message Count Details.

CreatedOn

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.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Location

The geo-location where the resource lives.

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.

Name

The name of the resource.

(Inherited from ResourceData)
RequiresDuplicateDetection

A value indicating if this queue requires duplicate detection.

RequiresSession

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

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SizeInBytes

The size of the queue, in bytes.

Status

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

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
UpdatedOn

The exact time the message was updated.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<ServiceBusQueueData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ServiceBusQueueData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ServiceBusQueueData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ServiceBusQueueData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ServiceBusQueueData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to