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 Subscriptions API

The Subscriptions API from Microsoft Azure Quantum — 12 operation(s) for subscriptions.

Microsoft Azure Quantum Subscriptions 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 Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

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

15 operations 12 paths 35 schemas 1 DELETE8 GET1 PATCH3 POST2 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 Subscriptions 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 15

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

Subscriptions 15
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobUpdateOptions/{jobId}
Update job properties.
Jobs_Update 5 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs
List all jobs.
Jobs_List 8 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}
Get job by its id.
Jobs_Get 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}
Create a new job.
Jobs_Create 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}
Delete a job by its id. Use for cancellation in versions before 2025-12-01-preview.
Jobs_Delete 5 params → 204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}:cancel
Request the cancellation of an existing job.
Jobs_Cancel 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus
List all providers in the workspace with their respective status.
Providers_List 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas
List quotas for the given workspace.
Quotas_List 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions
List all Sessions.
Sessions_Listv2 8 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}
Get Session by its id.
Sessions_Get 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}
Open a new session.
Sessions_Open 5 params body → 200201default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}:close
Close an existing session.
Sessions_Close 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}/jobs
List jobs in a session.
SessionsJobs_List 9 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri
Gets a URL with SAS token for a container/blob in the storage account associated with the workspace. Starting with version 2026-01-15-preview, when used for a container the container is also created…
Storage_GetSasUri 4 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/topLevelItems
List top-level items.
TopLevelItems_Listv2 8 params → 200default

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are ItemDetails (19 properties), JobDetails (13 properties), Quota (7 properties), TargetStatus (7 properties). Each schema is shown below with its type and property counts.

MeterPeriod
string
The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas.
PagedSessionDetails
object
Paged collection of SessionDetails items
2 properties 1 required
CostEstimate
object
The job cost billed by the provider. The final cost on your bill might be slightly different due to added taxes and currency conversion rates.
3 properties 2 required
TargetAvailability
string
Target availability.
PagedQuota
object
Paged collection of Quota items
2 properties 1 required
JobDetails
object
A job to be run in the workspace.
13 properties 2 required
PagedJobDetails
object
Paged collection of JobDetails items
2 properties 1 required
JobUpdateOptionsUpdate
object
Options for updating a job.
3 properties
Errors.WorkspaceItemError
object
The error object.
5 properties 2 required
JobType
string
The type of the job.
Quota
object
Quota information.
7 properties 7 required
UsageEvent
object
Usage event details.
6 properties 6 required
ProviderStatus
object
Provider status.
3 properties 3 required
Priority
string
Job priority levels.
SessionDetails
object
Session, a logical grouping of jobs.
3 properties 2 required
WorkspaceItemId
string
Id of the workspace item.
SasUriResponse
object
SAS URI operation response.
1 property 1 required
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property 1 required
QuantumComputingData
object
Quantum computing data.
1 property 1 required
DimensionScope
string
The scope at which the quota is applied to.
PagedItemDetails
object
Paged collection of ItemDetails items
2 properties 1 required
Usage
object
Resource usage metrics represented as key-value pairs. Keys are provider-defined metric names (e.g. "standardMinutes", "shots") and values are the correspondin…
SessionJobFailurePolicy
string
Policy controlling the behavior of the Session when a job in the session fails.
JobUpdateOptions
object
Options for updating a job.
4 properties 1 required
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelineshandling-errors.
2 properties
JobStatus
string
The status of the job.
ItemDetails
object
A workspace item.
19 properties 5 required
ItemType
string
The type of the workspace item.
SessionStatus
string
The status of the session.
PagedProviderStatus
object
Paged collection of ProviderStatus items
2 properties 1 required
Azure.Core.Foundations.Error
object
The error object.
5 properties 2 required
TargetStatus
object
Target status.
7 properties 3 required
ProviderAvailability
string
Provider availability.
BlobDetails
object
The details (name and container) of the blob to store or download data.
2 properties 1 required
CreatedByType
string
The type of identity that created the item.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-quantum-subscriptions-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 SuiteOffers API
Microsoft Azure Quantum Workspaces API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Quantum Subscriptions 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.