ImageReference Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.ImageReference

public class ImageReference

A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation.

Constructor Summary

Constructor Description
ImageReference()

Method Summary

Modifier and Type Method and Description
String communityGalleryImageId()

Get this property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
String exactVersion()

Get the specific version of the platform image or marketplace image used to create the node.
String offer()

Get for example, UbuntuServer or WindowsServer.
String publisher()

Get for example, Canonical or MicrosoftWindowsServer.
String sharedGalleryImageId()

Get this property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
String sku()

Get for example, 18.04-LTS or 2019-Datacenter.
String version()

Get a value of 'latest' can be specified to select the latest version of an Image.
String virtualMachineImageId()

Get this property is mutually exclusive with other ImageReference properties.
ImageReference withCommunityGalleryImageId(String communityGalleryImageId)

Set this property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
ImageReference withOffer(String offer)

Set for example, UbuntuServer or WindowsServer.
ImageReference withPublisher(String publisher)

Set for example, Canonical or MicrosoftWindowsServer.
ImageReference withSharedGalleryImageId(String sharedGalleryImageId)

Set this property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
ImageReference withSku(String sku)

Set for example, 18.04-LTS or 2019-Datacenter.
ImageReference withVersion(String version)

Set a value of 'latest' can be specified to select the latest version of an Image.
ImageReference withVirtualMachineImageId(String virtualMachineImageId)

Set this property is mutually exclusive with other ImageReference properties.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ImageReference

public ImageReference()

Method Details

communityGalleryImageId

public String communityGalleryImageId()

Get this property is mutually exclusive with other properties and can be fetched from community gallery image GET call.

Returns:

the communityGalleryImageId value

exactVersion

public String exactVersion()

Get the specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'.

Returns:

the exactVersion value

offer

public String offer()

Get for example, UbuntuServer or WindowsServer.

Returns:

the offer value

publisher

public String publisher()

Get for example, Canonical or MicrosoftWindowsServer.

Returns:

the publisher value

sharedGalleryImageId

public String sharedGalleryImageId()

Get 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 for example, 18.04-LTS or 2019-Datacenter.

Returns:

the sku value

version

public String version()

Get 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

virtualMachineImageId

public String virtualMachineImageId()

Get this property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/azure/batch/batch-api-basics\#virtual-network-vnet-and-firewall-configuration.

Returns:

the virtualMachineImageId value

withCommunityGalleryImageId

public ImageReference withCommunityGalleryImageId(String communityGalleryImageId)

Set 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.

withOffer

public ImageReference withOffer(String offer)

Set for example, UbuntuServer or WindowsServer.

Parameters:

offer - the offer value to set

Returns:

the ImageReference object itself.

withPublisher

public ImageReference withPublisher(String publisher)

Set for example, Canonical or MicrosoftWindowsServer.

Parameters:

publisher - the publisher value to set

Returns:

the ImageReference object itself.

withSharedGalleryImageId

public ImageReference withSharedGalleryImageId(String sharedGalleryImageId)

Set 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 for example, 18.04-LTS or 2019-Datacenter.

Parameters:

sku - the sku value to set

Returns:

the ImageReference object itself.

withVersion

public ImageReference withVersion(String version)

Set 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.

withVirtualMachineImageId

public ImageReference withVirtualMachineImageId(String virtualMachineImageId)

Set this property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/azure/batch/batch-api-basics\#virtual-network-vnet-and-firewall-configuration.

Parameters:

virtualMachineImageId - the virtualMachineImageId value to set

Returns:

the ImageReference object itself.

Applies to