ServiceBusQueue Class

Definition

Namespace:

Azure.Provisioning.ServiceBus

Assembly:

Azure.Provisioning.ServiceBus.dll

Package:

Azure.Provisioning.ServiceBus v1.0.0

Source:

ServiceBusQueue.cs

ServiceBusQueue.

public class ServiceBusQueue : Azure.Provisioning.Primitives.ProvisionableResource

type ServiceBusQueue = class
    inherit ProvisionableResource

Public Class ServiceBusQueue
Inherits ProvisionableResource

Inheritance

Object

Provisionable

ProvisionableConstruct

NamedProvisionableConstruct

ProvisionableResource

ServiceBusQueue

Constructors

ServiceBusQueue(String, String)

Creates a new ServiceBusQueue.

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.
BicepIdentifier	Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct)
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.
DependsOn	Declares explicit dependencies on other resources. (Inherited from ProvisionableResource)
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	Gets the Id.
IsExistingResource	Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource)
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 queue name.
Parent	Gets or sets a reference to the parent ServiceBusNamespace.
RequiresDuplicateDetection	A value indicating if this queue requires duplicate detection.
RequiresSession	A value that indicates whether the queue supports the concept of sessions.
ResourceType	Gets the type of the resource. (Inherited from ProvisionableResource)
ResourceVersion	Gets or sets the version of the resource. (Inherited from ProvisionableResource)
SizeInBytes	The size of the queue, in bytes.
Status	Enumerates the possible values for the status of a messaging entity.
SystemData	Gets the SystemData.
UpdatedOn	The exact time the message was updated.

Methods

AssignOrReplace<T>(T, T)	(Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)	Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from ProvisionableResource)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String)	(Inherited from ProvisionableConstruct)
DefineProvisionableProperties()	Define all the provisionable properties of ServiceBusQueue.
DefineResource<T>(String, String[], Boolean, Boolean, T)	(Inherited from ProvisionableResource)
FromExisting(String, String)	Creates a reference to an existing ServiceBusQueue.
GetProvisionableResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
GetResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
Initialize()	Initialize this construct. (Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression)	(Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct)
Resolve(ProvisioningContext)	Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable)
Validate(ProvisioningBuildOptions)	Validate the presence of any required members. (Inherited from ProvisionableResource)
Validate(ProvisioningContext)	Validate the presence of any required members. (Inherited from Provisionable)

Explicit Interface Implementations

IBicepValue.Assign(IBicepValue)	Assign a value to this property. (Inherited from ProvisionableConstruct)
IBicepValue.Compile()	Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct)
IBicepValue.Expression	Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty	Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct)
IBicepValue.IsOutput	Tracks whether this is an output only property. (Inherited from ProvisionableConstruct)
IBicepValue.IsRequired	Tracks whether this property is required. (Inherited from ProvisionableConstruct)
IBicepValue.IsSecure	Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct)
IBicepValue.Kind	Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue	Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct)
IBicepValue.Self	Gets information about where this value was defined. (Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()	Make this value readonly. (Inherited from ProvisionableConstruct)
IBicepValue.Source	Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct)