workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.quantum.workspaces

Fields

The following fields are returned by SELECT queries:

get

Workspace details.

Name	Datatype	Description
identity	object	Managed Identity information.
location	string	The geo-location where the resource lives
properties	object	Gets or sets the properties. Define quantum workspace's specific properties.
systemData	object	System metadata
tags	object	Resource tags.

list_by_resource_group

Workspaces successfully returned.

Name	Datatype	Description
identity	object	Managed Identity information.
location	string	The geo-location where the resource lives
properties	object	Gets or sets the properties. Define quantum workspace's specific properties.
systemData	object	System metadata
tags	object	Resource tags.

list_by_subscription

Workspaces successfully returned.

Name	Datatype	Description
identity	object	Managed Identity information.
location	string	The geo-location where the resource lives
properties	object	Gets or sets the properties. Define quantum workspace's specific properties.
systemData	object	System metadata
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, workspaceName		Returns the Workspace resource associated with the given name.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets the list of Workspaces within a resource group.
list_by_subscription	select	subscriptionId		Gets the list of Workspaces within a Subscription.
create_or_update	insert	resourceGroupName, subscriptionId, workspaceName		Creates or updates a workspace resource.
delete	delete	resourceGroupName, subscriptionId, workspaceName		Deletes a Workspace resource.
update_tags	exec	resourceGroupName, subscriptionId, workspaceName		Updates an existing workspace's tags.
check_name_availability	exec	subscriptionId, location		Check the availability of the resource name.
regenerate_keys	exec	subscriptionId, resourceGroupName, workspaceName		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	string	The name of the Azure region.
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

get

Returns the Workspace resource associated with the given name.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.quantum.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

list_by_resource_group

Gets the list of Workspaces within a resource group.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.quantum.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Gets the list of Workspaces within a Subscription.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.quantum.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workspace resource.

INSERT INTO azure.quantum.workspaces (
data__properties,
data__identity,
data__tags,
data__location,
resourceGroupName,
subscriptionId,
workspaceName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}'
RETURNING
identity,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspaces resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the workspaces resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspaces resource.
    - name: properties
      value: object
      description: |
        Gets or sets the properties. Define quantum workspace's specific properties.
    - name: identity
      value: object
      description: |
        Managed Identity information.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Deletes a Workspace resource.

DELETE FROM azure.quantum.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND workspaceName = '{{ workspaceName }}' --required
;

Lifecycle Methods

update_tags

Updates an existing workspace's tags.

EXEC azure.quantum.workspaces.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@workspaceName='{{ workspaceName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

check_name_availability

Check the availability of the resource name.

EXEC azure.quantum.workspaces.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

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.workspaces.regenerate_keys 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required 
@@json=
'{
"keys": "{{ keys }}"
}'
;