Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2025-01-01-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
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 |
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 |
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": "2025-01-01-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
Microsoft.Quantum/workspaces
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-01-01-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' |
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 |
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@2025-01-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
apiKeyEnabled = bool
providers = [
{
applicationName = "string"
instanceUri = "string"
providerId = "string"
providerSku = "string"
provisioningState = "string"
resourceUsageId = "string"
}
]
storageAccount = "string"
}
}
}
Property Values
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@2025-01-01-preview" |
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 |
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 |