keys

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

Overview

Name	keys
Type	Resource
Id	azure.web_pubsub.keys

Fields

The following fields are returned by SELECT queries:

list

Success. The response describes access keys of the resource.

Name	Datatype	Description
primaryConnectionString	string	Connection string constructed via the primaryKey
primaryKey	string	The primary access key.
secondaryConnectionString	string	Connection string constructed via the secondaryKey
secondaryKey	string	The secondary access key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, resourceGroupName, resourceName		Get the access keys of the resource.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

list

Get the access keys of the resource.

SELECT
primaryConnectionString,
primaryKey,
secondaryConnectionString,
secondaryKey
FROM azure.web_pubsub.keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;