queues

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

Overview

Name	queues
Type	Resource
Id	azure.service_bus.queues

Fields

The following fields are returned by SELECT queries:

get

Queue description successfully returned.

Name	Datatype	Description
properties	object	Queue Properties
systemData	object	The system meta data relating to this resource.

list_by_namespace

Queues successfully returned.

Name	Datatype	Description
properties	object	Queue Properties
systemData	object	The system meta data relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, queueName, subscriptionId		Returns a description for the specified queue.
list_by_namespace	select	resourceGroupName, namespaceName, subscriptionId	$skip, $top	Gets the queues within a namespace.
create_or_update	insert	resourceGroupName, namespaceName, queueName, subscriptionId		Creates or updates a Service Bus queue. This operation is idempotent.
delete	delete	resourceGroupName, namespaceName, queueName, subscriptionId		Deletes a queue from the specified namespace in a resource group.
regenerate_keys	exec	resourceGroupName, namespaceName, queueName, authorizationRuleName, subscriptionId, keyType		Regenerates the primary or secondary connection strings to the queue.

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
authorizationRuleName	string	The authorization rule name.
namespaceName	string	The namespace name
queueName	string	The queue name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$skip	integer	Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
$top	integer	May be used to limit the number of results to the most recent N usageDetails.

SELECT examples

get

Returns a description for the specified queue.

SELECT
properties,
systemData
FROM azure.service_bus.queues
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND queueName = '{{ queueName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_namespace

Gets the queues within a namespace.

SELECT
properties,
systemData
FROM azure.service_bus.queues
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a Service Bus queue. This operation is idempotent.

INSERT INTO azure.service_bus.queues (
data__properties,
resourceGroupName,
namespaceName,
queueName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ queueName }}',
'{{ subscriptionId }}'
RETURNING
properties,
systemData
;

Manifest

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

DELETE examples

delete

Deletes a queue from the specified namespace in a resource group.

DELETE FROM azure.service_bus.queues
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND queueName = '{{ queueName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

regenerate_keys

Regenerates the primary or secondary connection strings to the queue.

EXEC azure.service_bus.queues.regenerate_keys 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required, 
@queueName='{{ queueName }}' --required, 
@authorizationRuleName='{{ authorizationRuleName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"keyType": "{{ keyType }}", 
"key": "{{ key }}"
}'
;