ImageMetadata Class

Metadata about the operating system image for the compute instance.

Inheritance

builtins.object

ImageMetadata

Constructor

ImageMetadata(*, is_latest_os_image_version: bool, current_image_version: str, latest_image_version: str)

Parameters

Name	Description
is_latest_os_image_version Required	bool Specifies if the compute instance is running on the latest OS image version.
current_image_version Required	str Version of the current image.
latest_image_version Required	str The latest image version.

Keyword-Only Parameters

Name	Description
is_latest_os_image_version Required
current_image_version Required
latest_image_version Required

Examples

Creating a ImageMetadata object.

   from azure.ai.ml.entities import ImageMetadata

   os_image_metadata = ImageMetadata(
       current_image_version="22.08.19",
       latest_image_version="22.08.20",
       is_latest_os_image_version=False,
   )

Attributes

current_image_version

The current OS image version number.

Returns

Type	Description
str	The current OS image version number.

is_latest_os_image_version

Whether or not a compute instance is running on the latest OS image version.

Returns

Type	Description
bool	Boolean indicating if the compute instance is running the latest OS image version.

latest_image_version

The latest OS image version number.

Returns

Type	Description
str	The latest OS image version number.