queues_authorization_rules

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

Overview

Name	queues_authorization_rules
Type	Resource
Id	azure.service_bus.queues_authorization_rules

Fields

The following fields are returned by SELECT queries:

get

Authorization rule successfully returned.

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

list

Authorization rules successfully returned.

Name	Datatype	Description
properties		AuthorizationRule 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, authorizationRuleName, subscriptionId		Gets an authorization rule for a queue by rule name.
list	select	resourceGroupName, namespaceName, queueName, subscriptionId		Gets all authorization rules for a queue.
create_or_update	insert	resourceGroupName, namespaceName, queueName, authorizationRuleName, subscriptionId		Creates an authorization rule for a queue.
delete	delete	resourceGroupName, namespaceName, queueName, authorizationRuleName, subscriptionId		Deletes a queue authorization rule.

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.

SELECT examples

get

Gets an authorization rule for a queue by rule name.

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

list

Gets all authorization rules for a queue.

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

INSERT examples

create_or_update

Creates an authorization rule for a queue.

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

Manifest

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

DELETE examples

delete

Deletes a queue authorization rule.

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