topics

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

Overview

Name	topics
Type	Resource
Id	azure.service_bus.topics

Fields

The following fields are returned by SELECT queries:

get

Topic description successfully retrieved.

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

list_by_namespace

Successfully retrieved list of topics.

Name	Datatype	Description
properties	object	Properties of topic resource.
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, subscriptionId		Returns a description for the specified topic.
list_by_namespace	select	resourceGroupName, namespaceName, subscriptionId	$skip, $top	Gets all the topics in a namespace.
create_or_update	insert	resourceGroupName, namespaceName, topicName, subscriptionId		Creates a topic in the specified namespace.
delete	delete	resourceGroupName, namespaceName, topicName, subscriptionId		Deletes a topic from the specified namespace and resource group.
regenerate_keys	exec	resourceGroupName, namespaceName, topicName, authorizationRuleName, subscriptionId, keyType		Regenerates primary or secondary connection strings for the topic.

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.
$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 topic.

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

list_by_namespace

Gets all the topics in a namespace.

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

INSERT examples

create_or_update

Creates a topic in the specified namespace.

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

Manifest

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

DELETE examples

delete

Deletes a topic from the specified namespace and resource group.

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

Lifecycle Methods

regenerate_keys

Regenerates primary or secondary connection strings for the topic.

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