ControlUp Master images API
The Master images API from ControlUp — 20 operation(s) for master images.
Operations 20
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/master-images/{id}/actions
Start or stop a master image VM · Execute an action on a master image
#
Ask an LLM
“Can I power on a master image's VM from the API?”
“What actions can run on a master image as a background job?”
Tell an agent
Run a {actionType} action on master image {id}.
Start the VM behind master image {id}.
GET
/cloud/master-images/{id}/rdp
Download an RDP file for a master image · Download an RDP file for a master image
#
Ask an LLM
“Can I get a .rdp file to connect to a master image VM?”
“Is there a remote desktop connection file for my golden image VM?”
Tell an agent
Download the RDP connection file for master image {id}.
Give me an RDP file to remote into master image {id}.
GET
/cloud/master-images/os-families
List supported master image OS families · Get supported OS families for Master Images
#
Ask an LLM
“Which operating system families does Azure Virtual Desktop support for master images?”
“What OS family IDs can I use when creating a master image?”
Tell an agent
List the supported OS families for master images.
Show the OS family catalog available for golden images.
GET
/cloud/master-images/marketplace-images
List curated Marketplace images · Get curated Marketplace images for deployment
#
Ask an LLM
“Which Azure Marketplace OS images can I deploy as a new master image?”
“Are the curated Marketplace images all Gen 2 with Trusted Launch?”
Tell an agent
List the curated Marketplace images available for new master images.
Show which Marketplace OS images I can deploy as a golden image.
Ask an LLM
“Which master images does my organization manage, and what's their power state?”
“Can I page through all golden images sorted by name?”
Tell an agent
List all master images.
List master images sorted by {sort}.
Ask an LLM
“What region, OS and gallery does a specific master image use?”
“Can I see the disk and security settings of one golden image?”
Tell an agent
Show master image {id}.
Get the details of master image {id}.
GET
/cloud/master-images/{id}/operation-state
Check a master image's in-flight operation · Get Master Image operation state
#
Ask an LLM
“Is there an operation currently running on my master image?”
“Which actions is a master image allowed to take right now?”
Tell an agent
Show the in-flight operation on master image {id}.
Check what actions master image {id} currently permits.
GET
/cloud/master-images/{id}/decommission-plan
Preview retiring a master image · Get decommission plan
#
Ask an LLM
“What would be deleted or kept if I retire a master image?”
“Can I dry-run decommissioning a golden image before doing it?”
Tell an agent
Preview the decommission plan for master image {id}.
Show what Azure resources retiring master image {id} would delete.
POST
/cloud/master-images/promote
Promote an existing VM to master image · Promote existing VM as Master Image
#
Ask an LLM
“Can I register an existing Azure VM as a master image?”
“What OS details are required to promote a VM to a golden image?”
Tell an agent
Promote VM {vmResourceId} in subscription {subscriptionId} to master image {name} as {osFamily} {osVersion}.
Register VM {vmResourceId} as a master image in gallery {galleryResourceId}.
POST
/cloud/master-images/deploy-from-gallery
Deploy a master image from a gallery version · Deploy Master Image from Gallery image version
#
Ask an LLM
“Can I build a new master image VM from an existing Azure Compute Gallery image version?”
“How do I track the job when deploying a master image from a gallery version?”
Tell an agent
Deploy master image {masterName} from gallery image version {galleryImageVersionId} into subnet {subnetId} on subscription {subscriptionId}.
Create a master image from gallery version {galleryImageVersionId} with VM size {vmSize} and OS disk type {osDiskType}.
POST
/cloud/master-images/deploy-from-marketplace
Deploy a master image from a curated Marketplace OS · Deploy Master Image from curated Marketplace
#
Ask an LLM
“Can I spin up a brand-new master image VM from one of the curated Marketplace OS images?”
“Can I deploy an arbitrary Marketplace offer as a master image, or only curated catalog images?”
Tell an agent
Deploy master image {masterName} from curated Marketplace image {marketplaceImageId} in region {region}.
Create a new master VM from Marketplace image {marketplaceImageId} on subscription {subscriptionId}, size {vmSize}, in subnet {subnetId}.
POST
/cloud/master-images/deploy-from-managed-image
Deploy a master image from an Azure Managed Image · Deploy Master Image from Managed Image
#
Ask an LLM
“Can I turn an existing Azure Managed Image into a new master image VM?”
“Which region is used when deploying a master image from a managed image?”
Tell an agent
Deploy master image {masterName} from managed image {managedImageId} on subscription {subscriptionId}.
Create a master VM from Azure Managed Image {managedImageId} in subnet {subnetId} with VM size {vmSize}.
Ask an LLM
“Can I delete a master image and also remove its Azure resources?”
“Does deleting a master image only remove the record by default?”
Tell an agent destructive · confirm first
Delete master image {masterImageId}.
Delete master image {masterImageId} and deprovision its Azure resources.
POST
/cloud/master-images/{masterImageId}/publish
Publish a new master image version · Publish Master Image version
#
Ask an LLM
“Can I publish a new version of a master image to specific regions?”
“Can publishing also run the AVD agent update and SxS stack update?”
Tell an agent
Publish version {version} of master image {masterImageId} to {targetRegions}.
Publish master image {masterImageId} as {version} with the AVD agent update.
GET
/cloud/master-images/{masterImageId}/versions
List a master image's published versions · List Master Image versions
#
Ask an LLM
“What's the publish history of a master image?”
“Who published each version of my golden image, and to which regions?”
Tell an agent
List the versions of master image {masterImageId}.
Show the newest published versions of master image {masterImageId}.
GET
/cloud/master-images/{masterImageId}/versions/{versionId}/operation-state
Check a master image version's operations · Get Master Image version operation state
#
Ask an LLM
“Is a published image version still being worked on?”
“Can I retry or clean up a specific master image version right now?”
Tell an agent
Show the operation state of version {versionId} of master image {masterImageId}.
Check which actions version {versionId} of image {masterImageId} permits.
GET
/cloud/master-images/{masterImageId}/versions/{versionId}/publish-artifacts/cleanup-plan
Preview cleanup of publish leftovers · Get publish artifact cleanup plan
#
Ask an LLM
“Which temporary resources did a publish leave behind?”
“Can I preview what artifact cleanup would remove before running it?”
Tell an agent
Preview the publish artifact cleanup plan for version {versionId} of master image {masterImageId}.
Show leftover builder resources from publishing version {versionId} of image {masterImageId}.
DELETE
/cloud/master-images/{masterImageId}/versions/{versionId}
Delete a published master image version · Delete Master Image version
#
Ask an LLM
“Can I permanently remove one published gallery version of a master image?”
“Is deleting an image version different from cleaning up its publish artifacts?”
Tell an agent destructive · confirm first
Delete version {versionId} of master image {masterImageId}.
Permanently remove gallery version {versionId} from image {masterImageId}.
DELETE
/cloud/master-images/{masterImageId}/versions/{versionId}/publish-artifacts
Clean up publish leftover resources · Delete publish artifacts
#
Ask an LLM
“Can I delete the builder VM and disks a publish left behind?”
“Will cleaning up publish artifacts keep the published version itself?”
Tell an agent destructive · confirm first
Clean up publish artifacts for version {versionId} of master image {masterImageId}.
Remove the temporary builder VM left by publishing version {versionId} of image {masterImageId}.
POST
/cloud/master-images/{masterImageId}/versions/{versionId}/retry-publish
Retry a failed master image publish · Retry failed Master Image version publish
#
Ask an LLM
“My master image publish failed — can I rerun it with the same parameters?”
“Can I retry a failed image version publish instead of publishing it again from scratch?”
Tell an agent
Retry the failed publish of version {versionId} for master image {masterImageId}.
Rerun the last failed publish job for image {masterImageId} version {versionId}.