ImageReference Class

Definition

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.

public class ImageReference : Microsoft.Azure.Management.Compute.Models.SubResource
type ImageReference = class
    inherit SubResource
Public Class ImageReference
Inherits SubResource
Inheritance
ImageReference

Constructors

ImageReference()

Initializes a new instance of the ImageReference class.

ImageReference(String, String, String, String, String, String, String, String)

Initializes a new instance of the ImageReference class.

Properties

CommunityGalleryImageId

Gets or sets specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

ExactVersion

Gets 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'.

Id

Gets or sets resource Id

(Inherited from SubResource)
Offer

Gets or sets specifies the offer of the platform image or marketplace image used to create the virtual machine.

Publisher

Gets or sets the image publisher.

SharedGalleryImageId

Gets or sets specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

Sku

Gets or sets the image SKU.

Version

Gets or sets 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}' in the 'id' field without version input.

Applies to