# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure Quantum Workspace Services Subscriptions API
  version: 1.0.0
extends: openapi/microsoft-quantum-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 15
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobUpdateOptions/{jobId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a quantum job's name, priority or tags
      effect: write
      questions:
      - Can I bump the priority of a quantum job that is already submitted?
      - How do I rename or retag an existing quantum job?
      instructions:
      - text: Set the priority of job {jobId} in workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}) to {priority}.
        slots:
          jobId: path.jobId
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          priority: requestBody.priority
      - text: Rename quantum job {jobId} to {name} and tag it {tags}.
        slots:
          jobId: path.jobId
          name: requestBody.name
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List quantum jobs in a workspace
      effect: read
      questions:
      - What quantum jobs have been submitted to my workspace?
      - Can I page through workspace jobs and sort them by creation time?
      - Which of my quantum jobs failed recently?
      instructions:
      - text: List all jobs in quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the {top} most recent quantum jobs ordered by {orderby} that match {filter}.
        slots:
          top: query.top
          orderby: query.orderby
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a quantum job's status and results location
      effect: read
      questions:
      - Has my quantum job finished, and where are its output results?
      - What did a specific quantum job cost and why did it error?
      instructions:
      - text: Get job {jobId} from quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          jobId: path.jobId
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Check the status of quantum job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Submit a new quantum job to a target
      effect: write
      questions:
      - How do I submit a quantum program to run on a specific hardware target?
      - Can I attach a new quantum job to an open session?
      - What blob container does a quantum job need for its input and output data?
      instructions:
      - text: Submit job {jobId} named {name} to target {target} of provider {providerId} in workspace {workspaceName}.
        slots:
          jobId: path.jobId
          name: requestBody.name
          target: requestBody.target
          providerId: requestBody.providerId
          workspaceName: path.workspaceName
      - text: Create quantum job {jobId} using container {containerUri} and input blob {inputDataUri}.
        slots:
          jobId: path.jobId
          containerUri: requestBody.containerUri
          inputDataUri: requestBody.inputDataUri
      - text: Run quantum job {jobId} as part of session {sessionId}.
        slots:
          jobId: path.jobId
          sessionId: requestBody.sessionId
      - text: Create quantum job {jobId} in resource group {resourceGroupName} under subscription {subscriptionId}.
        slots:
          jobId: path.jobId
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a quantum job (legacy cancel)
      effect: destructive
      questions:
      - How do I delete a quantum job record from my workspace?
      - On API versions before 2025-12-01-preview, how did I cancel a job?
      instructions:
      - text: Delete job {jobId} from quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          jobId: path.jobId
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove quantum job {jobId} using the older delete-to-cancel endpoint.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running quantum job
      effect: destructive
      questions:
      - Can I stop a quantum job that is still queued or running?
      - Is there a dedicated cancel action for quantum jobs that keeps the job record?
      instructions:
      - text: Request cancellation of job {jobId} in quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          jobId: path.jobId
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Cancel the queued quantum job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a workspace's quantum providers
      effect: read
      questions:
      - Which quantum providers are enabled in my workspace and are they online?
      - Is a particular quantum hardware target currently available in my workspace?
      instructions:
      - text: Show the status of every provider in quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Check whether the quantum targets in workspace {workspaceName} are available right now.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas'].get
  update:
    x-apievangelist-phrasing:
      intent: List a quantum workspace's quotas
      effect: read
      questions:
      - How much of my quantum compute quota have I used in this workspace?
      - What usage limits apply to my quantum workspace?
      instructions:
      - text: List the quotas for quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show how much quota remains in workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List quantum sessions in a workspace
      effect: read
      questions:
      - What quantum sessions exist in my workspace?
      - Can I filter workspace sessions to only the ones still open?
      instructions:
      - text: List all sessions in quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show quantum sessions matching {filter}, skipping the first {skip}.
        slots:
          filter: query.filter
          skip: query.skip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a quantum session's details
      effect: read
      questions:
      - Is a specific quantum session still open, and what target is it on?
      - What job failure policy is set on one of my sessions?
      instructions:
      - text: Get session {sessionId} from quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          sessionId: path.sessionId
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the status of quantum session {sessionId}.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Open a new quantum session on a target
      effect: write
      questions:
      - How do I open a session so several quantum jobs run together on one target?
      - Can a session keep going or stop when one of its jobs fails?
      instructions:
      - text: Open session {sessionId} named {name} on target {target} of provider {providerId} in workspace {workspaceName}.
        slots:
          sessionId: path.sessionId
          name: requestBody.name
          target: requestBody.target
          providerId: requestBody.providerId
          workspaceName: path.workspaceName
      - text: Start quantum session {sessionId} with job failure policy {jobFailurePolicy}.
        slots:
          sessionId: path.sessionId
          jobFailurePolicy: requestBody.jobFailurePolicy
      - text: Open quantum session {sessionId} in resource group {resourceGroupName} under subscription {subscriptionId}.
        slots:
          sessionId: path.sessionId
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}:close'].post
  update:
    x-apievangelist-phrasing:
      intent: Close a quantum session
      effect: destructive
      questions:
      - How do I end a quantum session once its jobs are done?
      - Can I close a session so no more jobs are accepted into it?
      instructions:
      - text: Close session {sessionId} in quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          sessionId: path.sessionId
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: End quantum session {sessionId} now.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List the jobs in a quantum session
      effect: read
      questions:
      - Which jobs ran inside a particular quantum session?
      - Can I see only the failed jobs from one session?
      instructions:
      - text: List the jobs in session {sessionId} of quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          sessionId: path.sessionId
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the jobs from quantum session {sessionId} that match {filter}.
        slots:
          sessionId: path.sessionId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a SAS URL for workspace storage
      effect: write
      questions:
      - How do I get a signed URL to upload quantum job input to my workspace's storage?
      - Can I download a quantum job's output blob with a SAS link?
      - Does requesting a SAS URL create the storage container if it doesn't exist?
      instructions:
      - text: Get a SAS URL for container {containerName} in the storage of workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          containerName: requestBody.containerName
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Generate a SAS link for blob {blobName} in container {containerName} so I can download job output.
        slots:
          blobName: requestBody.blobName
          containerName: requestBody.containerName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/topLevelItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List top-level jobs and sessions together
      effect: read
      questions:
      - Can I see standalone jobs and sessions in one combined list?
      - What top-level items are in my quantum workspace, excluding jobs nested in sessions?
      instructions:
      - text: List the top-level items in quantum workspace {workspaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          workspaceName: path.workspaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the first {top} top-level workspace items sorted by {orderby}.
        slots:
          top: query.top
          orderby: query.orderby
      method: generated
      generated: '2026-10-01'