workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.quantum.workspaces

Fields

vw_workspaces

Name	Datatype	Description
api_key_enabled	text	field from the properties object
endpoint_uri	text	field from the properties object
identity	text	Managed Identity information.
location	text	The geo-location where the resource lives
providers	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
storage_account	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
usable	text	field from the properties object
workspaceName	text	field from the properties object

workspaces

Name	Datatype	Description
identity	object	Managed Identity information.
location	string	The geo-location where the resource lives
properties	object	Properties of a Workspace
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required 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.
check_name_availability	EXEC	locationName, subscriptionId	Check the availability of the resource name.
regenerate_keys	EXEC	resourceGroupName, subscriptionId, workspaceName	Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.
update_tags	EXEC	resourceGroupName, subscriptionId, workspaceName	Updates an existing workspace's tags.

SELECT examples

Gets the list of Workspaces within a Subscription.

vw_workspaces

SELECT
api_key_enabled,
endpoint_uri,
identity,
location,
providers,
provisioning_state,
resourceGroupName,
storage_account,
subscriptionId,
system_data,
tags,
usable,
workspaceName
FROM azure.quantum.vw_workspaces
WHERE subscriptionId = '{{ subscriptionId }}';

workspaces

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

INSERT example

Use the following StackQL query and manifest file to create a new workspaces resource.

All Properties

/*+ create */
INSERT INTO azure.quantum.workspaces (
resourceGroupName,
subscriptionId,
workspaceName,
properties,
identity,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: providers
          value:
            - - name: providerId
                value: string
              - name: providerSku
                value: string
              - name: instanceUri
                value: string
              - name: applicationName
                value: string
              - name: provisioningState
                value: string
              - name: resourceUsageId
                value: string
        - name: usable
          value: string
        - name: provisioningState
          value: string
        - name: storageAccount
          value: string
        - name: endpointUri
          value: string
        - name: apiKeyEnabled
          value: boolean
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: tags
      value: object
    - name: location
      value: string

DELETE example

Deletes the specified workspaces resource.

/*+ delete */
DELETE FROM azure.quantum.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';