API Reference

Deploy Master Image from Gallery image version

post
https://api.controlup.com/daas-iq/v1/cloud/master-images/deploy-from-gallery

Creates a new Master Image by deploying a fresh VM from a gallery image version.
This is a long-running operation: the endpoint returns immediately with a Job tracking object.
Poll the Job StatusUrl for progress updates. The Master Image starts in Deploying status
and transitions to Ready when the VM is provisioned.

Body Params

The deploy configuration including gallery source, infrastructure, and credentials

Request to deploy a new Master Image VM from an Azure Compute Gallery image version.

uuid
required

Foundry subscription ID for the new Master Image VM and its compute and network resources.

string
required
length ≥ 1

ARM resource ID of the source gallery image version.

string | null

Target region for the VM and new output image definition.

string
required
length ≥ 1

Target subnet for the new VM (full ARM resource ID, identifies both the VNet and subnet).

string
required
length between 1 and 64

Target VM size.

string
required
length between 1 and 64

Target OS disk storage account type.

int32 | null
1 to 4095

Optional OS disk size in GiB. Defaults to the source image version's disk size when omitted.
Cannot be less than the source image disk size.

string | null

Optional ARM resource ID of the output Azure Compute Gallery.

string | null
^[-\w.()]{0,89}[-\w()]$

Resource group for the new VM in ControlUp.Foundry.Api.Dtos.Cloud.MasterImage.DeployFromGalleryRequest.SubscriptionId. Defaults to rg-controlup-daas.

string
required
length between 1 and 64
^[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]$|^[a-zA-Z0-9]$

Name for the new Master VM, display name, and ACG Image Definition name.

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.

string
required
length between 1 and 64

Local administrator username for the new VM.

string
required
length between 12 and 123

Local administrator password for the new VM.

string | null

Optional description for the Master Image.

tags
object | null

Up to 40 customer tags applied to newly created resources and retained for publishing.
The implicit Master VM OS disk is tagged after deployment; all other created resources receive tags at creation.
System tags are added separately. Existing resources are not retagged.

string | null

Optional Image Definition publisher override.

string | null

Optional Image Definition offer override.

string | null

Optional Image Definition SKU override.

Responses

Updated 3 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 3 months ago

Did this page help you?