Promote existing VM as Master Image

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

Internal subscription ID that contains the VM.

string
required
length ≥ 1

Full Azure ARM resource ID of the VM to import.

string | null

Optional ARM resource ID of an existing Azure Compute Gallery.

string
required
length between 1 and 128

User-provided name for the Image Library.

string | null

Optional description.

string
enum
required
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

500

Internal server error.

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