VirtualMachineConfigurationOutput interface

Package:

@azure-rest/batch

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

Properties

containerConfiguration	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.
dataDisks	The configuration for data disks attached to the Compute Nodes in the Pool. 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://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.
diskEncryptionConfiguration	The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning.
extensions	The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node.
imageReference	A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.
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 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.
nodeAgentSKUId	The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. 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.
nodePlacementConfiguration	The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated.
osDisk	Settings for the operating system disk of the Virtual Machine.
securityProfile	Specifies the security profile settings for the virtual machine or virtual machine scale set.
serviceArtifactReference	Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image.

Property Details

containerConfiguration

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.

containerConfiguration?: BatchContainerConfigurationOutput

Property Value

BatchContainerConfigurationOutput

dataDisks

The configuration for data disks attached to the Compute Nodes in the Pool. 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://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

dataDisks?: DataDiskOutput[]

Property Value

DataDiskOutput[]

diskEncryptionConfiguration

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

diskEncryptionConfiguration?: DiskEncryptionConfigurationOutput

Property Value

DiskEncryptionConfigurationOutput

extensions

The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node.

extensions?: VMExtensionOutput[]

Property Value

VMExtensionOutput[]

imageReference

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

imageReference: BatchVmImageReferenceOutput

Property Value

BatchVmImageReferenceOutput

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

licenseType?: string

Property Value

string

nodeAgentSKUId

The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. 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.

nodeAgentSKUId: string

Property Value

string

nodePlacementConfiguration

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

nodePlacementConfiguration?: BatchNodePlacementConfigurationOutput

Property Value

BatchNodePlacementConfigurationOutput

osDisk

Settings for the operating system disk of the Virtual Machine.

osDisk?: BatchOsDiskOutput

Property Value

BatchOsDiskOutput

securityProfile

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

securityProfile?: SecurityProfileOutput

Property Value

SecurityProfileOutput

serviceArtifactReference

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

serviceArtifactReference?: ServiceArtifactReferenceOutput

Property Value

ServiceArtifactReferenceOutput

windowsConfiguration

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

windowsConfiguration?: WindowsConfigurationOutput

Property Value

WindowsConfigurationOutput