# 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 Host Pool…
  version: 1.0.0
extends: openapi/microsoft-azure-hostpool-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: 7
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure Virtual Desktop host pool
      effect: read
      questions:
      - How do I look up the settings of one Azure Virtual Desktop host pool?
      - What load balancing and pool type is a named host pool using?
      instructions:
      - text: Get host pool {hostPoolName}.
        slots:
          hostPoolName: path.hostPoolName
      - text: Show the configuration of virtual desktop host pool {hostPoolName}.
        slots:
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a host pool
      effect: write
      questions:
      - How do I create a new host pool for Azure Virtual Desktop session hosts?
      - Can I redefine an entire host pool by resending its full properties?
      instructions:
      - text: Create host pool {hostPoolName} with properties {properties}.
        slots:
          hostPoolName: path.hostPoolName
          properties: requestBody.properties
      - text: Set up a new virtual desktop host pool named {hostPoolName}.
        slots:
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a host pool
      effect: destructive
      questions:
      - How do I delete a host pool I'm retiring?
      - Can I force-remove a host pool even when session hosts are still registered?
      instructions:
      - text: Delete host pool {hostPoolName}.
        slots:
          hostPoolName: path.hostPoolName
      - text: Remove host pool {hostPoolName} with force set to {force}.
        slots:
          hostPoolName: path.hostPoolName
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch settings on an existing host pool
      effect: write
      questions:
      - Can I change only the tags on a host pool that already exists?
      - What's the way to tweak a few host pool properties without redefining it?
      instructions:
      - text: Update the tags on host pool {hostPoolName} to {tags}.
        slots:
          hostPoolName: path.hostPoolName
          tags: requestBody.tags
      - text: Patch existing host pool {hostPoolName} with {properties}.
        slots:
          hostPoolName: path.hostPoolName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools'].get
  update:
    x-apievangelist-phrasing:
      intent: List host pools in a resource group
      effect: read
      questions:
      - Which host pools are in my current resource group?
      - Can I page through a resource group's host pools in descending order?
      instructions:
      - text: List the host pools in this resource group.
      - text: Show {pageSize} host pools per page from the resource group, skipping the first {initialSkip}.
        slots:
          pageSize: query.pageSize
          initialSkip: query.initialSkip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools'].get
  update:
    x-apievangelist-phrasing:
      intent: List host pools across a subscription
      effect: read
      questions:
      - What host pools do I have across my entire subscription?
      - Is there a subscription-wide listing of Azure Virtual Desktop host pools?
      instructions:
      - text: List every host pool in my subscription.
      - text: Show subscription-wide host pools, {pageSize} per page, descending set to {isDescending}.
        slots:
          pageSize: query.pageSize
          isDescending: query.isDescending
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a host pool registration token
      effect: read
      questions:
      - Where do I get the registration token to join a session host to a host pool?
      - Can I retrieve the current registration token for a host pool?
      instructions:
      - text: Retrieve the registration token for host pool {hostPoolName}.
        slots:
          hostPoolName: path.hostPoolName
      - text: Give me the token to register session hosts in {hostPoolName}.
        slots:
          hostPoolName: path.hostPoolName
      method: generated
      generated: '2026-09-26'