queues

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

Overview

Name	queues
Type	Resource
Id	azure.service_bus.queues

Fields

vw_queues

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
accessed_at	text	field from the properties object
auto_delete_on_idle	text	field from the properties object
count_details	text	field from the properties object
created_at	text	field from the properties object
dead_lettering_on_message_expiration	text	field from the properties object
default_message_time_to_live	text	field from the properties object
duplicate_detection_history_time_window	text	field from the properties object
enable_batched_operations	text	field from the properties object
enable_express	text	field from the properties object
enable_partitioning	text	field from the properties object
forward_dead_lettered_messages_to	text	field from the properties object
forward_to	text	field from the properties object
location	text	The geo-location where the resource lives
lock_duration	text	field from the properties object
max_delivery_count	text	field from the properties object
max_message_size_in_kilobytes	text	field from the properties object
max_size_in_megabytes	text	field from the properties object
message_count	text	field from the properties object
namespaceName	text	field from the properties object
queueName	text	field from the properties object
requires_duplicate_detection	text	field from the properties object
requires_session	text	field from the properties object
resourceGroupName	text	field from the properties object
size_in_bytes	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updated_at	text	field from the properties object

queues

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
location	string	The geo-location where the resource lives
properties	object	The Queue Properties definition.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	namespaceName, queueName, resourceGroupName, subscriptionId	Returns a description for the specified queue.
list_by_namespace	SELECT	namespaceName, resourceGroupName, subscriptionId	Gets the queues within a namespace.
create_or_update	INSERT	namespaceName, queueName, resourceGroupName, subscriptionId	Creates or updates a Service Bus queue. This operation is idempotent.
delete	DELETE	namespaceName, queueName, resourceGroupName, subscriptionId	Deletes a queue from the specified namespace in a resource group.
regenerate_keys	EXEC	authorizationRuleName, namespaceName, queueName, resourceGroupName, subscriptionId, data__keyType	Regenerates the primary or secondary connection strings to the queue.

SELECT examples

Gets the queues within a namespace.

vw_queues

SELECT
id,
name,
accessed_at,
auto_delete_on_idle,
count_details,
created_at,
dead_lettering_on_message_expiration,
default_message_time_to_live,
duplicate_detection_history_time_window,
enable_batched_operations,
enable_express,
enable_partitioning,
forward_dead_lettered_messages_to,
forward_to,
location,
lock_duration,
max_delivery_count,
max_message_size_in_kilobytes,
max_size_in_megabytes,
message_count,
namespaceName,
queueName,
requires_duplicate_detection,
requires_session,
resourceGroupName,
size_in_bytes,
status,
subscriptionId,
system_data,
type,
updated_at
FROM azure.service_bus.vw_queues
WHERE namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

queues

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.service_bus.queues
WHERE namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new queues resource.

All Properties

/*+ create */
INSERT INTO azure.service_bus.queues (
namespaceName,
queueName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ namespaceName }}',
'{{ queueName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: countDetails
          value:
            - name: activeMessageCount
              value: integer
            - name: deadLetterMessageCount
              value: integer
            - name: scheduledMessageCount
              value: integer
            - name: transferMessageCount
              value: integer
            - name: transferDeadLetterMessageCount
              value: integer
        - name: createdAt
          value: string
        - name: updatedAt
          value: string
        - name: accessedAt
          value: string
        - name: sizeInBytes
          value: integer
        - name: messageCount
          value: integer
        - name: lockDuration
          value: string
        - name: maxSizeInMegabytes
          value: integer
        - name: maxMessageSizeInKilobytes
          value: integer
        - name: requiresDuplicateDetection
          value: boolean
        - name: requiresSession
          value: boolean
        - name: defaultMessageTimeToLive
          value: string
        - name: deadLetteringOnMessageExpiration
          value: boolean
        - name: duplicateDetectionHistoryTimeWindow
          value: string
        - name: maxDeliveryCount
          value: integer
        - name: status
          value: []
        - name: enableBatchedOperations
          value: boolean
        - name: autoDeleteOnIdle
          value: string
        - name: enablePartitioning
          value: boolean
        - name: enableExpress
          value: boolean
        - name: forwardTo
          value: string
        - name: forwardDeadLetteredMessagesTo
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string

DELETE example

Deletes the specified queues resource.

/*+ delete */
DELETE FROM azure.service_bus.queues
WHERE namespaceName = '{{ namespaceName }}'
AND queueName = '{{ queueName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';