queue

Creates, updates, deletes, gets or lists a queue resource.

Overview

Name	queue
Type	Resource
Id	azure.storage.queue

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
approximateMessageCount	integer	Integer indicating an approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher.
metadata	object	A name-value pair that represents queue metadata.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
metadata	object	A name-value pair that represents queue metadata.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, queue_name, subscription_id		Gets the queue with the specified queue name, under the specified account if it exists.
list	select	resource_group_name, account_name, subscription_id	$maxpagesize, $filter	Gets a list of all the queues under the specified storage account.
create	insert	resource_group_name, account_name, queue_name, subscription_id		Creates a new queue with the specified queue name, under the specified account.
update	update	resource_group_name, account_name, queue_name, subscription_id		Creates a new queue with the specified queue name, under the specified account.
delete	delete	resource_group_name, account_name, queue_name, subscription_id		Deletes the queue with the specified queue name, under the specified account if it exists.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
queue_name	string	A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	Optional, When specified, only the queues with a name starting with the given filter will be listed. Default value is None.
$maxpagesize	string

SELECT examples

get

Gets the queue with the specified queue name, under the specified account if it exists.

SELECT
id,
name,
approximateMessageCount,
metadata,
systemData,
type
FROM azure.storage.queue
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND queue_name = '{{ queue_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of all the queues under the specified storage account.

SELECT
id,
name,
metadata,
systemData,
type
FROM azure.storage.queue
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $maxpagesize = '{{ $maxpagesize }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates a new queue with the specified queue name, under the specified account.

INSERT INTO azure.storage.queue (
properties,
resource_group_name,
account_name,
queue_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ queue_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: queue
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the queue resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the queue resource.
  - name: queue_name
    value: "{{ queue_name }}"
    description: Required parameter for the queue resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the queue resource.
  - name: properties
    description: |
      Queue resource properties.
    value:
      metadata: "{{ metadata }}"
      approximateMessageCount: {{ approximateMessageCount }}

UPDATE examples

update

Creates a new queue with the specified queue name, under the specified account.

UPDATE azure.storage.queue
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND queue_name = '{{ queue_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the queue with the specified queue name, under the specified account if it exists.

DELETE FROM azure.storage.queue
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND queue_name = '{{ queue_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;