Skip to main content

ImageResponse

An operating system image that can be used to create a VM.

idstring<uuid>

Unique identifier of the image.

namestringnullablerequired

Human-readable name of the image (for example, the OS name and version).

osFamilystringnullablerequired

Operating system family the image belongs to (for example, Windows or Linux).

sortOrderinteger<int32>

Relative ordering hint for displaying images in a list; lower values come first.

lifecycleStatusImageStatus (string)

Allowed value for lifecycle status.

Possible values: [Active, Deprecated]

isAvailableForCreationboolean

Whether the image can be used to create new VMs. True only when LifecycleStatus is active.

ImageResponse
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "osFamily": "string",
  "sortOrder": 0,
  "lifecycleStatus": "Active",
  "isAvailableForCreation": true
}