Microsoft.Quantum (preview:2025-11-01)

2025/12/15 • 5 updated methods

Workspaces_ListBySubscription (updated)
Description :  Gets the list of Workspaces within a Subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "quotas",
                "Description": {
                  "new": "DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead.",
                  "old": "Quota allocations associated with this workspace. Available only for special providers."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The QuantumWorkspace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
workspaceKind:
{
Description: Whether this workspace is V1 or V2. ,
Enum:
{
V1: The workspace is a general-purpose workspace. ,
V2: The workspace is a V2 workspace. ,
}
,
Required: False ,
}
enum ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
quotas:
{
Description: DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead. ,
Required: False ,
}
{
standardMinutesLifetime:
{
Description: Lifetime limit for standard priority jobs execution in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
highMinutesLifetime:
{
Description: Lifetime limit for high priority jobs execution in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (updated)
Description :  Gets the list of Workspaces within a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "quotas",
                "Description": {
                  "new": "DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead.",
                  "old": "Quota allocations associated with this workspace. Available only for special providers."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The QuantumWorkspace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
workspaceKind:
{
Description: Whether this workspace is V1 or V2. ,
Enum:
{
V1: The workspace is a general-purpose workspace. ,
V2: The workspace is a V2 workspace. ,
}
,
Required: False ,
}
enum ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
quotas:
{
Description: DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead. ,
Required: False ,
}
{
standardMinutesLifetime:
{
Description: Lifetime limit for standard priority jobs execution in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
highMinutesLifetime:
{
Description: Lifetime limit for high priority jobs execution in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Get (updated)
Description :  Returns the Workspace resource associated with the given name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "quotas",
            "Description": {
              "new": "DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead.",
              "old": "Quota allocations associated with this workspace. Available only for special providers."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
workspaceKind:
{
Description: Whether this workspace is V1 or V2. ,
Enum:
{
V1: The workspace is a general-purpose workspace. ,
V2: The workspace is a V2 workspace. ,
}
,
Required: False ,
}
enum ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
quotas:
{
Description: DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead. ,
Required: False ,
}
{
standardMinutesLifetime:
{
Description: Lifetime limit for standard priority jobs execution in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
highMinutesLifetime:
{
Description: Lifetime limit for high priority jobs execution in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_CreateOrUpdate (updated)
Description :  Creates or updates a Workspace resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "quotas",
            "Description": {
              "new": "DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead.",
              "old": "Quota allocations associated with this workspace. Available only for special providers."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "quotas",
            "Description": {
              "new": "DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead.",
              "old": "Quota allocations associated with this workspace. Available only for special providers."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "quotas",
            "Description": {
              "new": "DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead.",
              "old": "Quota allocations associated with this workspace. Available only for special providers."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
resource:
{
Description: Workspace details. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
workspaceKind:
{
Description: Whether this workspace is V1 or V2. ,
Enum:
{
V1: The workspace is a general-purpose workspace. ,
V2: The workspace is a V2 workspace. ,
}
,
Required: False ,
}
enum ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
quotas:
{
Description: DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead. ,
Required: False ,
}
{
standardMinutesLifetime:
{
Description: Lifetime limit for standard priority jobs execution in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
highMinutesLifetime:
{
Description: Lifetime limit for high priority jobs execution in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
workspaceKind:
{
Description: Whether this workspace is V1 or V2. ,
Enum:
{
V1: The workspace is a general-purpose workspace. ,
V2: The workspace is a V2 workspace. ,
}
,
Required: False ,
}
enum ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
quotas:
{
Description: DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead. ,
Required: False ,
}
{
standardMinutesLifetime:
{
Description: Lifetime limit for standard priority jobs execution in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
highMinutesLifetime:
{
Description: Lifetime limit for high priority jobs execution in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The resource proxy definition object for Quantum Workspace. ,
}
{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
workspaceKind:
{
Description: Whether this workspace is V1 or V2. ,
Enum:
{
V1: The workspace is a general-purpose workspace. ,
V2: The workspace is a V2 workspace. ,
}
,
Required: False ,
}
enum ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
quotas:
{
Description: DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead. ,
Required: False ,
}
{
standardMinutesLifetime:
{
Description: Lifetime limit for standard priority jobs execution in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
highMinutesLifetime:
{
Description: Lifetime limit for high priority jobs execution in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_UpdateTags (updated)
Description :  Updates an existing Workspace's tags.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_UpdateTags",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "quotas",
            "Description": {
              "new": "DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead.",
              "old": "Quota allocations associated with this workspace. Available only for special providers."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the quantum workspace resource. ,
Required: True ,
}
string ,
properties:
{
Description: Parameters supplied to update tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define quantum workspace's specific properties. ,
Required: False ,
}
{
providers:
{
Description: List of Providers selected for this Workspace ,
Required: False ,
}
[
{
providerId:
{
Description: Unique id of this provider. ,
Required: False ,
}
string ,
providerSku:
{
Description: The sku associated with pricing information for this provider. ,
Required: False ,
}
string ,
instanceUri:
{
Description: A Uri identifying the specific instance of this provider. ,
Required: False ,
}
string ,
applicationName:
{
Description: The provider's marketplace application display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The provider is successfully provisioned. ,
Launching: The provider is starting provisioning. ,
Updating: The provider is updating. ,
Deleting: The provider is deleting. ,
Deleted: The provider is deleted. ,
Failed: The provider is failed. ,
}
,
Required: False ,
}
enum ,
resourceUsageId:
{
Description: Id to track resource usage for the provider. ,
Required: False ,
}
string ,
}
,
]
,
usable:
{
Description: Whether the current workspace is ready to accept Jobs. ,
Enum:
{
Yes: The workspace is usable and can accept jobs. ,
No: The workspace is not usable and cannot accept jobs. ,
Partial: The workspace is partially usable. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status field ,
Enum:
{
Succeeded: The Workspace provisioning is succeeded. ,
Failed: The Workspace provisioning failed. ,
Canceled: Resource creation was canceled. ,
ProviderLaunching: The Workspace is currently starting to provision a provider. ,
ProviderUpdating: The Workspace is currently updating a provider. ,
ProviderDeleting: The Workspace is currently deleting a provider. ,
ProviderProvisioning: The Workspace is currently provisioning a provider. ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: ARM Resource Id of the storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
workspaceKind:
{
Description: Whether this workspace is V1 or V2. ,
Enum:
{
V1: The workspace is a general-purpose workspace. ,
V2: The workspace is a V2 workspace. ,
}
,
Required: False ,
}
enum ,
endpointUri:
{
Description: The URI of the workspace endpoint. ,
Required: False ,
}
string ,
apiKeyEnabled:
{
Description: Indicator of enablement of the Quantum workspace Api keys. ,
Required: False ,
}
boolean ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
managedStorageAccount:
{
Description: ARM Resource Id of the managed storage account associated with this workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
quotas:
{
Description: DEPRECATED: This field is deprecated and will be removed in future versions. Please use the quotas under providers instead. ,
Required: False ,
}
{
standardMinutesLifetime:
{
Description: Lifetime limit for standard priority jobs execution in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
highMinutesLifetime:
{
Description: Lifetime limit for high priority jobs execution in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}