How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Quantum Workspaces API

The Workspaces API from Microsoft Azure Quantum — 6 operation(s) for workspaces.

Microsoft Azure Quantum Workspaces API is one of 8 APIs that Microsoft Azure Quantum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 9 operations across 6 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 2026-01-15-preview.

9 operations 6 paths 15 schemas 1 DELETE3 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-01-15-preview
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Microsoft Azure Quantum Workspaces API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-ms-quantum-api-key (AzureApiKeyAuth). It supports OAuth 2.0 (AzureEntraAuth) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

  • AzureApiKeyAuth — Azure Api-Key Authentication
  • AzureEntraAuth — Azure Entra OAuth2 Authentication

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 9
POST
/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{location}/checkNameAvailability
Check the availability of the resource name for the given location.
Workspaces_CheckNameAvailability 3 params body → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces
Gets the list of Workspaces within a Subscription.
Workspaces_ListBySubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces
Gets the list of Workspaces within a resource group.
Workspaces_ListByResourceGroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
Returns the Workspace resource associated with the given name.
Workspaces_Get 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
Creates or updates a Workspace resource.
Workspaces_CreateOrUpdate 4 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
Updates an existing Workspace's tags.
Workspaces_UpdateTags 4 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}
Deletes a Workspace resource.
Workspaces_Delete 4 params → 202204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys
Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regener…
Workspaces_ListKeys 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/regenerateKey
Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.
Workspaces_RegenerateKeys 4 params body → 204default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are WorkspaceResourceProperties (9 properties), Provider (7 properties), ListKeysResult (5 properties), ApiKey (2 properties). Each schema is shown below with its type and property counts.

ApiKey
object
Azure quantum workspace Api key details.
2 properties
QuotaAllocations
object
Quota allocations with each field representing different quota type.
2 properties 1 required
ProviderStatus
string
Provisioning status field
Provider
object
Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs.
7 properties
ListKeysResult
object
Result of list Api keys and connection strings.
5 properties
QuantumWorkspace
object
The resource proxy definition object for Quantum Workspace.
2 properties
WorkspaceProvisioningStatus
string
The Workspace provisioning status.
UsableStatus
string
Whether the current workspace is ready to accept Jobs.
StorageAccountResourceId
string
ARM Resource Id of a storage account.
WorkspaceResourceProperties
object
Properties of a Workspace
9 properties
ApiKeys
object
List of api keys to be generated.
1 property
QuantumWorkspaceTagsUpdate
object
The type used for updating tags in QuantumWorkspace resources.
1 property
WorkspaceKind
string
The workspace type.
KeyType
string
The API key type.
QuantumWorkspaceListResult
object
The response of a QuantumWorkspace list operation.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-quantum-workspaces-api-openapi.yml Raw ↑

Other APIs Microsoft Azure Quantum publishes across the network.

Q# Quantum Programming Language
Microsoft Quantum Resource Estimator
Azure Quantum Python SDK
Microsoft Azure Quantum Offerings API
Microsoft Azure Quantum Operations API
Microsoft Azure Quantum Subscriptions API
Microsoft Azure Quantum SuiteOffers API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Quantum Workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.