ImageReference Class

  • Reference

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.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
Model
ImageReference

Constructor

ImageReference(*, publisher: Optional[str] = None, offer: Optional[str] = None, sku: Optional[str] = None, version: Optional[str] = None, virtual_machine_image_id: Optional[str] = None, **kwargs)

Parameters

publisher
str
Required

For example, Canonical or MicrosoftWindowsServer.

offer
str
Required

For example, UbuntuServer or WindowsServer.

sku
str
Required

For example, 18.04-LTS or 2019-Datacenter.

version
str
Required

A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'.

virtual_machine_image_id
str
Required

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.

Variables

exact_version
str

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