Share via

CustomImage Class

  • Reference

A custom image.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

CustomImage(*, location: str | None = None, tags: Dict[str, str] | None = None, vm: CustomImagePropertiesFromVm | None = None, vhd: CustomImagePropertiesCustom | None = None, description: str | None = None, author: str | None = None, managed_image_id: str | None = None, managed_snapshot_id: str | None = None, data_disk_storage_info: List[DataDiskStorageTypeInfo] | None = None, custom_image_plan: CustomImagePropertiesFromPlan | None = None, is_plan_authorized: bool | None = None, **kwargs)

Parameters

Name Description
location
Required
str

The location of the resource.
tags
Required
dict[str, str]

A set of tags. The tags of the resource.
vm
Required
CustomImagePropertiesFromVm

The virtual machine from which the image is to be created.
vhd
Required
CustomImagePropertiesCustom

The VHD from which the image is to be created.
description
Required
str

The description of the custom image.
author
Required
str

The author of the custom image.
managed_image_id
Required
str

The Managed Image Id backing the custom image.
managed_snapshot_id
Required
str

The Managed Snapshot Id backing the custom image.
data_disk_storage_info
Required
list[DataDiskStorageTypeInfo]

Storage information about the data disks present in the custom image.
custom_image_plan
Required
CustomImagePropertiesFromPlan

Storage information about the plan related to this custom image.
is_plan_authorized
Required
bool

Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment.

Keyword-Only Parameters

Name Description
location
Default value: None
tags
Default value: None
vm
Default value: None
vhd
Default value: None
description
Default value: None
author
Default value: None
managed_image_id
Default value: None
managed_snapshot_id
Default value: None
data_disk_storage_info
Default value: None
custom_image_plan
Default value: None
is_plan_authorized
Default value: None

Variables

Name Description
id
str

The identifier of the resource.
name
str

The name of the resource.
type
str

The type of the resource.
creation_date
datetime

The creation date of the custom image.
provisioning_state
str

The provisioning status of the resource.
unique_identifier
str

The unique immutable identifier of a resource (Guid).