ImageReference Class

Package:

com.microsoft.azure.management.batchai

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

public class ImageReference

The OS image reference.

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

Method Details

offer

public String offer()

Get offer of the image.

Returns:

the offer value

publisher

public String publisher()

Get publisher of the image.

Returns:

the publisher value

sku

public String sku()

Get sKU of the image.

Returns:

the sku value

version

public String version()

Get version of the image.

Returns:

the version value

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

withOffer

public ImageReference withOffer(String offer)

Set offer of the image.

Parameters:

offer - the offer value to set

Returns:

the ImageReference object itself.

withPublisher

public ImageReference withPublisher(String publisher)

Set publisher of the image.

Parameters:

publisher - the publisher value to set

Returns:

the ImageReference object itself.

withSku

public ImageReference withSku(String sku)

Set sKU of the image.

Parameters:

sku - the sku value to set

Returns:

the ImageReference object itself.

withVersion

public ImageReference withVersion(String version)

Set version of the image.

Parameters:

version - the version value to set

Returns:

the ImageReference object itself.

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.