Share via

ImageReference interface

  • Reference
Package:
@azure/arm-batch

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.

Properties

communityGalleryImageId

This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
id

This property is mutually exclusive with other properties. The Azure Compute 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.
offer

For example, UbuntuServer or WindowsServer.
publisher

For example, Canonical or MicrosoftWindowsServer.
sharedGalleryImageId

This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
sku

For example, 18.04-LTS or 2022-datacenter.
version

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

Property Details

communityGalleryImageId

This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.

communityGalleryImageId?: string

Property Value

string

id

This property is mutually exclusive with other properties. The Azure Compute 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.

id?: string

Property Value

string

offer

For example, UbuntuServer or WindowsServer.

offer?: string

Property Value

string

publisher

For example, Canonical or MicrosoftWindowsServer.

publisher?: string

Property Value

string

sharedGalleryImageId

This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.

sharedGalleryImageId?: string

Property Value

string

sku

For example, 18.04-LTS or 2022-datacenter.

sku?: string

Property Value

string

version

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

version?: string

Property Value

string