Share via

ImageReference Class

  • Reference

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

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

Inheritance
azure.mgmt.compute.v2024_07_01.models._models_py3.SubResource
ImageReference

Constructor

ImageReference(*, id: str | None = None, publisher: str | None = None, offer: str | None = None, sku: str | None = None, version: str | None = None, shared_gallery_image_id: str | None = None, community_gallery_image_id: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource Id.
publisher
str

The image publisher.
offer
str

Specifies the offer of the platform image or marketplace image used to create the virtual machine.
sku
str

The image SKU.
version
str

Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' # pylint: disable=line-too-long in the 'id' field without version input.
shared_gallery_image_id
str

Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
community_gallery_image_id
str

Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

Variables

Name Description
id
str

Resource Id.
publisher
str

The image publisher.
offer
str

Specifies the offer of the platform image or marketplace image used to create the virtual machine.
sku
str

The image SKU.
version
str

Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' # pylint: disable=line-too-long in the 'id' field without version input.
exact_version
str

Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.
shared_gallery_image_id
str

Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
community_gallery_image_id
str

Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.