keys

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

Overview

Name	keys
Type	Resource
Id	azure.event_hubs.keys

Fields

The following fields are returned by SELECT queries:

list

Connection strings successfully returned.

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 AuthorizationRule.
primaryConnectionString	string	Primary connection string of the created namespace AuthorizationRule.
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 AuthorizationRule.
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, eventHubName, authorizationRuleName, subscriptionId		Gets the ACS and SAS connection strings for the Event Hub.

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.
eventHubName	string	The Event Hub name
namespaceName	string	The Namespace name
resourceGroupName	string	Name of the resource group within the azure subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

list

Gets the ACS and SAS connection strings for the Event Hub.

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