ImageReference Class

Package:

com.azure.resourcemanager.batch.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-batch:1.0.0

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

public final class 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()

Method Summary

Modifier and Type	Method and Description
String	id() Get the id property: The ARM resource identifier of the Shared Image Gallery Image.
String	offer() Get the offer property: The offer type of the Azure Virtual Machines Marketplace image.
String	publisher() Get the publisher property: The publisher of the Azure Virtual Machines Marketplace image.
String	sku() Get the sku property: The SKU of the Azure Virtual Machines Marketplace image.
void	validate() Validates the instance.
String	version() Get the version property: The version of the Azure Virtual Machines Marketplace image.
ImageReference	withId(String id) Set the id property: The ARM resource identifier of the Shared Image Gallery Image.
ImageReference	withOffer(String offer) Set the offer property: The offer type of the Azure Virtual Machines Marketplace image.
ImageReference	withPublisher(String publisher) Set the publisher property: The publisher of the Azure Virtual Machines Marketplace image.
ImageReference	withSku(String sku) Set the sku property: The SKU of the Azure Virtual Machines Marketplace image.
ImageReference	withVersion(String version) Set the version property: The version of the Azure Virtual Machines Marketplace image.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ImageReference

public ImageReference()

Method Details

id

public String id()

Get the id property: The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}. This property is mutually exclusive with other properties. The Shared Image 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: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer.

Returns:

the offer value.

publisher

public String publisher()

Get the publisher property: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer.

Returns:

the publisher value.

sku

public String sku()

Get the sku property: The SKU of the Azure Virtual Machines Marketplace image. For example, 18.04-LTS or 2022-datacenter.

Returns:

the sku value.

validate

public void validate()

Validates the instance.

version

public String version()

Get the version property: The version of the Azure Virtual Machines Marketplace image. 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.

withId

public ImageReference withId(String id)

Set the id property: The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}. This property is mutually exclusive with other properties. The Shared Image 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: The offer type of the Azure Virtual Machines Marketplace image. 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: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer.

Parameters:

publisher - the publisher value to set.

Returns:

the ImageReference object itself.

withSku

public ImageReference withSku(String sku)

Set the sku property: The SKU of the Azure Virtual Machines Marketplace image. 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: The version of the Azure Virtual Machines Marketplace image. 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.