Class Queue

Manages a ServiceBus Queue.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
    {
        Location = "West Europe",
    });
    var exampleNamespace = new Azure.ServiceBus.Namespace("exampleNamespace", new Azure.ServiceBus.NamespaceArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "Standard",
        Tags = 
        {
            { "source", "example" },
        },
    });
    var exampleQueue = new Azure.ServiceBus.Queue("exampleQueue", new Azure.ServiceBus.QueueArgs
    {
        ResourceGroupName = exampleResourceGroup.Name,
        NamespaceName = exampleNamespace.Name,
        EnablePartitioning = true,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Queue

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ServiceBus

Assembly: Pulumi.Azure.dll

Syntax

public class Queue : CustomResource

Constructors

Queue(String, QueueArgs, CustomResourceOptions)

Create a Queue resource with the given unique name, arguments, and options.

Declaration

public Queue(string name, QueueArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
QueueArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AutoDeleteOnIdle

The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.

Declaration

public Output<string> AutoDeleteOnIdle { get; }

Property Value

Type	Description
Output<System.String>

DeadLetteringOnMessageExpiration

Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.

Declaration

public Output<bool?> DeadLetteringOnMessageExpiration { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

DefaultMessageTtl

The ISO 8601 timespan duration of the TTL of messages sent to this queue. This is the default value used when TTL is not set on message itself.

Declaration

public Output<string> DefaultMessageTtl { get; }

Property Value

Type	Description
Output<System.String>

DuplicateDetectionHistoryTimeWindow

The ISO 8601 timespan duration during which duplicates can be detected. Default value is 10 minutes. (PT10M)

Declaration

public Output<string> DuplicateDetectionHistoryTimeWindow { get; }

Property Value

Type	Description
Output<System.String>

EnableExpress

Boolean flag which controls whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. Defaults to false for Basic and Standard. For Premium, it MUST be set to false.

Declaration

public Output<bool?> EnableExpress { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EnablePartitioning

Boolean flag which controls whether to enable the queue to be partitioned across multiple message brokers. Changing this forces a new resource to be created. Defaults to false for Basic and Standard. For Premium, it MUST be set to true.

Declaration

public Output<bool?> EnablePartitioning { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

LockDuration

The ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. Maximum value is 5 minutes. Defaults to 1 minute. (PT1M)

Declaration

public Output<string> LockDuration { get; }

Property Value

Type	Description
Output<System.String>

MaxDeliveryCount

Integer value which controls when a message is automatically deadlettered. Defaults to 10.

Declaration

public Output<int?> MaxDeliveryCount { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

MaxSizeInMegabytes

Integer value which controls the size of memory allocated for the queue. For supported values see the "Queue/topic size" section of this document.

Declaration

public Output<int> MaxSizeInMegabytes { get; }

Property Value

Type	Description
Output<System.Int32>

Name

Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NamespaceName

The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

Declaration

public Output<string> NamespaceName { get; }

Property Value

Type	Description
Output<System.String>

RequiresDuplicateDetection

Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.

Declaration

public Output<bool?> RequiresDuplicateDetection { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

RequiresSession

Boolean flag which controls whether the Queue requires sessions. This will allow ordered handling of unbounded sequences of related messages. With sessions enabled a queue can guarantee first-in-first-out delivery of messages. Changing this forces a new resource to be created. Defaults to false.

Declaration

public Output<bool?> RequiresSession { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

ResourceGroupName

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, QueueState, CustomResourceOptions)

Get an existing Queue resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Queue Get(string name, Input<string> id, QueueState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
QueueState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Queue