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 : Azure.ResourceManager.ComputeSchedule.Models.SubResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ComputeSchedule.Models.ImageReference>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ComputeSchedule.Models.ImageReference>
type ImageReference = class
    inherit SubResource
    interface IJsonModel<ImageReference>
    interface IPersistableModel<ImageReference>
Public Class ImageReference
Inherits SubResource
Implements IJsonModel(Of ImageReference), IPersistableModel(Of ImageReference)
Inheritance
ImageReference
Implements

Constructors

Name Description
ImageReference()

Initializes a new instance of ImageReference.

Properties

Name Description
CommunityGalleryImageId

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

Id

The ID of the sub-resource.

(Inherited from SubResource)
Offer

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

Publisher

The image publisher.

SharedGalleryImageUniqueId

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

Sku

The image SKU.

Version

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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<ImageReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ImageReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<SubResource>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from SubResource)
IJsonModel<SubResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from SubResource)
IPersistableModel<ImageReference>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ImageReference>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ImageReference>.Write(ModelReaderWriterOptions)
IPersistableModel<SubResource>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from SubResource)
IPersistableModel<SubResource>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from SubResource)
IPersistableModel<SubResource>.Write(ModelReaderWriterOptions) (Inherited from SubResource)

Applies to