ImageReference Class

Package:

com.azure.resourcemanager.batch.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-batch:2.0.0

• java.lang.Object
• • com.azure.resourcemanager.batch.models.ImageReference

Implements

JsonSerializable<ImageReference>

public final class ImageReference
implements JsonSerializable<ImageReference>

A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.

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: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
static ImageReference	fromJson(JsonReader jsonReader) Reads an instance of ImageReference from the JsonReader.
String	id() Get the id property: This property is mutually exclusive with other properties.
String	offer() Get the offer property: For example, UbuntuServer or WindowsServer.
String	publisher() Get the publisher property: For example, Canonical or MicrosoftWindowsServer.
String	sharedGalleryImageId() Get the sharedGalleryImageId property: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
String	sku() Get the sku property: For example, 18.04-LTS or 2022-datacenter.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
String	version() Get the version property: A value of 'latest' can be specified to select the latest version of an image.
ImageReference	withCommunityGalleryImageId(String communityGalleryImageId) Set the communityGalleryImageId property: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
ImageReference	withId(String id) Set the id property: This property is mutually exclusive with other properties.
ImageReference	withOffer(String offer) Set the offer property: For example, UbuntuServer or WindowsServer.
ImageReference	withPublisher(String publisher) Set the publisher property: For example, Canonical or MicrosoftWindowsServer.
ImageReference	withSharedGalleryImageId(String sharedGalleryImageId) Set the sharedGalleryImageId property: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
ImageReference	withSku(String sku) Set the sku property: For example, 18.04-LTS or 2022-datacenter.
ImageReference	withVersion(String version) Set the version property: A value of 'latest' can be specified to select the latest version of an image.

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: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.

Returns:

the communityGalleryImageId 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.

id

public String id()

Get the id property: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics\#virtual-network-vnet-and-firewall-configuration.

Returns:

the id value.

offer

public String offer()

Get the offer property: For example, UbuntuServer or WindowsServer.

Returns:

the offer value.

publisher

public String publisher()

Get the publisher property: For example, Canonical or MicrosoftWindowsServer.

Returns:

the publisher value.

sharedGalleryImageId

public String sharedGalleryImageId()

Get the sharedGalleryImageId property: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.

Returns:

the sharedGalleryImageId value.

sku

public String sku()

Get the sku property: For example, 18.04-LTS or 2022-datacenter.

Returns:

the sku value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

version

public String version()

Get the version property: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

Returns:

the version value.

withCommunityGalleryImageId

public ImageReference withCommunityGalleryImageId(String communityGalleryImageId)

Set the communityGalleryImageId property: This property is mutually exclusive with other properties and 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)

Set the id property: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics\#virtual-network-vnet-and-firewall-configuration.

Parameters:

id - the id value to set.

Returns:

the ImageReference object itself.

withOffer

public ImageReference withOffer(String offer)

Set the offer property: For example, UbuntuServer or WindowsServer.

Parameters:

offer - the offer value to set.

Returns:

the ImageReference object itself.

withPublisher

public ImageReference withPublisher(String publisher)

Set the publisher property: For example, Canonical or MicrosoftWindowsServer.

Parameters:

publisher - the publisher value to set.

Returns:

the ImageReference object itself.

withSharedGalleryImageId

public ImageReference withSharedGalleryImageId(String sharedGalleryImageId)

Set the sharedGalleryImageId property: This property is mutually exclusive with other properties and 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: For example, 18.04-LTS or 2022-datacenter.

Parameters:

sku - the sku value to set.

Returns:

the ImageReference object itself.

withVersion

public ImageReference withVersion(String version)

Set the version property: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

Parameters:

version - the version value to set.

Returns:

the ImageReference object itself.