workspace

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

Overview

Name	workspace
Type	Resource
Id	azure.quantum.workspace

Fields

The following fields are returned by SELECT queries:

list_keys

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.

check_name_availability

Name	Datatype	Description
message	string	The detailed info regarding the reason associated with the Namespace.
nameAvailable	boolean	Indicator of availability of the Quantum Workspace resource name.
reason	string	The reason of unavailability.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_keys	select	resource_group_name, workspace_name, subscription_id		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.
check_name_availability	select	location_name, subscription_id		Check the availability of the resource name.
regenerate_keys	exec	resource_group_name, workspace_name, subscription_id		Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.

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
location_name	string	Location. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the quantum workspace resource. Required.

SELECT examples

list_keys

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
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

Check the availability of the resource name.

SELECT
message,
nameAvailable,
reason
FROM azure.quantum.workspace
WHERE location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

regenerate_keys

Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.

EXEC azure.quantum.workspace.regenerate_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keys": "{{ keys }}"
}'
;