Microsoft.Quantum workspaces

Article
02/11/2025

Bicep resource definition

The workspaces resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Quantum/workspaces resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Quantum/workspaces@2023-11-13-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    apiKeyEnabled: bool
    providers: [
      {
        applicationName: 'string'
        instanceUri: 'string'
        providerId: 'string'
        providerSku: 'string'
        provisioningState: 'string'
        resourceUsageId: 'string'
      }
    ]
    storageAccount: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.Quantum/workspaces

Name	Description	Value
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$` (required)
properties	Gets or sets the properties. Define quantum workspace's specific properties.	WorkspaceResourceProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

Provider

Name	Description	Value
applicationName	The provider's marketplace application display name.	string
instanceUri	A Uri identifying the specific instance of this provider.	string
providerId	Unique id of this provider.	string
providerSku	The sku associated with pricing information for this provider.	string
provisioningState	Provisioning status field	'Deleted' 'Deleting' 'Failed' 'Launching' 'Succeeded' 'Updating'
resourceUsageId	Id to track resource usage for the provider.	string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

WorkspaceResourceProperties

Name	Description	Value
apiKeyEnabled	Indicator of enablement of the Quantum workspace Api keys.	bool
providers	List of Providers selected for this Workspace	Provider[]
storageAccount	ARM Resource Id of the storage account associated with this workspace.	string

ARM template resource definition

The workspaces resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Quantum/workspaces resource, add the following JSON to your template.

{
  "type": "Microsoft.Quantum/workspaces",
  "apiVersion": "2023-11-13-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "apiKeyEnabled": "bool",
    "providers": [
      {
        "applicationName": "string",
        "instanceUri": "string",
        "providerId": "string",
        "providerSku": "string",
        "provisioningState": "string",
        "resourceUsageId": "string"
      }
    ],
    "storageAccount": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.Quantum/workspaces

Name	Description	Value
apiVersion	The api version	'2023-11-13-preview'
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$` (required)
properties	Gets or sets the properties. Define quantum workspace's specific properties.	WorkspaceResourceProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Quantum/workspaces'

Provider

Name	Description	Value
applicationName	The provider's marketplace application display name.	string
instanceUri	A Uri identifying the specific instance of this provider.	string
providerId	Unique id of this provider.	string
providerSku	The sku associated with pricing information for this provider.	string
provisioningState	Provisioning status field	'Deleted' 'Deleting' 'Failed' 'Launching' 'Succeeded' 'Updating'
resourceUsageId	Id to track resource usage for the provider.	string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

WorkspaceResourceProperties

Name	Description	Value
apiKeyEnabled	Indicator of enablement of the Quantum workspace Api keys.	bool
providers	List of Providers selected for this Workspace	Provider[]
storageAccount	ARM Resource Id of the storage account associated with this workspace.	string

Usage Examples

Terraform (AzAPI provider) resource definition

The workspaces resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Quantum/workspaces resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Quantum/workspaces@2023-11-13-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      apiKeyEnabled = bool
      providers = [
        {
          applicationName = "string"
          instanceUri = "string"
          providerId = "string"
          providerSku = "string"
          provisioningState = "string"
          resourceUsageId = "string"
        }
      ]
      storageAccount = "string"
    }
  })
}

Property Values

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.Quantum/workspaces

Name	Description	Value
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$` (required)
properties	Gets or sets the properties. Define quantum workspace's specific properties.	WorkspaceResourceProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Quantum/workspaces@2023-11-13-preview"

Provider

Name	Description	Value
applicationName	The provider's marketplace application display name.	string
instanceUri	A Uri identifying the specific instance of this provider.	string
providerId	Unique id of this provider.	string
providerSku	The sku associated with pricing information for this provider.	string
provisioningState	Provisioning status field	'Deleted' 'Deleting' 'Failed' 'Launching' 'Succeeded' 'Updating'
resourceUsageId	Id to track resource usage for the provider.	string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

WorkspaceResourceProperties

Name	Description	Value
apiKeyEnabled	Indicator of enablement of the Quantum workspace Api keys.	bool
providers	List of Providers selected for this Workspace	Provider[]
storageAccount	ARM Resource Id of the storage account associated with this workspace.	string

Share via

Microsoft.Quantum workspaces

Bicep resource definition

Resource format

Property Values

ManagedServiceIdentity

Microsoft.Quantum/workspaces

Provider

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

WorkspaceResourceProperties

ARM template resource definition

Resource format

Property Values

ManagedServiceIdentity

Microsoft.Quantum/workspaces

Provider

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

WorkspaceResourceProperties

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

ManagedServiceIdentity

Microsoft.Quantum/workspaces

Provider

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

WorkspaceResourceProperties

Feedback

Additional resources