ControlUp Subscriptions API
The Subscriptions API from ControlUp — 27 operation(s) for subscriptions.
Operations 31
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
POST
/cloud/subscriptions/{id}/credentials/verify
Verify a subscription's cloud credentials (deprecated) · Verify subscription credentials (Deprecated)
#
Ask an LLM
“Can I check whether the stored cloud credentials on a subscription still work using the older subscription-level endpoint?”
“Is there a deprecated call that verifies credentials per subscription rather than per tenant?”
Tell an agent
Verify the cloud credentials stored on subscription {id} with the deprecated subscription endpoint.
Run the legacy credential check for subscription {id} and tell me if it passes.
POST
/cloud/subscriptions/{id}/credentials/verify/transcript
Get a step-by-step credential check transcript (deprecated) · Verify subscription credentials - transcript (Deprecated)
#
Ask an LLM
“Can I get a detailed transcript of each permission check when verifying a subscription's credentials?”
“Which step of the connection test failed for my subscription's credentials on the old subscription endpoint?”
Tell an agent
Produce the verification transcript for subscription {id} showing each connection and permission check.
Show me the legacy step-by-step credential transcript for subscription {id}.
GET
/cloud/subscriptions/{id}/credentials/verify/stream
Stream subscription credential check over WebSocket · Verify subscription credentials - streaming (Deprecated)
#
Ask an LLM
“Is there an old WebSocket stream that shows live progress while a subscription's cloud credentials are verified?”
“Can I watch subscription-level credential verification step by step over a WebSocket?”
Tell an agent
Open the deprecated WebSocket stream verifying credentials for subscription {id}.
Stream subscription {id}'s credential verification progress over WebSocket.
POST
/cloud/subscriptions/{id}/credentials/verify/sse
Stream subscription credential check over SSE · Verify subscription credentials - streaming (Deprecated)
#
Ask an LLM
“Can I get server-sent events while my subscription's cloud credentials are being verified?”
“Is the SSE credential check on subscriptions deprecated in favor of tenant verification?”
Tell an agent
Stream subscription {id}'s credential verification as server-sent events.
Verify cloud credentials on subscription {id} with the deprecated SSE stream.
GET
/cloud/subscriptions/{subscriptionId}/metadata/regions
List regions a subscription can deploy into · Get available regions for a subscription
#
Ask an LLM
“Which Azure regions can my subscription deploy session hosts into?”
“Can I sort or filter the list of regions available to a subscription?”
Tell an agent
List the deployable regions for subscription {subscriptionId}.
Show page {page} of regions available to subscription {subscriptionId}, {pageSize} per page.
GET
/cloud/subscriptions/{subscriptionId}/metadata/regions/{region}
Get one region's metadata and availability zones · Get region metadata
#
Ask an LLM
“What availability zones does a specific region offer for my subscription?”
“Can I look up the details of a single named region in my subscription's context?”
Tell an agent
Get region {region} metadata, including availability zones, for subscription {subscriptionId}.
Show the availability zones in {region} for subscription {subscriptionId}.
GET
/cloud/subscriptions/{subscriptionId}/metadata/vm-sizes
List VM sizes offered in a region · Get available VM sizes for a region with filtering, sorting, and pagination…
#
Ask an LLM
“Which VM sizes can I pick in a given region, with their CPU and memory specs?”
“How many vCPUs and how much memory does each VM SKU in eastus have for my subscription?”
Tell an agent
List the VM sizes available in {region} for subscription {subscriptionId}.
Show VM SKUs in {region} for subscription {subscriptionId} sorted by {sort}.
GET
/cloud/subscriptions/{subscriptionId}/metadata/os-disks
List OS disk size options for a region · Get available OS disk size options for a region
#
Ask an LLM
“What OS disk sizes can I choose for session hosts in a region?”
“Which operating system disk options does my subscription offer in westeurope?”
Tell an agent
List the OS disk size options in {region} for subscription {subscriptionId}.
Show me which OS disk sizes I can pick in {region} under subscription {subscriptionId}.
GET
/cloud/subscriptions/{subscriptionId}/metadata/compute-quota
Check vCPU quota usage in a region · Get compute quota usage for a region
#
Ask an LLM
“How much of my vCPU quota is used in a region, per VM family?”
“Do I have enough compute quota left in a region to add more session hosts?”
Tell an agent
Show vCPU quota usage and limits in {region} for subscription {subscriptionId}.
Check the remaining regional compute quota for subscription {subscriptionId} in {region}.
GET
/cloud/subscriptions/{subscriptionId}/preflight/permissions/host-pool-create
Preflight permissions to create a host pool · Check host pool create permissions
#
Ask an LLM
“Does my subscription's service principal have the rights to create an AVD host pool and application group?”
“Can I check ahead of time whether a host pool creation will fail on permissions?”
Tell an agent
Check host pool create permissions for subscription {subscriptionId} in resource group {resourceGroupName} with workspace {workspaceResourceId}.
Run the host pool creation preflight for subscription {subscriptionId} in resource group {resourceGroupName}, linking workspace {workspaceResourceId}.
GET
/cloud/subscriptions/{subscriptionId}/preflight/permissions/session-host-create
Preflight permissions to provision session hosts · Check session host create permissions
#
Ask an LLM
“Can the service principal create session host VMs, NICs and disks and join the subnet I picked?”
“Will provisioning session hosts from a gallery image version fail because of missing permissions?”
Tell an agent
Check session host permissions in {subscriptionId} for group {resourceGroupName}, subnet {subnetResourceId}, image {imageVersionResourceId}.
Preflight session host VM provisioning in subscription {subscriptionId} for the host pool in resource group {hostPoolResourceGroupName}.
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/virtual-networks
Look up virtual networks in a subscription · Lookup virtual networks in a subscription
#
Ask an LLM
“Which virtual networks in my subscription can I place session hosts in?”
“What VNets does Azure report for this subscription?”
Tell an agent
List the virtual networks in subscription {subscriptionId}.
Find virtual networks in subscription {subscriptionId} matching {filter}.
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/virtual-machines
Look up VMs to promote to a master image · Lookup virtual machines in a subscription
#
Ask an LLM
“Which existing virtual machines in my subscription could I promote to a Master Image?”
“Does the VM lookup include machines DaaS IQ doesn't manage?”
Tell an agent
List the Azure virtual machines in subscription {subscriptionId}.
Find a VM in subscription {subscriptionId} matching {filter} that I can turn into a master image.
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/galleries
Look up Azure Compute Galleries · Lookup Azure Compute Galleries in a subscription
#
Ask an LLM
“What Azure Compute Galleries exist in my subscription?”
“Where are my image galleries, before I drill into image definitions?”
Tell an agent
List the compute galleries in subscription {subscriptionId}.
Show image galleries in subscription {subscriptionId} sorted by {sort}.
GET
/cloud/subscriptions/{subscriptionId}/lookup/resource-groups
Look up resource groups in a subscription · Lookup Azure resource groups in a subscription
#
Ask an LLM
“Which resource groups can I create new resources in for this subscription?”
“Can I filter the Azure resource groups in a subscription by name?”
Tell an agent
List the resource groups in subscription {subscriptionId}.
Find resource groups in subscription {subscriptionId} matching {filter}.
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/workspaces
Look up AVD workspaces in a subscription · Lookup AVD workspaces in a subscription
#
Ask an LLM
“Which AVD workspaces exist in my Azure subscription right now?”
“What workspace should I link a new host pool to?”
Tell an agent
Look up the AVD workspaces in subscription {subscriptionId}.
Find AVD workspaces in subscription {subscriptionId} matching {filter}.
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/managed-images
Look up standalone managed images · Lookup Azure Managed Images in a subscription
#
Ask an LLM
“What standalone managed images do I have outside of any gallery?”
“Which managed images in my subscription are HyperV generation 2?”
Tell an agent
List the managed images in subscription {subscriptionId}.
Find managed images in subscription {subscriptionId} matching {filter}.
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/gallery-images
Look up gallery image definitions · Lookup gallery images in a subscription
#
Ask an LLM
“What image definitions are inside my compute galleries?”
“Which named gallery images exist, before I pick a version?”
Tell an agent
List gallery image definitions in subscription {subscriptionId}.
Find gallery image definitions in subscription {subscriptionId} matching {filter}.
GET
/cloud/subscriptions/{subscriptionId}/lookup/resources/gallery-image-versions
Look up published gallery image versions · Lookup gallery image versions in a subscription
#
Ask an LLM
“Which published image versions can I deploy session hosts from?”
“What concrete versions exist for my gallery image definitions?”
Tell an agent
List the gallery image versions in subscription {subscriptionId}.
Find deployable image versions in subscription {subscriptionId} matching {filter}.
GET
/cloud/subscriptions/{id}/resources/discover
Discover resources by type in a subscription (deprecated) · Discover resources in a subscription (Deprecated)
#
Ask an LLM
“Can I discover cloud resources of specific types through the older subscription-level discovery call?”
“What resource types can the deprecated subscription discovery endpoint return?”
Tell an agent
Discover resources of types {types} in subscription {id} using the legacy endpoint.
Run deprecated resource discovery on subscription {id} for {types}.
GET
/cloud/subscriptions/{id}/resources/discover/hostpools
Discover host pools in a subscription (deprecated) · Discover host pools in a subscription (Deprecated)
#
Ask an LLM
“Which Azure host pools could I import from a subscription using the old discovery endpoint?”
“Is there a legacy way to find host pools in one subscription that aren't onboarded yet?”
Tell an agent
Discover host pools in subscription {id} with the deprecated discovery call.
Find importable host pools in subscription {id} matching {filter}.
GET
/cloud/subscriptions/{id}/resources/discover/images
Discover images in a subscription (deprecated) · Discover images in a subscription (Deprecated)
#
Ask an LLM
“Can I find image metadata in a subscription using the older discovery endpoint?”
“Which images does the legacy subscription discovery turn up?”
Tell an agent
Discover images in subscription {id} with the deprecated discovery call.
Show page {page} of legacy image discovery results for subscription {id}.
POST
/cloud/subscriptions/{id}/resources/import
Import discovered resources into management (deprecated) · Import cloud resources (Deprecated)
#
Ask an LLM
“Can I import every discovered resource from a subscription in one background job?”
“How do I bring specific discovered resources under management with the old subscription import?”
Tell an agent
Import all resources from subscription {id} using the legacy import job.
Start a deprecated import job for subscription {id} with these resources: {resources}.
Ask an LLM
“Which cloud subscriptions are registered in my ControlUp organization?”
“Can I list only the Azure subscriptions and see which tenant owns each?”
Tell an agent
List all cloud subscriptions in my organization.
List the registered subscriptions for provider {provider}.
POST
/cloud/subscriptions
Register a cloud subscription (deprecated) · Create a subscription (Deprecated)
#
Ask an LLM
“Can I still register a subscription directly with its own credentials instead of through a tenant?”
“What do I need to add an Azure subscription with the older create endpoint?”
Tell an agent
Register subscription {providerSubscriptionId} as {name} on provider {provider} with auth type {authType} and credentials {credentials}.
Use the deprecated create call to add subscription {providerSubscriptionId} named {name}.
Ask an LLM
“What is the lifecycle state and owning tenant of one specific subscription?”
“Can I fetch a single subscription's provider identifiers by its ID?”
Tell an agent
Get subscription {id}.
Show the owning tenant and state of subscription {id}.
PUT
/cloud/subscriptions/{id}
Replace a subscription's settings (deprecated) · Update a subscription (Deprecated)
#
Ask an LLM
“Can I overwrite a subscription's name, provider ID and credentials in one full update?”
“Is the full subscription update still supported or has it moved to tenant credentials?”
Tell an agent
Replace subscription {id}: name {name}, provider {provider}, ID {providerSubscriptionId}, auth {authType}, credentials {credentials}.
Replace the configuration of subscription {id} using the legacy PUT, naming it {name}.
PATCH
/cloud/subscriptions/{id}
Rotate a subscription's credentials (deprecated) · Rotate subscription credentials (Deprecated)
#
Ask an LLM
“How can I rotate the secret on a subscription without re-registering it?”
“Can I rename a subscription while rotating its credentials?”
Tell an agent
Rotate the credentials on subscription {id} to {credentials}.
Rename subscription {id} to {name} with the legacy patch call.
DELETE
/cloud/subscriptions/{id}
Delete a subscription and its resources (deprecated) · Delete a subscription (Deprecated)
#
Ask an LLM
“What gets removed when I delete a cloud subscription with the old endpoint?”
“Can I remove a subscription and everything associated with it from ControlUp?”
Tell an agent destructive · confirm first
Delete subscription {id} and its associated resources.
Remove subscription {id} using the deprecated delete call.
GET
/cloud/subscriptions/{id}/status
Get a subscription's health status (deprecated) · Get subscription status (Deprecated)
#
Ask an LLM
“Is my subscription healthy according to the older status endpoint?”
“What health state does the deprecated subscription status call report?”
Tell an agent
Get the current status of subscription {id}.
Check subscription {id} health with the legacy status call.
POST
/cloud/subscriptions/{id}/status/refresh
Re-verify and refresh a subscription's status (deprecated) · Refresh subscription status (Deprecated)
#
Ask an LLM
“Can I force a subscription's status to be re-checked now instead of waiting?”
“After fixing credentials, how do I refresh the stored subscription status on the old endpoint?”
Tell an agent
Refresh the status of subscription {id}.
Re-verify subscription {id} and update its stored status.