Microsoft Azure Quantum Workspace Services

swagger: '2.0'
info:
  title: Microsoft Azure Azure Quantum Workspace Services
  version: 2024-03-01-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: https://{region}.{serviceBaseUrl}
  useSchemePrefix: false
  parameters:
    - name: region
      in: path
      description: The Azure region where the Azure Quantum Workspace is located.
      required: true
      type: string
    - name: serviceBaseUrl
      in: path
      description: The Azure Quantum service base url.
      required: true
      type: string
      default: quantum.azure.com
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:
  - name: Subscriptions
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs
  : get:
      operationId: microsoftAzureJobsList
      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
      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
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}
  : get:
      operationId: microsoftAzureJobsGet
      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
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs Jobid
      tags:
        - Subscriptions
    put:
      operationId: microsoftAzureJobsCreate
      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
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs Jobid
      tags:
        - Subscriptions
    patch:
      operationId: microsoftAzureJobsUpdate
      description: Update job properties.
      consumes:
        - application/json-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/JsonPatchDocument'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/JobDetails'
        '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:
        Patches a job.:
          $ref: ./examples/Jobs_Update.json
      summary: >-
        Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs Jobid
      tags:
        - Subscriptions
    delete:
      operationId: microsoftAzureJobsCancel
      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:
        '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:
        Cancels a job.:
          $ref: ./examples/Jobs_Cancel.json
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs Jobid
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus
  : get:
      operationId: microsoftAzureProvidersList
      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
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Providerstatus
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas
  : get:
      operationId: microsoftAzureQuotasList
      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
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Quotas
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions
  : get:
      operationId: microsoftAzureSessionsList
      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
      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
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}
  : get:
      operationId: microsoftAzureSessionsGet
      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
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions Sessionid
      tags:
        - Subscriptions
    put:
      operationId: microsoftAzureSessionsOpen
      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
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions Sessionid
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}:close
  : post:
      operationId: microsoftAzureSessionsClose
      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
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions Sessionid:close
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}/jobs
  : get:
      operationId: microsoftAzureSessionsjobsList
      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}$
      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
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions Sessionid Jobs
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri
  : post:
      operationId: microsoftAzureStorageGetsasuri
      description: >-
        Gets a URL with SAS token for a container/blob in the storage account
        associated with the workspace. 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.:
          $ref: ./examples/Storage_GetSasUri.json
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Storage Sasuri
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/topLevelItems
  : get:
      operationId: microsoftAzureToplevelitemsList
      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
      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
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Toplevelitems
      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'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: >-
          An object containing more specific information than the cu

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-quantum-workspace-services-openapi-original.yml