CustomImage Class

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: _models.CustomImagePropertiesFromVm | None = None, vhd: _models.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['_models.DataDiskStorageTypeInfo'] | None = None, custom_image_plan: _models.CustomImagePropertiesFromPlan | None = None, is_plan_authorized: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str The location of the resource. Default value: None
tags	dict[str, str] The tags of the resource. Default value: None
vm	CustomImagePropertiesFromVm The virtual machine from which the image is to be created. Default value: None
vhd	CustomImagePropertiesCustom The VHD from which the image is to be created. Default value: None
description	str The description of the custom image. Default value: None
author	str The author of the custom image. Default value: None
managed_image_id	str The Managed Image Id backing the custom image. Default value: None
managed_snapshot_id	str The Managed Snapshot Id backing the custom image. Default value: None
data_disk_storage_info	list[DataDiskStorageTypeInfo] Storage information about the data disks present in the custom image. Default value: None
custom_image_plan	CustomImagePropertiesFromPlan Storage information about the plan related to this custom image. Default value: None
is_plan_authorized	bool Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment. 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.
location	str The location of the resource.
tags	dict[str, str] The tags of the resource.
vm	CustomImagePropertiesFromVm The virtual machine from which the image is to be created.
vhd	CustomImagePropertiesCustom The VHD from which the image is to be created.
description	str The description of the custom image.
author	str The author of the custom image.
creation_date	datetime The creation date of the custom image.
managed_image_id	str The Managed Image Id backing the custom image.
managed_snapshot_id	str The Managed Snapshot Id backing the custom image.
data_disk_storage_info	list[DataDiskStorageTypeInfo] Storage information about the data disks present in the custom image.
custom_image_plan	CustomImagePropertiesFromPlan Storage information about the plan related to this custom image.
is_plan_authorized	bool Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment.
provisioning_state	str The provisioning status of the resource.
unique_identifier	str The unique immutable identifier of a resource (Guid).

Feedback

Was this page helpful?