Package com.microsoft.azure.batch.protocol.models

Class ImageReference

  • public class ImageReference
extends Object
    A reference to an Azure Virtual Machines Marketplace Image or a Shared Image Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation.

    • Constructor Detail

      • ImageReference

        public ImageReference()

    • Method Detail

      • publisher

        public String publisher()
        Get for example, Canonical or MicrosoftWindowsServer.
        Returns:
        the publisher value

      • withPublisher

        public ImageReference withPublisher​(String publisher)
        Set for example, Canonical or MicrosoftWindowsServer.
        Parameters:
        publisher - the publisher value to set
        Returns:
        the ImageReference object itself.

      • offer

        public String offer()
        Get for example, UbuntuServer or WindowsServer.
        Returns:
        the offer 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.

      • sku

        public String sku()
        Get for example, 18.04-LTS or 2019-Datacenter.
        Returns:
        the sku value

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

      • 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

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

      • virtualMachineImageId

        public String virtualMachineImageId()
        Get this property is mutually exclusive with other ImageReference properties. The Shared Image 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/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
        Returns:
        the virtualMachineImageId value

      • withVirtualMachineImageId

        public ImageReference withVirtualMachineImageId​(String virtualMachineImageId)
        Set this property is mutually exclusive with other ImageReference properties. The Shared Image 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/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
        Parameters:
        virtualMachineImageId - the virtualMachineImageId value to set
        Returns:
        the ImageReference object itself.

      • 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