ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Host pools API

8 actions 8 updates phrasing extends openapi/controlup-host-pools-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ControlUp's API. It is a proposal applied on top of the contract, not a document ControlUp publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/cloud/host-pools'].get
$.paths['/cloud/host-pools/statistics'].get
$.paths['/cloud/host-pools/{hostPoolId}'].get
$.paths['/cloud/host-pools/{hostPoolId}'].delete
$.paths['/cloud/host-pools/{hostPoolId}/details'].get
$.paths['/cloud/host-pools/{hostPoolId}/metrics'].get
$.paths['/cloud/host-pools/{hostPoolId}/deletion'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DaaS IQ Host pools API
  version: 1.0.0
extends: openapi/controlup-host-pools-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['/cloud/host-pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List host pools across subscriptions
      effect: read
      questions:
      - Which host pools do I have across all subscriptions?
      - Can I sort host pools by session count or filter them by region?
      instructions:
      - text: List all my host pools.
      - text: List host pools matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get organization-wide host pool totals
      effect: read
      questions:
      - How many pooled versus personal host pools do I have?
      - How many session hosts are draining and how many sessions are active overall?
      instructions:
      - text: Show the host pool statistics totals for my organization.
      - text: Give me host pool totals for provider {provider}.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a host pool summary
      effect: read
      questions:
      - What are the host, session and CPU counts for one host pool?
      - Can I fetch a single host pool's summary row by ID?
      instructions:
      - text: Get host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Show the current host and session counts for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop managing a host pool, keeping it in Azure
      effect: destructive
      questions:
      - How do I remove a host pool from DaaS IQ without touching the Azure resource?
      - Is history kept if I stop managing a host pool?
      instructions:
      - text: Soft-delete host pool {hostPoolId} from management, leaving Azure untouched.
        slots:
          hostPoolId: path.hostPoolId
      - text: Stop managing host pool {hostPoolId} but keep it running in Azure.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a host pool's full configuration
      effect: read
      questions:
      - What load balancing, max sessions per host and drain mode is a host pool using?
      - Which VNet and OS does a particular host pool run on?
      instructions:
      - text: Get the extended details of host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Show the AVD configuration and 7-day session trend for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart a host pool's metrics over time
      effect: read
      questions:
      - How have active sessions and CPU in a host pool changed over the past week?
      - Can I get connection errors for a host pool as a time series?
      instructions:
      - text: Get metrics for host pool {hostPoolId} from {startDate} to {endDate}.
        slots:
          endDate: query.endDate
          hostPoolId: path.hostPoolId
          startDate: query.startDate
      - text: Return {pointCount} data points of session and CPU metrics for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
          pointCount: query.pointCount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/deletion'].post
  update:
    x-apievangelist-phrasing:
      intent: Tear down a host pool in Azure
      effect: destructive
      questions:
      - How do I delete a host pool and its session host VMs from Azure entirely?
      - Can I remove the application groups and ARM resource along with the host pool?
      instructions:
      - text: Delete host pool {hostPoolId} from Azure, including its session host VMs and application groups.
        slots:
          hostPoolId: path.hostPoolId
      - text: Run the Azure teardown job for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'