# 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 Management Workspaces API
  version: 1.0.0
extends: openapi/microsoft-quantum-workspaces-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: 9
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{location}/checkNameAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a quantum workspace name is available
      effect: read
      questions:
      - Is the quantum workspace name I want already taken in this region?
      - Can I verify a workspace name is free before creating an Azure Quantum workspace?
      instructions:
      - text: Check whether my proposed quantum workspace name is available in this location.
      - text: Verify the quantum workspace name is unused before I provision it.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List quantum workspaces in a subscription
      effect: read
      questions:
      - Which Azure Quantum workspaces exist across my whole subscription?
      - What quantum workspaces do I have in every resource group?
      instructions:
      - text: List all quantum workspaces in my subscription.
      - text: Show every Azure Quantum workspace across all my resource groups.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List quantum workspaces in a resource group
      effect: read
      questions:
      - What quantum workspaces live in one particular resource group?
      - Can I see only the quantum workspaces inside a single resource group?
      instructions:
      - text: List the quantum workspaces in this resource group.
      - text: Show only the Azure Quantum workspaces scoped to my resource group.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a quantum workspace's details
      effect: read
      questions:
      - How do I look up the configuration of a specific quantum workspace?
      - What providers and storage account is my quantum workspace set up with?
      instructions:
      - text: Get the details of quantum workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      - text: Show the properties of the {workspaceName} quantum workspace.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a quantum workspace
      effect: write
      questions:
      - How do I create a new Azure Quantum workspace?
      - Can I change a quantum workspace's properties or managed identity after creating it?
      instructions:
      - text: Create a quantum workspace named {workspaceName} with properties {properties}.
        slots:
          workspaceName: path.workspaceName
          properties: requestBody.properties
      - text: Assign managed identity {identity} to quantum workspace {workspaceName}.
        slots:
          identity: requestBody.identity
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a quantum workspace
      effect: destructive
      questions:
      - How do I remove a quantum workspace I no longer use?
      - Can I tear down an Azure Quantum workspace entirely?
      instructions:
      - text: Delete the quantum workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      - text: Remove workspace {workspaceName} from Azure Quantum permanently.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a quantum workspace's tags
      effect: write
      questions:
      - Can I change only the resource tags on an existing quantum workspace?
      - How do I tag a quantum workspace for cost tracking without touching its other settings?
      instructions:
      - text: Set the tags on quantum workspace {workspaceName} to {tags}.
        slots:
          workspaceName: path.workspaceName
          tags: requestBody.tags
      - text: Replace the resource tags of workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a quantum workspace's API keys
      effect: read
      questions:
      - Where do I get the access keys to call the Quantum REST APIs for my workspace?
      - Why does a quantum workspace hand out two keys instead of one?
      instructions:
      - text: Fetch the API keys for quantum workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      - text: Show the primary and secondary keys of workspace {workspaceName}.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/regenerateKey'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a quantum workspace API key
      effect: destructive
      questions:
      - How do I rotate the primary or secondary key on a quantum workspace?
      - Does the old workspace key stop working right away when I regenerate it?
      instructions:
      - text: Regenerate the {keys} key for quantum workspace {workspaceName}.
        slots:
          keys: requestBody.keys
          workspaceName: path.workspaceName
      - text: Rotate the API keys on workspace {workspaceName} because one leaked.
        slots:
          workspaceName: path.workspaceName
      method: generated
      generated: '2026-10-01'