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

Constructors

ImageReference()

Initializes a new instance of ImageReference.

Properties

CommunityGalleryImageId

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

ExactVersion

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

Resource Id.

(Inherited from ComputeWriteableSubResourceData)
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.

Explicit Interface Implementations

IJsonModel<ComputeWriteableSubResourceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ComputeWriteableSubResourceData)
IJsonModel<ComputeWriteableSubResourceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ComputeWriteableSubResourceData)
IJsonModel<ImageReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ImageReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ComputeWriteableSubResourceData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ComputeWriteableSubResourceData)
IPersistableModel<ComputeWriteableSubResourceData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ComputeWriteableSubResourceData)
IPersistableModel<ComputeWriteableSubResourceData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ComputeWriteableSubResourceData)
IPersistableModel<ImageReference>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ImageReference>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ImageReference>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to