Microsoft Azure Quantum
Azure Quantum Workspace Data-Plane API

Azure Quantum Workspace Services data-plane REST API. Submit and manage quantum jobs, sessions (hybrid quantum-classical workflows), provider status checks, quotas, top-level items, and storage SAS URIs against an Azure Quantum workspace. Targets quantum hardware from IonQ, Quantinuum, Pasqal, and Rigetti plus simulators and emulators. Current preview version 2026-01-15-preview.
Documentation GitHub OpenAPI
OpenAPI Specification

{
  "swagger": "2.0",
  "info": {
    "title": "Azure Quantum Workspace Services",
    "version": "2026-01-15-preview",
    "description": "Azure Quantum Workspace Services",
    "contact": {
      "email": "[email protected]"
    },
    "x-typespec-generated": [
      {
        "emitter": "@azure-tools/typespec-autorest"
      }
    ]
  },
  "schemes": [
    "https"
  ],
  "x-ms-parameterized-host": {
    "hostTemplate": "{endpoint}",
    "useSchemePrefix": false,
    "parameters": [
      {
        "name": "endpoint",
        "in": "path",
        "description": "The endpoint of the Azure Quantum service. For example, https://{region}.quantum.azure.com",
        "required": true,
        "type": "string",
        "format": "uri",
        "x-ms-skip-url-encoding": true
      }
    ]
  },
  "produces": [
    "application/json"
  ],
  "consumes": [
    "application/json"
  ],
  "security": [
    {
      "AzureEntraAuth": [
        "https://quantum.microsoft.com/.default"
      ]
    },
    {
      "AzureApiKeyAuth": []
    }
  ],
  "securityDefinitions": {
    "AzureApiKeyAuth": {
      "type": "apiKey",
      "description": "Azure Api-Key Authentication",
      "name": "x-ms-quantum-api-key",
      "in": "header"
    },
    "AzureEntraAuth": {
      "type": "oauth2",
      "description": "Azure Entra OAuth2 Authentication",
      "flow": "application",
      "scopes": {
        "https://quantum.microsoft.com/.default": ""
      },
      "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token"
    }
  },
  "tags": [],
  "paths": {
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobUpdateOptions/{jobId}": {
      "patch": {
        "operationId": "Jobs_Update",
        "description": "Update job properties.",
        "consumes": [
          "application/merge-patch+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "jobId",
            "in": "path",
            "description": "Id of the job.",
            "required": true,
            "type": "string",
            "maxLength": 36,
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          {
            "name": "resource",
            "in": "body",
            "description": "The resource instance.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/JobUpdateOptionsUpdate"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/JobUpdateOptions"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Patches a job.": {
            "$ref": "./examples/Jobs_Update.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs": {
      "get": {
        "operationId": "Jobs_List",
        "description": "List all jobs.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "$ref": "#/parameters/CustomFilterQueryParameter"
          },
          {
            "$ref": "#/parameters/CustomSkipQueryParameter"
          },
          {
            "$ref": "#/parameters/CustomTopQueryParameter"
          },
          {
            "$ref": "#/parameters/CustomOrderByQueryParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedJobDetails"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "List jobs in a workspace.": {
            "$ref": "./examples/Jobs_List.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}": {
      "get": {
        "operationId": "Jobs_Get",
        "description": "Get job by its id.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "jobId",
            "in": "path",
            "description": "Id of the job.",
            "required": true,
            "type": "string",
            "maxLength": 36,
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/JobDetails"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Gets a job by its id.": {
            "$ref": "./examples/Jobs_Get.json"
          }
        }
      },
      "put": {
        "operationId": "Jobs_Create",
        "description": "Create a new job.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "jobId",
            "in": "path",
            "description": "Id of the job.",
            "required": true,
            "type": "string",
            "maxLength": 36,
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          {
            "name": "resource",
            "in": "body",
            "description": "The resource instance.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/JobDetails"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/JobDetails"
            }
          },
          "201": {
            "description": "The request has succeeded and a new resource has been created as a result.",
            "schema": {
              "$ref": "#/definitions/JobDetails"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Creates a job.": {
            "$ref": "./examples/Jobs_Create.json"
          }
        }
      },
      "delete": {
        "operationId": "Jobs_Delete",
        "description": "Delete a job by its id. Use for cancellation in versions before 2025-12-01-preview.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "jobId",
            "in": "path",
            "description": "Id of the job.",
            "required": true,
            "type": "string",
            "maxLength": 36,
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          }
        ],
        "responses": {
          "204": {
            "description": "There is no content to send for this request, but the headers may be useful. "
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Deletes a job by its id.": {
            "$ref": "./examples/Jobs_Delete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}:cancel": {
      "post": {
        "operationId": "Jobs_Cancel",
        "description": "Request the cancellation of an existing job.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "jobId",
            "in": "path",
            "description": "Id of the job.",
            "required": true,
            "type": "string",
            "maxLength": 36,
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/JobDetails"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Cancels a job.": {
            "$ref": "./examples/Jobs_Cancel.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus": {
      "get": {
        "operationId": "Providers_List",
        "description": "List all providers in the workspace with their respective status.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedProviderStatus"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Get provider and target statuses.": {
            "$ref": "./examples/Providers_List.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas": {
      "get": {
        "operationId": "Quotas_List",
        "description": "List quotas for the given workspace.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedQuota"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Get workspace quotas.": {
            "$ref": "./examples/Quotas_List.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions": {
      "get": {
        "operationId": "Sessions_Listv2",
        "description": "List all Sessions.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "$ref": "#/parameters/CustomFilterQueryParameter"
          },
          {
            "$ref": "#/parameters/CustomSkipQueryParameter"
          },
          {
            "$ref": "#/parameters/CustomTopQueryParameter"
          },
          {
            "$ref": "#/parameters/CustomOrderByQueryParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedSessionDetails"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "List sessions in a workspace.": {
            "$ref": "./examples/Sessions_List.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}": {
      "get": {
        "operationId": "Sessions_Get",
        "description": "Get Session by its id.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "sessionId",
            "in": "path",
            "description": "Id of the session.",
            "required": true,
            "type": "string",
            "maxLength": 36,
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/SessionDetails"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Get a session by its id.": {
            "$ref": "./examples/Sessions_Get.json"
          }
        }
      },
      "put": {
        "operationId": "Sessions_Open",
        "description": "Open a new session.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "sessionId",
            "in": "path",
            "description": "Id of the session.",
            "required": true,
            "type": "string",
            "maxLength": 36,
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          {
            "name": "resource",
            "in": "body",
            "description": "The resource instance.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/SessionDetails"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/SessionDetails"
            }
          },
          "201": {
            "description": "The request has succeeded and a new resource has been created as a result.",
            "schema": {
              "$ref": "#/definitions/SessionDetails"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
            },
            "headers": {
              "x-ms-error-code": {
                "type": "string",
                "description": "String error code indicating what went wrong."
              }
            }
          }
        },
        "x-ms-examples": {
          "Open a session.": {
            "$ref": "./examples/Sessions_Open.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}:close": {
      "post": {
        "operationId": "Sessions_Close",
        "description": "Close an existing session.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "The Azure subscription ID.",
            "required": true,
            "type": "string",
            "minLength": 36,
            "maxLength": 36,
            "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "resourceGroupName",
            "in": "path",
            "description": "Name of the Azure resource group.",
            "required": true,
            "type": "string",
            "minLength": 1,
            "maxLength": 90,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "workspaceName",
            "in": "path",
            "description": "Name of the Azure Quantum workspace.",
            "required": true,
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$",
            "x-ms-parameter-location": "client"
          },
          {
            "name": "sessionId",
            "in": "path",
            "description": "Id of the session.",
            "required": true,
            "type": "string",
            "maxLength": 36,
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-

# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-quantum/refs/heads/main/openapi/azure-quantum-data-plane-openapi.json
Azure Quantum Workspace Data-Plane API

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification
