API Reference

Deploy Master Image from curated Marketplace

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

Deploys a new Azure VM from a curated Marketplace OS image and registers it as a Master Image.
This is a long-running operation: the endpoint returns immediately with a Job tracking object.
Poll the Job StatusUrl for progress updates. The background job deploys the VM, creates the ACG
Image Definition, and transitions the Master Image from Deploying to Ready.
Use GET /master-images/marketplace-images to get the curated catalog of available images.

Body Params

Marketplace deployment parameters

Request to deploy a new Master Image VM from a curated Azure Marketplace OS image.

uuid
required

Internal subscription ID that owns the target resources.

string
required
length between 1 and 64

Source marketplace image slug from the curated catalog.

string
required
length between 1 and 64

Target Azure region where the new Master VM will be created.

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
128 to 4095

OS disk size in GiB. Defaults to 128 GiB for marketplace images. Cannot decrease below 128 GiB.

string | null

Optional target Azure Compute Gallery for the new Image Definition (full ARM resource ID).

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

Optional target Azure Resource Group for the new VM.

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
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.

string | null

Optional Image Definition publisher override.

string | null

Optional Image Definition offer override.

string | null

Optional Image Definition SKU override.

Responses

500

Internal server error.

Updated 2 days 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 2 days ago

Did this page help you?