hybrid_connections_keys

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

Overview

Name	hybrid_connections_keys
Type	Resource
Id	azure.relay.hybrid_connections_keys

Fields

The following fields are returned by SELECT queries:

list

Request to retrieve connection strings to the hybrid connection succeeded.

Name	Datatype	Description
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 secondary 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, hybridConnectionName, authorizationRuleName, subscriptionId		Primary and secondary connection strings to the hybrid connection.

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.
hybridConnectionName	string	The hybrid connection name.
namespaceName	string	The namespace name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

list

Primary and secondary connection strings to the hybrid connection.

SELECT
keyName,
primaryConnectionString,
primaryKey,
secondaryConnectionString,
secondaryKey
FROM azure.relay.hybrid_connections_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND hybridConnectionName = '{{ hybridConnectionName }}' -- required
AND authorizationRuleName = '{{ authorizationRuleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;