VirtualMachineConfiguration interface

Package:

@azure/arm-batch

The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

Properties

containerConfiguration	If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.
dataDisks	This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.
diskEncryptionConfiguration	If specified, encryption is performed on each node in the pool during node provisioning.
extensions	If specified, the extensions mentioned in this configuration will be installed on each node.
imageReference	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.
licenseType	This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.
nodeAgentSkuId	The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.
nodePlacementConfiguration	This configuration will specify rules on how nodes in the pool will be physically allocated.
osDisk	Contains configuration for ephemeral OSDisk settings.
securityProfile	Specifies the security profile settings for the virtual machine or virtual machine scale set.
serviceArtifactReference	The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	This property must not be specified if the imageReference specifies a Linux OS image.

Property Details

containerConfiguration

If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

containerConfiguration?: ContainerConfiguration

Property Value

ContainerConfiguration

dataDisks

This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.

dataDisks?: DataDisk[]

Property Value

DataDisk[]

diskEncryptionConfiguration

If specified, encryption is performed on each node in the pool during node provisioning.

diskEncryptionConfiguration?: DiskEncryptionConfiguration

Property Value

DiskEncryptionConfiguration

extensions

If specified, the extensions mentioned in this configuration will be installed on each node.

extensions?: VMExtension[]

Property Value

VMExtension[]

imageReference

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.

imageReference: ImageReference

Property Value

ImageReference

licenseType

This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

licenseType?: string

Property Value

string

nodeAgentSkuId

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.

nodeAgentSkuId: string

Property Value

string

nodePlacementConfiguration

This configuration will specify rules on how nodes in the pool will be physically allocated.

nodePlacementConfiguration?: NodePlacementConfiguration

Property Value

NodePlacementConfiguration

osDisk

Contains configuration for ephemeral OSDisk settings.

osDisk?: OSDisk

Property Value

OSDisk

securityProfile

Specifies the security profile settings for the virtual machine or virtual machine scale set.

securityProfile?: SecurityProfile

Property Value

SecurityProfile

serviceArtifactReference

The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

serviceArtifactReference?: ServiceArtifactReference

Property Value

ServiceArtifactReference

windowsConfiguration

This property must not be specified if the imageReference specifies a Linux OS image.

windowsConfiguration?: WindowsConfiguration

Property Value

WindowsConfiguration