topics_keys

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

Overview

Name	topics_keys
Type	Resource
Id	azure.service_bus.topics_keys

Fields

The following fields are returned by SELECT queries:

list

Connection strings successfully retrieved.

Name	Datatype	Description
aliasPrimaryConnectionString	string	Primary connection string of the alias if GEO DR is enabled
aliasSecondaryConnectionString	string	Secondary connection string of the alias if GEO DR is enabled
keyName	string	A string that describes the authorization rule.
primaryConnectionString	string	Primary connection string of the created namespace authorization rule.
primaryKey	string	A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondaryConnectionString	string	Secondary connection string of the created namespace authorization rule.
secondaryKey	string	A base64-encoded 256-bit primary key for signing and validating the SAS token.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, namespaceName, topicName, authorizationRuleName, subscriptionId		Gets the primary and 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.

SELECT examples

list

Gets the primary and secondary connection strings for the topic.

SELECT
aliasPrimaryConnectionString,
aliasSecondaryConnectionString,
keyName,
primaryConnectionString,
primaryKey,
secondaryConnectionString,
secondaryKey
FROM azure.service_bus.topics_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND topicName = '{{ topicName }}' -- required
AND authorizationRuleName = '{{ authorizationRuleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;