ImageReference Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.ImageReference

public class ImageReference

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

Method Summary

Modifier and Type Method and Description
String offer()

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

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

Get for example, 14.04.0-LTS or 2012-R2-Datacenter.
String version()

Get a value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.
String virtualMachineImageId()

Get this property is mutually exclusive with other ImageReference properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For more details, see https://docs.microsoft.com/azure/batch/batch-custom-images.
ImageReference withOffer(String offer)

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

Set for example, Canonical or MicrosoftWindowsServer.
ImageReference withSku(String sku)

Set for example, 14.04.0-LTS or 2012-R2-Datacenter.
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'.
ImageReference withVirtualMachineImageId(String virtualMachineImageId)

Set this property is mutually exclusive with other ImageReference properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For more details, see https://docs.microsoft.com/azure/batch/batch-custom-images.

Method Details

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

sku

public String sku()

Get for example, 14.04.0-LTS or 2012-R2-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 virtual machine image must be in the same region and subscription as the Azure Batch account. For more details, see https://docs.microsoft.com/azure/batch/batch-custom-images.

Returns:

the virtualMachineImageId value

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.

withSku

public ImageReference withSku(String sku)

Set for example, 14.04.0-LTS or 2012-R2-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 virtual machine image must be in the same region and subscription as the Azure Batch account. For more details, see https://docs.microsoft.com/azure/batch/batch-custom-images.

Parameters:

virtualMachineImageId - the virtualMachineImageId value to set

Returns:

the ImageReference object itself.

Applies to