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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
apiKeyEnabled	boolean	Indicator of enablement of the Quantum workspace Api keys.
endpointUri	string	The URI of the workspace endpoint.
identity	object	Managed Identity information.
location	string	The geo-location where the resource lives. Required.
providers	array	List of Providers selected for this Workspace.
provisioningState	string	Provisioning status field. Known values are: "Succeeded", "ProviderLaunching", "ProviderUpdating", "ProviderDeleting", "ProviderProvisioning", and "Failed".
storageAccount	string	ARM Resource Id of the storage account associated with this workspace.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
usable	string	Whether the current workspace is ready to accept Jobs. Known values are: "Yes", "No", and "Partial".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
apiKeyEnabled	boolean	Indicator of enablement of the Quantum workspace Api keys.
endpointUri	string	The URI of the workspace endpoint.
identity	object	Managed Identity information.
location	string	The geo-location where the resource lives. Required.
providers	array	List of Providers selected for this Workspace.
provisioningState	string	Provisioning status field. Known values are: "Succeeded", "ProviderLaunching", "ProviderUpdating", "ProviderDeleting", "ProviderProvisioning", and "Failed".
storageAccount	string	ARM Resource Id of the storage account associated with this workspace.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
usable	string	Whether the current workspace is ready to accept Jobs. Known values are: "Yes", "No", and "Partial".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
apiKeyEnabled	boolean	Indicator of enablement of the Quantum workspace Api keys.
endpointUri	string	The URI of the workspace endpoint.
identity	object	Managed Identity information.
location	string	The geo-location where the resource lives. Required.
providers	array	List of Providers selected for this Workspace.
provisioningState	string	Provisioning status field. Known values are: "Succeeded", "ProviderLaunching", "ProviderUpdating", "ProviderDeleting", "ProviderProvisioning", and "Failed".
storageAccount	string	ARM Resource Id of the storage account associated with this workspace.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
usable	string	Whether the current workspace is ready to accept Jobs. Known values are: "Yes", "No", and "Partial".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, subscription_id		Returns the Workspace resource associated with the given name.
list_by_resource_group	select	resource_group_name, subscription_id		Gets the list of Workspaces within a resource group.
list_by_subscription	select	subscription_id		Gets the list of Workspaces within a Subscription.
create_or_update	insert	resource_group_name, workspace_name, subscription_id, location		Creates or updates a workspace resource.
update_tags	update	resource_group_name, workspace_name, subscription_id		Updates an existing workspace's tags.
create_or_update	replace	resource_group_name, workspace_name, subscription_id, location		Creates or updates a workspace resource.
delete	delete	resource_group_name, workspace_name, subscription_id		Deletes a Workspace resource.

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
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

get

Returns the Workspace resource associated with the given name.

SELECT
id,
name,
apiKeyEnabled,
endpointUri,
identity,
location,
providers,
provisioningState,
storageAccount,
systemData,
tags,
type,
usable
FROM azure.quantum.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets the list of Workspaces within a resource group.

SELECT
id,
name,
apiKeyEnabled,
endpointUri,
identity,
location,
providers,
provisioningState,
storageAccount,
systemData,
tags,
type,
usable
FROM azure.quantum.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets the list of Workspaces within a Subscription.

SELECT
id,
name,
apiKeyEnabled,
endpointUri,
identity,
location,
providers,
provisioningState,
storageAccount,
systemData,
tags,
type,
usable
FROM azure.quantum.workspaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workspace resource.

INSERT INTO azure.quantum.workspaces (
tags,
location,
properties,
identity,
resource_group_name,
workspace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspaces resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Gets or sets the properties. Define quantum workspace's specific properties.
    value:
      providers:
        - providerId: "{{ providerId }}"
          providerSku: "{{ providerSku }}"
          instanceUri: "{{ instanceUri }}"
          applicationName: "{{ applicationName }}"
          provisioningState: "{{ provisioningState }}"
          resourceUsageId: "{{ resourceUsageId }}"
      usable: "{{ usable }}"
      provisioningState: "{{ provisioningState }}"
      storageAccount: "{{ storageAccount }}"
      endpointUri: "{{ endpointUri }}"
      apiKeyEnabled: {{ apiKeyEnabled }}
  - name: identity
    description: |
      Managed Identity information.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"

UPDATE examples

update_tags

Updates an existing workspace's tags.

UPDATE azure.quantum.workspaces
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a workspace resource.

REPLACE azure.quantum.workspaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Workspace resource.

DELETE FROM azure.quantum.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;