Share via

Microsoft.Storage storageAccounts/queueServices/queues 2022-05-01

Bicep resource definition

The storageAccounts/queueServices/queues resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/queueServices/queues resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Storage/storageAccounts/queueServices/queues@2022-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    metadata: {
      {customized property}: 'string'
    }
  }
}

Property Values

Microsoft.Storage/storageAccounts/queueServices/queues

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: storageAccounts/queueServices
properties Queue resource properties. QueueProperties

QueueProperties

Name Description Value
metadata A name-value pair that represents queue metadata. QueuePropertiesMetadata

QueuePropertiesMetadata

Name Description Value

ARM template resource definition

The storageAccounts/queueServices/queues resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/queueServices/queues resource, add the following JSON to your template.

{
  "type": "Microsoft.Storage/storageAccounts/queueServices/queues",
  "apiVersion": "2022-05-01",
  "name": "string",
  "properties": {
    "metadata": {
      "{customized property}": "string"
    }
  }
}

Property Values

Microsoft.Storage/storageAccounts/queueServices/queues

Name Description Value
apiVersion The api version '2022-05-01'
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$ (required)
properties Queue resource properties. QueueProperties
type The resource type 'Microsoft.Storage/storageAccounts/queueServices/queues'

QueueProperties

Name Description Value
metadata A name-value pair that represents queue metadata. QueuePropertiesMetadata

QueuePropertiesMetadata

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The storageAccounts/queueServices/queues resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/queueServices/queues resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/queueServices/queues@2022-05-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      metadata = {
        {customized property} = "string"
      }
    }
  }
}

Property Values

Microsoft.Storage/storageAccounts/queueServices/queues

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: storageAccounts/queueServices
properties Queue resource properties. QueueProperties
type The resource type "Microsoft.Storage/storageAccounts/queueServices/queues@2022-05-01"

QueueProperties

Name Description Value
metadata A name-value pair that represents queue metadata. QueuePropertiesMetadata

QueuePropertiesMetadata

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Queue within Azure Storage.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2022-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

data "azapi_resource" "queueService" {
  type      = "Microsoft.Storage/storageAccounts/queueServices@2022-09-01"
  parent_id = azapi_resource.storageAccount.id
  name      = "default"
}

resource "azapi_resource" "queue" {
  type      = "Microsoft.Storage/storageAccounts/queueServices/queues@2022-09-01"
  parent_id = data.azapi_resource.queueService.id
  name      = var.resource_name
  body = {
    properties = {
      metadata = {
        key = "value"
      }
    }
  }
  response_export_values = ["*"]
}