ControlUp · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for DaaS IQ Overview API
12 actions
12 updates
phrasing
extends
openapi/controlup-overview-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.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/cloud/overview/graph'].get
$.paths['/cloud/overview/subscriptions'].get
$.paths['/cloud/overview/regions'].get
$.paths['/cloud/overview/resource-groups'].get
$.paths['/cloud/overview/host-pools'].get
$.paths['/cloud/overview/session-hosts'].get
$.paths['/cloud/overview/images'].get
$.paths['/cloud/overview/master-images'].get
$.paths['/cloud/overview/user-sessions'].get
$.paths['/cloud/overview/application-groups'].get
$.paths['/cloud/overview/workspaces'].get
OpenAPI Overlay
# 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 Overview API
version: 1.0.0
extends: openapi/controlup-overview-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: 11
- target: $.paths['/cloud/overview/graph'].get
update:
x-apievangelist-phrasing:
intent: Get resource counts per hierarchy level
effect: read
questions:
- How many subscriptions, host pools, session hosts and sessions do I have in total?
- Can I get the funnel of counts at each level of my cloud desktop hierarchy?
instructions:
- text: Show the overview funnel counts for my whole cloud estate.
- text: Give me the hierarchy counts for subscription {subscriptionId}.
slots:
subscriptionId: query.subscriptionId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/subscriptions'].get
update:
x-apievangelist-phrasing:
intent: Summarize cost and contents per subscription
effect: read
questions:
- What does each subscription contain and cost?
- Which subscription has the most host pools and the highest rolled-up cost?
instructions:
- text: List the overview rows per subscription with counts and cost.
- text: Show the subscription roll-up for region {regionId}.
slots:
regionId: query.regionId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/regions'].get
update:
x-apievangelist-phrasing:
intent: Summarize onboarded resources per region
effect: read
questions:
- Which regions hold onboarded resources, and what do they cost?
- How is performance rolled up per region?
instructions:
- text: List the overview rows per region with cost and performance.
- text: Break down cost and performance by Azure region within subscription {subscriptionId}.
slots:
subscriptionId: query.subscriptionId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/resource-groups'].get
update:
x-apievangelist-phrasing:
intent: Summarize onboarded resources per resource group
effect: read
questions:
- Which resource groups hold my host pools, and what do they cost?
- Can I compare host statistics across resource groups?
instructions:
- text: List the overview rows per resource group.
- text: Show the resource group roll-up in region {regionId}.
slots:
regionId: query.regionId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/host-pools'].get
update:
x-apievangelist-phrasing:
intent: Summarize cost and performance per host pool
effect: read
questions:
- Which host pools cost the most, with their session counts and performance?
- Can I see host pool cost filtered to one workspace?
instructions:
- text: List the overview rows per host pool with cost and performance.
- text: Show host pool cost and sessions for resource group {resourceGroupId}.
slots:
resourceGroupId: query.resourceGroupId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/session-hosts'].get
update:
x-apievangelist-phrasing:
intent: Summarize every session host with cost and load
effect: read
questions:
- Which session hosts anywhere are powered on and costing the most?
- Can I see power state, session count and cost for every session host across pools?
instructions:
- text: List the overview rows for all session hosts.
- text: Show session host power state and cost in host pool {hostPoolId}.
slots:
hostPoolId: query.hostPoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/images'].get
update:
x-apievangelist-phrasing:
intent: Summarize images running in the estate
effect: read
questions:
- Which images are my onboarded resources running, and how many consumers does each have?
- What image versions are in use across my host pools?
instructions:
- text: List the overview rows per image in use.
- text: Show the images used in host pool {hostPoolId}.
slots:
hostPoolId: query.hostPoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/master-images'].get
update:
x-apievangelist-phrasing:
intent: Summarize managed master images
effect: read
questions:
- How many versions does each DaaS IQ master image have?
- Which master images do I manage?
instructions:
- text: List the overview rows per master image.
- text: Show the master image roll-up for subscription {subscriptionId}.
slots:
subscriptionId: query.subscriptionId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/user-sessions'].get
update:
x-apievangelist-phrasing:
intent: List current user sessions across the estate
effect: read
questions:
- Who is connected right now across all of my host pools?
- Which user sessions are disconnected or pending, and in which region?
instructions:
- text: List all current user sessions in the overview.
- text: Show current user sessions in region {regionId}.
slots:
regionId: query.regionId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/application-groups'].get
update:
x-apievangelist-phrasing:
intent: Summarize application groups
effect: read
questions:
- Which application groups publish RemoteApps versus full desktops?
- How many sessions does each application group have?
instructions:
- text: List the overview rows per application group.
- text: Show application groups in workspace {workspaceId}.
slots:
workspaceId: query.workspaceId
method: generated
generated: '2026-09-26'
- target: $.paths['/cloud/overview/workspaces'].get
update:
x-apievangelist-phrasing:
intent: Summarize AVD workspaces
effect: read
questions:
- How many application groups and sessions does each workspace have?
- Which workspaces do my users see, with their host pools?
instructions:
- text: List the overview rows per workspace.
- text: Show the workspace roll-up for subscription {subscriptionId}.
slots:
subscriptionId: query.subscriptionId
method: generated
generated: '2026-09-26'