workspace_keys

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

Overview

Name	workspace_keys
Type	Resource
Id	azure.quantum.workspace_keys

Fields

The following fields are returned by SELECT queries:

list

The request was successful.

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	The quantum workspace primary api key.
secondaryConnectionString	string	The connection string of the secondary api key.
secondaryKey	object	The quantum workspace secondary api key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, resourceGroupName, 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.

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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	string	The name of the quantum workspace resource.

SELECT examples

list

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 subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;