ImageReference Class

  • java.lang.Object
    • com.microsoft.azure.management.batch.ImageReference

public 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
java.lang.String id()

Get this property is mutually exclusive with other properties.

java.lang.String offer()

Get for example, UbuntuServer or WindowsServer.

java.lang.String publisher()

Get for example, Canonical or MicrosoftWindowsServer.

java.lang.String sku()

Get for example, 18.04-LTS or 2019-Datacenter.

java.lang.String version()

Get a value of 'latest' can be specified to select the latest version of an image.

ImageReference withId(String id)

Set this property is mutually exclusive with other properties.

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

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ImageReference

public ImageReference()

Method Details

id

public String id()

Get 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 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, 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

withId

public ImageReference withId(String id)

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

Applies to