Microsoft.Quantum workspaces
Bicep resource definition
The workspaces resource type can be deployed to:
- 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@2022-01-10-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
}
properties: {
providers: [
{
applicationName: 'string'
instanceUri: 'string'
providerId: 'string'
providerSku: 'string'
provisioningState: 'string'
resourceUsageId: 'string'
}
]
storageAccount: 'string'
}
}
Property values
workspaces
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 2-54 Valid characters: Alphanumerics and hyphens. Can't start or end with hyphen. |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| identity | Managed Identity information. | QuantumWorkspaceIdentity |
| properties | Gets or sets the properties. Define quantum workspace's specific properties. | WorkspaceResourceProperties |
QuantumWorkspaceIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' |
WorkspaceResourceProperties
| Name | Description | Value |
|---|---|---|
| providers | List of Providers selected for this Workspace | Provider[] |
| storageAccount | ARM Resource Id of the storage account associated with this workspace. | string |
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 |
ARM template resource definition
The workspaces resource type can be deployed to:
- 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": "2022-01-10-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string"
},
"properties": {
"providers": [
{
"applicationName": "string",
"instanceUri": "string",
"providerId": "string",
"providerSku": "string",
"provisioningState": "string",
"resourceUsageId": "string"
}
],
"storageAccount": "string"
}
}
Property values
workspaces
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Quantum/workspaces' |
| apiVersion | The resource api version | '2022-01-10-preview' |
| name | The resource name | string (required) Character limit: 2-54 Valid characters: Alphanumerics and hyphens. Can't start or end with hyphen. |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| identity | Managed Identity information. | QuantumWorkspaceIdentity |
| properties | Gets or sets the properties. Define quantum workspace's specific properties. | WorkspaceResourceProperties |
QuantumWorkspaceIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' |
WorkspaceResourceProperties
| Name | Description | Value |
|---|---|---|
| providers | List of Providers selected for this Workspace | Provider[] |
| storageAccount | ARM Resource Id of the storage account associated with this workspace. | string |
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 |
Terraform (AzAPI provider) resource definition
The workspaces resource type can be deployed to:
- 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@2022-01-10-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
providers = [
{
applicationName = "string"
instanceUri = "string"
providerId = "string"
providerSku = "string"
provisioningState = "string"
resourceUsageId = "string"
}
]
storageAccount = "string"
}
})
}
Property values
workspaces
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Quantum/workspaces@2022-01-10-preview" |
| name | The resource name | string (required) Character limit: 2-54 Valid characters: Alphanumerics and hyphens. Can't start or end with hyphen. |
| location | The geo-location where the resource lives | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| identity | Managed Identity information. | QuantumWorkspaceIdentity |
| properties | Gets or sets the properties. Define quantum workspace's specific properties. | WorkspaceResourceProperties |
QuantumWorkspaceIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | "SystemAssigned" |
WorkspaceResourceProperties
| Name | Description | Value |
|---|---|---|
| providers | List of Providers selected for this Workspace | Provider[] |
| storageAccount | ARM Resource Id of the storage account associated with this workspace. | string |
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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for