workspace_keys

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

Overview

Name	workspace_keys
Type	Resource
Id	azure.quantum.workspace_keys

Fields

Name	Datatype	Description
apiKeyEnabled	boolean	Indicator of enablement of the Quantum workspace Api keys.
primaryConnectionString	string	The connection string of the primary api key.
primaryKey	object	Azure quantum workspace Api key details.
secondaryConnectionString	string	The connection string of the secondary api key.
secondaryKey	object	Azure quantum workspace Api key details.

Methods

Name	Accessible by	Required Params	Description
list	SELECT	resourceGroupName, subscriptionId, workspaceName	Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

SELECT examples

Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

SELECT
apiKeyEnabled,
primaryConnectionString,
primaryKey,
secondaryConnectionString,
secondaryKey
FROM azure.quantum.workspace_keys
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';