queues

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

Overview

Name	queues
Type	Resource
Id	azure.storage.queues

Fields

The following fields are returned by SELECT queries:

get

OK -- returned table with the specified table name successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Queue resource properties. (x-ms-client-name: QueueProperties)
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

OK -- returned a list of queues successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	List Queue resource properties. (x-ms-client-name: QueueProperties)
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	resourceGroupName, accountName, subscriptionId, queueName		Gets the queue with the specified queue name, under the specified account if it exists.
list	select	resourceGroupName, accountName, subscriptionId	$maxpagesize, $filter	Gets a list of all the queues under the specified storage account
create	insert	resourceGroupName, accountName, subscriptionId, queueName		Creates a new queue with the specified queue name, under the specified account.
update	update	resourceGroupName, accountName, subscriptionId, queueName		Creates a new queue with the specified queue name, under the specified account.
delete	delete	resourceGroupName, accountName, subscriptionId, queueName		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
accountName	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.
queueName	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.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$filter	string	Optional, When specified, only the queues with a name starting with the given filter will be listed.
$maxpagesize	string	Optional, a maximum number of queues that should be included in a list queue response

SELECT examples

get

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.queues
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND queueName = '{{ queueName }}' -- required
;

list

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.queues
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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.queues (
data__properties,
resourceGroupName,
accountName,
subscriptionId,
queueName
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ subscriptionId }}',
'{{ queueName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: queues
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the queues resource.
    - name: accountName
      value: string
      description: Required parameter for the queues resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the queues resource.
    - name: queueName
      value: string
      description: Required parameter for the queues resource.
    - name: properties
      value: object
      description: |
        Queue resource properties.

UPDATE examples

update

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

UPDATE azure.storage.queues
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND queueName = '{{ queueName }}' --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.queues
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND queueName = '{{ queueName }}' --required
;