API Reference

Promote existing VM as Master Image

post
https://api.controlup.com/daas-iq/v1/cloud/master-images/promote

Creates a new Master Image by registering an existing Azure VM.
Creates a corresponding Image Definition in the specified Azure Compute Gallery.
The VM must be Gen 2 (Trusted Launch) and not already imported.

Body Params

The promote request containing VM resource ID and metadata

Request to promote (import) an existing Azure VM as a managed Master Image.
Azure-derived fields (region, generation) are resolved server-side from the VM resource ID.

uuid
required

Foundry subscription ID containing the VM. Becomes the Master Image subscription.

string
required
length ≥ 1

ARM resource ID of the VM to import. Must belong to ControlUp.Foundry.Api.Dtos.Cloud.MasterImage.PromoteMasterImageRequest.SubscriptionId.

string | null

Optional ARM resource ID of the output Azure Compute Gallery.

string
required
length between 1 and 128

User-provided name for the Image Library.

string | null

Optional description.

tags
object | null

Up to 40 customer tags applied to newly created resources and retained for publishing.
System tags are added separately. Existing resources are not retagged.

string
enum
required

Operating system family for AVD-supported Master Images.
Used for AVD Agent logic and image classification.
Only OS families supported by Azure Virtual Desktop are included.
Reference: https://learn.microsoft.com/en-us/azure/virtual-desktop/prerequisites#operating-systems-and-licenses

string
required
length between 1 and 20

OS version/build string (e.g., "23H2", "22H2", "LTSC").

string | null

Optional Image Definition publisher override. Defaults to "ControlUp".

string | null

Optional Image Definition offer override. Defaults to slugified OsFamily (e.g., "windows-11-multisession").

string | null

Optional Image Definition SKU override. Defaults to slugified Name.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?