# 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 Desktop Virtualization API Client Session…
  version: 1.0.0
extends: openapi/microsoft-azure-sessionhost-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure Virtual Desktop session host
      effect: read
      questions:
      - How do I check the status and assigned user of one session host in a host pool?
      - What does a single Azure Virtual Desktop session host report?
      instructions:
      - text: Show session host {sessionHostName} in host pool {hostPoolName}.
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: Get the health and status of session host {sessionHostName} in pool {hostPoolName}.
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a session host from a host pool
      effect: destructive
      questions:
      - How do I remove a session host from an Azure Virtual Desktop host pool?
      - Can I force-remove a session host that still has active user sessions?
      instructions:
      - text: Remove session host {sessionHostName} from host pool {hostPoolName}.
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: 'Force-remove session host {sessionHostName} from pool {hostPoolName}: force={force}.'
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a session host
      effect: write
      questions:
      - Can I turn off new sessions on a session host for maintenance?
      - How do I change the assigned user or drain mode of a session host?
      instructions:
      - text: Update session host {sessionHostName} in host pool {hostPoolName}.
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: Put session host {sessionHostName} in pool {hostPoolName} into drain mode so it accepts no new sessions.
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts'].get
  update:
    x-apievangelist-phrasing:
      intent: List session hosts in a host pool
      effect: read
      questions:
      - Which session hosts belong to my Azure Virtual Desktop host pool?
      - Can I page through session hosts in descending order?
      instructions:
      - text: List the session hosts in host pool {hostPoolName}.
        slots:
          hostPoolName: path.hostPoolName
      - text: 'Show {pageSize} session hosts per page from pool {hostPoolName}, newest first: {isDescending}.'
        slots:
          pageSize: query.pageSize
          hostPoolName: path.hostPoolName
          isDescending: query.isDescending
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/retryProvisioning'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry provisioning a failed session host
      effect: write
      questions:
      - How do I retry provisioning on a session host that failed to deploy?
      - Is there a way to rerun session host provisioning without deleting it?
      instructions:
      - text: Retry provisioning on session host {sessionHostName} in host pool {hostPoolName}.
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: Rerun the failed deployment of session host {sessionHostName} in pool {hostPoolName}.
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-09-26'