Queue

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

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 exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var exampleQueue = new Azure.Storage.Queue("exampleQueue", new Azure.Storage.QueueArgs
        {
            StorageAccountName = exampleAccount.Name,
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewQueue(ctx, "exampleQueue", &storage.QueueArgs{
			StorageAccountName: exampleAccount.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleQueue = new azure.storage.Queue("exampleQueue", {storageAccountName: exampleAccount.name});

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_queue = azure.storage.Queue("exampleQueue", storage_account_name=example_account.name)

Example coming soon!

Create Queue Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);

@overload
def Queue(resource_name: str,
          args: QueueArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Queue(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          storage_account_name: Optional[str] = None,
          metadata: Optional[Mapping[str, str]] = None,
          name: Optional[str] = None)

func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)

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

public Queue(String name, QueueArgs args)
public Queue(String name, QueueArgs args, CustomResourceOptions options)

type: azure:storage:Queue
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args QueueArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args QueueArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args QueueArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args QueueArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args QueueArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var azureQueueResource = new Azure.Storage.Queue("azureQueueResource", new()
{
    StorageAccountName = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
});

example, err := storage.NewQueue(ctx, "azureQueueResource", &storage.QueueArgs{
	StorageAccountName: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

var azureQueueResource = new com.pulumi.azure.storage.Queue("azureQueueResource", com.pulumi.azure.storage.QueueArgs.builder()
    .storageAccountName("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .build());

azure_queue_resource = azure.storage.Queue("azureQueueResource",
    storage_account_name="string",
    metadata={
        "string": "string",
    },
    name="string")

const azureQueueResource = new azure.storage.Queue("azureQueueResource", {
    storageAccountName: "string",
    metadata: {
        string: "string",
    },
    name: "string",
});

type: azure:storage:Queue
properties:
    metadata:
        string: string
    name: string
    storageAccountName: string

Queue Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Queue resource accepts the following input properties:

StorageAccountName string: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.
Metadata Dictionary<string, string>: A mapping of MetaData which should be assigned to this Storage Queue.
Name string: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

StorageAccountName string: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.
Metadata map[string]string: A mapping of MetaData which should be assigned to this Storage Queue.
Name string: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

storageAccountName String: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.
metadata Map<String,String>: A mapping of MetaData which should be assigned to this Storage Queue.
name String: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

storageAccountName string: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.
metadata {[key: string]: string}: A mapping of MetaData which should be assigned to this Storage Queue.
name string: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

storage_account_name str: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.
metadata Mapping[str, str]: A mapping of MetaData which should be assigned to this Storage Queue.
name str: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

storageAccountName String: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.
metadata Map<String>: A mapping of MetaData which should be assigned to this Storage Queue.
name String: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

Outputs

All input properties are implicitly available as output properties. Additionally, the Queue resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Queue Resource

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

public static get(name: string, id: Input<ID>, state?: QueueState, opts?: CustomResourceOptions): Queue

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        storage_account_name: Optional[str] = None) -> Queue

func GetQueue(ctx *Context, name string, id IDInput, state *QueueState, opts ...ResourceOption) (*Queue, error)

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

public static Queue get(String name, Output<String> id, QueueState state, CustomResourceOptions options)

resources:  _:    type: azure:storage:Queue    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Metadata Dictionary<string, string>: A mapping of MetaData which should be assigned to this Storage Queue.
Name string: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.
StorageAccountName string: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.

Metadata map[string]string: A mapping of MetaData which should be assigned to this Storage Queue.
Name string: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.
StorageAccountName string: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.

metadata Map<String,String>: A mapping of MetaData which should be assigned to this Storage Queue.
name String: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.
storageAccountName String: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.

metadata {[key: string]: string}: A mapping of MetaData which should be assigned to this Storage Queue.
name string: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.
storageAccountName string: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.

metadata Mapping[str, str]: A mapping of MetaData which should be assigned to this Storage Queue.
name str: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.
storage_account_name str: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.

metadata Map<String>: A mapping of MetaData which should be assigned to this Storage Queue.
name String: The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.
storageAccountName String: Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.

Import

Storage Queue’s can be imported using the resource id, e.g.

 $ pulumi import azure:storage/queue:Queue queue1 https://example.queue.core.windows.net/queue1

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

azure.storage.Queue

On this page

On this page

Example Usage

Create Queue Resource

Constructor syntax

Parameters

Constructor example

Queue Resource Properties

Inputs

Outputs

Look up Existing Queue Resource

Import

Package Details

On this page

On this page