# 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 User…
  version: 1.0.0
extends: openapi/microsoft-azure-user-session-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: 6
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List user sessions across a host pool
      effect: read
      questions:
      - Who is currently signed in anywhere in my Azure Virtual Desktop host pool?
      - Can I filter the host pool's user sessions, for example by user principal name?
      instructions:
      - text: List user sessions in host pool {hostPoolName}.
        slots:
          hostPoolName: path.hostPoolName
      - text: List host pool {hostPoolName} user sessions matching filter {filter}.
        slots:
          hostPoolName: path.hostPoolName
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a virtual desktop user session
      effect: read
      questions:
      - What is the state of a specific user's session on a session host?
      - Can I look up one Azure Virtual Desktop session by its id?
      instructions:
      - text: Get user session {userSessionId} on session host {sessionHostName} in host pool {hostPoolName}.
        slots:
          userSessionId: path.userSessionId
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: Show the details of session {userSessionId} on host {sessionHostName}, pool {hostPoolName}.
        slots:
          userSessionId: path.userSessionId
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Log off and remove a virtual desktop user session
      effect: destructive
      questions:
      - How do I sign a user out and remove their session from a session host?
      - Can I force-remove a stuck Azure Virtual Desktop session?
      instructions:
      - text: Remove user session {userSessionId} from session host {sessionHostName} in host pool {hostPoolName}.
        slots:
          userSessionId: path.userSessionId
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: Force-remove session {userSessionId} on host {sessionHostName}, pool {hostPoolName}, with force set to {force}.
        slots:
          userSessionId: path.userSessionId
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List user sessions on one session host
      effect: read
      questions:
      - Which users are connected to a particular session host right now?
      - Can I page through the sessions on a single virtual desktop host?
      instructions:
      - text: List user sessions on session host {sessionHostName} in host pool {hostPoolName}.
        slots:
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: Show {pageSize} sessions per page on host {sessionHostName} of pool {hostPoolName}.
        slots:
          pageSize: query.pageSize
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect'].post
  update:
    x-apievangelist-phrasing:
      intent: Disconnect a virtual desktop user session
      effect: write
      questions:
      - How do I disconnect a user from their virtual desktop without logging them off?
      - Can I drop a user's remote connection but keep their session running?
      instructions:
      - text: Disconnect user session {userSessionId} on session host {sessionHostName} in host pool {hostPoolName}.
        slots:
          userSessionId: path.userSessionId
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: Drop the connection for session {userSessionId} on host {sessionHostName}, pool {hostPoolName}.
        slots:
          userSessionId: path.userSessionId
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to a virtual desktop user
      effect: write
      questions:
      - How do I warn a signed-in user that their session host is going down for maintenance?
      - Can I pop up a message with a title in someone's virtual desktop session?
      instructions:
      - text: Send message {messageBody} to user session {userSessionId} on host {sessionHostName} in pool {hostPoolName}.
        slots:
          messageBody: requestBody.messageBody
          userSessionId: path.userSessionId
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
      - text: Notify session {userSessionId} on {sessionHostName}, pool {hostPoolName}, with title {messageTitle} and text {messageBody}.
        slots:
          userSessionId: path.userSessionId
          sessionHostName: path.sessionHostName
          hostPoolName: path.hostPoolName
          messageTitle: requestBody.messageTitle
          messageBody: requestBody.messageBody
      method: generated
      generated: '2026-10-01'