com.microsoft.azure.management.batchai

Class ImageReference

java.lang.Object

com.microsoft.azure.management.batchai.ImageReference

public class ImageReference
extends Object

The OS image reference.

Constructor Summary

Constructors

Constructor and Description
ImageReference()

Method Summary

Modifier and Type	Method and Description
String	offer() Get offer of the image.
String	publisher() Get publisher of the image.
String	sku() Get sKU of the image.
String	version() Get version of the image.
String	virtualMachineImageId() Get the ARM resource identifier of the virtual machine image for the compute nodes.
ImageReference	withOffer(String offer) Set offer of the image.
ImageReference	withPublisher(String publisher) Set publisher of the image.
ImageReference	withSku(String sku) Set sKU of the image.
ImageReference	withVersion(String version) Set version of the image.
ImageReference	withVirtualMachineImageId(String virtualMachineImageId) Set the ARM resource identifier of the virtual machine image for the compute nodes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageReference

public ImageReference()

Method Detail

publisher

public String publisher()

Get publisher of the image.

Returns:

the publisher value

withPublisher

public ImageReference withPublisher(String publisher)

Set publisher of the image.

Parameters:

publisher - the publisher value to set

Returns:

the ImageReference object itself.

offer

public String offer()

Get offer of the image.

Returns:

the offer value

withOffer

public ImageReference withOffer(String offer)

Set offer of the image.

Parameters:

offer - the offer value to set

Returns:

the ImageReference object itself.

sku

public String sku()

Get sKU of the image.

Returns:

the sku value

withSku

public ImageReference withSku(String sku)

Set sKU of the image.

Parameters:

sku - the sku value to set

Returns:

the ImageReference object itself.

version

public String version()

Get version of the image.

Returns:

the version value

withVersion

public ImageReference withVersion(String version)

Set version of the image.

Parameters:

version - the version value to set

Returns:

the ImageReference object itself.

virtualMachineImageId

public String virtualMachineImageId()

Get the ARM resource identifier of the virtual machine image for the compute nodes. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. The virtual machine image must be in the same region and subscription as the cluster. 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. Note, you need to provide publisher, offer and sku of the base OS image of which the custom image has been derived from.

Returns:

the virtualMachineImageId value

withVirtualMachineImageId

public ImageReference withVirtualMachineImageId(String virtualMachineImageId)

Set the ARM resource identifier of the virtual machine image for the compute nodes. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. The virtual machine image must be in the same region and subscription as the cluster. 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. Note, you need to provide publisher, offer and sku of the base OS image of which the custom image has been derived from.

Parameters:

virtualMachineImageId - the virtualMachineImageId value to set

Returns:

the ImageReference object itself.