topics_authorization_rules

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

Overview

Name	topics_authorization_rules
Type	Resource
Id	azure.service_bus.topics_authorization_rules

Fields

The following fields are returned by SELECT queries:

get

Topic authorization rule returned successfully.

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, topicName, authorizationRuleName, subscriptionId		Returns the specified authorization rule.
list	select	resourceGroupName, namespaceName, topicName, subscriptionId		Gets authorization rules for a topic.
create_or_update	insert	resourceGroupName, namespaceName, topicName, authorizationRuleName, subscriptionId		Creates an authorization rule for the specified topic.
delete	delete	resourceGroupName, namespaceName, topicName, authorizationRuleName, subscriptionId		Deletes a topic 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
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.
topicName	string	The topic name.

SELECT examples

get

Returns the specified authorization rule.

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

list

Gets authorization rules for a topic.

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

INSERT examples

create_or_update

Creates an authorization rule for the specified topic.

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

Manifest

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

DELETE examples

delete

Deletes a topic authorization rule.

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