VirtualMachineConfiguration Class

The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.

All required parameters must be populated in order to send to Azure.

Inheritance
VirtualMachineConfiguration

Constructor

VirtualMachineConfiguration(*, image_reference, node_agent_sku_id: str, windows_configuration=None, data_disks=None, license_type: Optional[str] = None, container_configuration=None, disk_encryption_configuration=None, node_placement_configuration=None, extensions=None, os_disk=None, **kwargs)

Parameters

image_reference
ImageReference
Required

Required. A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.

node_agent_sku_id
str
Required

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

windows_configuration
WindowsConfiguration
Required

Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image.

data_disks
list[DataDisk]
Required

This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

license_type
str
Required

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

container_configuration
ContainerConfiguration
Required

The container configuration for the Pool. If specified, setup is performed on each Compute 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.

disk_encryption_configuration
DiskEncryptionConfiguration
Required

The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning.

node_placement_configuration
NodePlacementConfiguration
Required

The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated.

extensions
list[VMExtension]
Required

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

os_disk
OSDisk
Required

Settings for the operating system disk of the Virtual Machine.