# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Workspace API
  version: 1.0.0
extends: openapi/microsoft-azure-workspace-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: 12
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspaces in an API Management service
      effect: read
      questions:
      - What workspaces does my API Management instance have?
      - Can I filter API Management workspaces with OData?
      instructions:
      - text: List all workspaces in API Management service {service}.
        slots:
          service: path.serviceName
      - text: List API Management workspaces matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API Management workspace
      effect: read
      questions:
      - How do I view one API Management workspace's details?
      - What configuration does a single APIM workspace hold?
      instructions:
      - text: Show workspace {workspace} in API Management service {service}.
        slots:
          workspace: path.workspaceId
          service: path.serviceName
      - text: Get the configuration of APIM workspace {workspace}.
        slots:
          workspace: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an API Management workspace
      effect: write
      questions:
      - Can I add a new workspace to an API Management instance?
      - Is there one call that creates an APIM workspace or overwrites an existing one?
      instructions:
      - text: Create workspace {workspace} in my API Management service {service}.
        slots:
          workspace: path.workspaceId
          service: path.serviceName
      - text: Create or overwrite the definition of APIM workspace {workspace}.
        slots:
          workspace: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API Management workspace
      effect: destructive
      questions:
      - Can I delete a workspace from API Management?
      - Is there a call to remove an APIM workspace I no longer need?
      instructions:
      - text: Delete workspace {workspace} from API Management service {service}.
        slots:
          workspace: path.workspaceId
          service: path.serviceName
      - text: Remove APIM workspace {workspace} entirely.
        slots:
          workspace: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API Management workspace
      effect: write
      questions:
      - Can I change individual fields of an API Management workspace?
      - Is a partial update possible on APIM workspace details?
      instructions:
      - text: Update the details of workspace {workspace} in API Management service {service}.
        slots:
          workspace: path.workspaceId
          service: path.serviceName
      - text: Partially update APIM workspace {workspace}.
        slots:
          workspace: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get the ETag of an API Management workspace
      effect: read
      questions:
      - How can I read an APIM workspace's current ETag for concurrency checks?
      - What entity version is an API Management workspace on right now?
      instructions:
      - text: Get the ETag of workspace {workspace} in API Management service {service}.
        slots:
          workspace: path.workspaceId
          service: path.serviceName
      - text: Check the entity state version of APIM workspace {workspace}.
        slots:
          workspace: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure Virtual Desktop workspace
      effect: read
      questions:
      - How do I look up an Azure Virtual Desktop workspace by name?
      - Can I read a desktop virtualization workspace's properties?
      instructions:
      - text: Get Virtual Desktop workspace {ws}.
        slots:
          ws: path.workspaceName
      - text: Show desktop virtualization workspace {ws} settings.
        slots:
          ws: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Virtual Desktop workspace
      effect: write
      questions:
      - Can I create a new Azure Virtual Desktop workspace?
      - Is one call enough to create or overwrite a desktop virtualization workspace?
      instructions:
      - text: Create Virtual Desktop workspace {ws}.
        slots:
          ws: path.workspaceName
      - text: Create or overwrite Virtual Desktop workspace {ws} with properties {properties}.
        slots:
          ws: path.workspaceName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a Virtual Desktop workspace
      effect: destructive
      questions:
      - Can I remove an Azure Virtual Desktop workspace?
      - How do I delete a desktop virtualization workspace I no longer use?
      instructions:
      - text: Remove Virtual Desktop workspace {ws}.
        slots:
          ws: path.workspaceName
      - text: Delete desktop virtualization workspace {ws}.
        slots:
          ws: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Virtual Desktop workspace
      effect: write
      questions:
      - Can I change tags on an Azure Virtual Desktop workspace?
      - Is there a patch for just some properties of a desktop virtualization workspace?
      instructions:
      - text: Change tags on Virtual Desktop workspace {ws} to {tags}.
        slots:
          ws: path.workspaceName
          tags: requestBody.tags
      - text: Patch properties {properties} on desktop virtualization workspace {ws}.
        slots:
          properties: requestBody.properties
          ws: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List Virtual Desktop workspaces in a resource group
      effect: read
      questions:
      - Which Azure Virtual Desktop workspaces are in my resource group?
      - Can I page through a resource group's desktop workspaces in descending order?
      instructions:
      - text: List Virtual Desktop workspaces in my resource group.
      - text: Page through resource-group Virtual Desktop workspaces {pageSize} at a time, skipping {skip}, descending {desc}.
        slots:
          pageSize: query.pageSize
          skip: query.initialSkip
          desc: query.isDescending
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List Virtual Desktop workspaces in a subscription
      effect: read
      questions:
      - What Azure Virtual Desktop workspaces exist across my subscription?
      - Can I see every desktop virtualization workspace subscription-wide?
      instructions:
      - text: List every Virtual Desktop workspace in my subscription.
      - text: Show all desktop virtualization workspaces across the subscription.
      method: generated
      generated: '2026-09-26'