Microsoft Azure Quantum Subscriptions API

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

OpenAPI Specification

microsoft-quantum-subscriptions-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: Azure Quantum Workspace Services Offerings Subscriptions API
  version: 2026-01-15-preview
  description: Azure Quantum Workspace Services
  contact:
    email: azqengg@microsoft.com
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- AzureEntraAuth:
  - https://quantum.microsoft.com/.default
- AzureApiKeyAuth: []
tags:
- name: Subscriptions
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
      tags:
      - Subscriptions
  ? /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
      tags:
      - Subscriptions
  ? /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
      tags:
      - Subscriptions
    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
      tags:
      - Subscriptions
    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
      tags:
      - Subscriptions
  ? /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
      tags:
      - Subscriptions
  ? /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
      tags:
      - Subscriptions
  ? /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
      tags:
      - Subscriptions
  ? /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
      tags:
      - Subscriptions
  ? /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
      tags:
      - Subscriptions
    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
      tags:
      - Subscriptions
  ? /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-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:
        Closes a session by its id.:
          $ref: ./examples/Sessions_Close.json
      tags:
      - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}/jobs
  : get:
      operationId: SessionsJobs_List
      description: List jobs in a 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 to list jobs from.
        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}$
      - $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/SessionsJobs_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri
  : post:
      operationId: Storage_GetSasUri
      description: 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 if it does not already exist. The SAS URL can be used to upload job input and/or download job output.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/CommonParams.subscriptionId'
      - $ref: '#/parameters/CommonParams.resourceGroupName'
      - $ref: '#/parameters/CommonParams.workspaceName'
      - name: blobDetails
        in: body
        description: The details (name and container) of the blob.
        required: true
        schema:
          $ref: '#/definitions/BlobDetails'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/SasUriResponse'
        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 URL with SAS token for a container/blob. When used for a container the container is also created if it does not already exist '
        : $ref: ./examples/Storage_GetSasUri.json
      tags:
      - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/topLevelItems
  : get:
      operationId: TopLevelItems_Listv2
      description: List top-level items.
      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/PagedItemDetails'
        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 top level items in a workspace.:
          $ref: ./examples/TopLevelItems_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
definitions:
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
  JobStatus:
    type: string
    description: The status of the job.
    enum:
    - Queued
    - Waiting
    - Executing
    - CancellationRequested
    - Cancelling
    - Finishing
    - Completed
    - Succeeded
    - Failed
    - Cancelled
    x-ms-enum:
      name: JobStatus
      modelAsString: true
      values:
      - name: Queued
        value: Queued
        description: The job has been queued.
      - name: Waiting
        value: Waiting
        description: The job is waiting in the queue to be executed.
      - name: Executing
        value: Executing
        description: The job is being executed.
      - name: CancellationRequested
        value: CancellationRequested
        description: Cancellation of the job has been requested.
      - name: Cancelling
        value: Cancelling
        description: The job is in the process of being cancelled.
      - name: Finishing
        value: Finishing
        description: The job is in the process of being finished.
      - name: Completed
        value: Completed
        description: The job completed.
      - name: Succeeded
        value: Succeeded
        description: The job completed with success.
      - name: Failed
        value: Failed
        description: The job completed with failure.
      - name: Cancelled
        value: Cancelled
        description: The job was cancelled.
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing 

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-quantum/refs/heads/main/openapi/microsoft-quantum-subscriptions-api-openapi.yml