Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageReference

Package version

interface

An interface representing ImageReference.

summary

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.

Hierarchy

  • ImageReference

Index

Properties

Optional id

id: undefined | string
member

{string} [id] The ARM resource identifier of the virtual machine image. Computes nodes of the pool will be created using this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. This property is mutually exclusive with other properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For information about the firewall settings for Batch node agent to communicate with Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration .

Optional offer

offer: undefined | string
member

{string} [offer] The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer.

Optional publisher

publisher: undefined | string
member

{string} [publisher] The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer.

Optional sku

sku: undefined | string
member

{string} [sku] The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter.

Optional version

version: undefined | string
member

{string} [version] The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

Generated using TypeDoc