Share via

ImageReference Class

  • Reference
Package:
com.azure.resourcemanager.compute.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0

public final class ImageReference
extends SubResource

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.

Constructor Summary

Constructor Description
ImageReference()

Creates an instance of ImageReference class.

Method Summary

Modifier and Type Method and Description
String communityGalleryImageId()

Get the communityGalleryImageId property: Specified the community gallery image unique id for vm deployment.
String exactVersion()

Get the exactVersion property: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine.
static ImageReference fromJson(JsonReader jsonReader)

Reads an instance of ImageReference from the JsonReader.
String offer()

Get the offer property: Specifies the offer of the platform image or marketplace image used to create the virtual machine.
String publisher()

Get the publisher property: The image publisher.
String sharedGalleryImageId()

Get the sharedGalleryImageId property: Specified the shared gallery image unique id for vm deployment.
String sku()

Get the sku property: The image SKU.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
String version()

Get the version property: Specifies the version of the platform image or marketplace image used to create the virtual machine.
ImageReference withCommunityGalleryImageId(String communityGalleryImageId)

Set the communityGalleryImageId property: Specified the community gallery image unique id for vm deployment.
ImageReference withId(String id)
ImageReference withOffer(String offer)

Set the offer property: Specifies the offer of the platform image or marketplace image used to create the virtual machine.
ImageReference withPublisher(String publisher)

Set the publisher property: The image publisher.
ImageReference withSharedGalleryImageId(String sharedGalleryImageId)

Set the sharedGalleryImageId property: Specified the shared gallery image unique id for vm deployment.
ImageReference withSku(String sku)

Set the sku property: The image SKU.
ImageReference withVersion(String version)

Set the version property: Specifies the version of the platform image or marketplace image used to create the virtual machine.

Methods inherited from SubResource

fromJson id toJson withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ImageReference

public ImageReference()

Creates an instance of ImageReference class.

Method Details

communityGalleryImageId

public String communityGalleryImageId()

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

Returns:

the communityGalleryImageId value.

exactVersion

public String exactVersion()

Get the exactVersion property: 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'.

Returns:

the exactVersion value.

fromJson

public static ImageReference fromJson(JsonReader jsonReader)

Reads an instance of ImageReference from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ImageReference if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the ImageReference.

offer

public String offer()

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

Returns:

the offer value.

publisher

public String publisher()

Get the publisher property: The image publisher.

Returns:

the publisher value.

sharedGalleryImageId

public String sharedGalleryImageId()

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

Returns:

the sharedGalleryImageId value.

sku

public String sku()

Get the sku property: The image SKU.

Returns:

the sku value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ImageReference.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

version

public String version()

Get the version property: 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.

Returns:

the version value.

withCommunityGalleryImageId

public ImageReference withCommunityGalleryImageId(String communityGalleryImageId)

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

Parameters:

communityGalleryImageId - the communityGalleryImageId value to set.

Returns:

the ImageReference object itself.

withId

public ImageReference withId(String id)

Overrides:

ImageReference.withId(String id)

Parameters:

id

withOffer

public ImageReference withOffer(String offer)

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

Parameters:

offer - the offer value to set.

Returns:

the ImageReference object itself.

withPublisher

public ImageReference withPublisher(String publisher)

Set the publisher property: The image publisher.

Parameters:

publisher - the publisher value to set.

Returns:

the ImageReference object itself.

withSharedGalleryImageId

public ImageReference withSharedGalleryImageId(String sharedGalleryImageId)

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

Parameters:

sharedGalleryImageId - the sharedGalleryImageId value to set.

Returns:

the ImageReference object itself.

withSku

public ImageReference withSku(String sku)

Set the sku property: The image SKU.

Parameters:

sku - the sku value to set.

Returns:

the ImageReference object itself.

withVersion

public ImageReference withVersion(String version)

Set the version property: 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.

Parameters:

version - the version value to set.

Returns:

the ImageReference object itself.

Applies to