Share via

VirtualMachineConfiguration Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration

public class VirtualMachineConfiguration

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

Method Summary

Modifier and Type Method and Description
ContainerConfiguration containerConfiguration()

Get 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.
List<DataDisk> dataDisks()

Get 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 node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the 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.
ImageReference imageReference()

Get the imageReference value.
String licenseType()

Get 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.
String nodeAgentSKUId()

Get 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.
WindowsConfiguration windowsConfiguration()

Get this property must not be specified if the imageReference property specifies a Linux OS image.
VirtualMachineConfiguration withContainerConfiguration(ContainerConfiguration containerConfiguration)

Set 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.
VirtualMachineConfiguration withDataDisks(List<DataDisk> dataDisks)

Set 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 node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the 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.
VirtualMachineConfiguration withImageReference(ImageReference imageReference)

Set the imageReference value.
VirtualMachineConfiguration withLicenseType(String licenseType)

Set 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.
VirtualMachineConfiguration withNodeAgentSKUId(String nodeAgentSKUId)

Set 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.
VirtualMachineConfiguration withWindowsConfiguration(WindowsConfiguration windowsConfiguration)

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

Method Details

containerConfiguration

public ContainerConfiguration containerConfiguration()

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

Returns:

the containerConfiguration value

dataDisks

public List dataDisks()

Get 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 node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the 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.

Returns:

the dataDisks value

imageReference

public ImageReference imageReference()

Get the imageReference value.

Returns:

the imageReference value

licenseType

public String licenseType()

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

Returns:

the licenseType value

nodeAgentSKUId

public String nodeAgentSKUId()

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

Returns:

the nodeAgentSKUId value

windowsConfiguration

public WindowsConfiguration windowsConfiguration()

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

Returns:

the windowsConfiguration value

withContainerConfiguration

public VirtualMachineConfiguration withContainerConfiguration(ContainerConfiguration containerConfiguration)

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

Parameters:

containerConfiguration - the containerConfiguration value to set

Returns:

the VirtualMachineConfiguration object itself.

withDataDisks

public VirtualMachineConfiguration withDataDisks(List dataDisks)

Set 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 node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the 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.

Parameters:

dataDisks - the dataDisks value to set

Returns:

the VirtualMachineConfiguration object itself.

withImageReference

public VirtualMachineConfiguration withImageReference(ImageReference imageReference)

Set the imageReference value.

Parameters:

imageReference - the imageReference value to set

Returns:

the VirtualMachineConfiguration object itself.

withLicenseType

public VirtualMachineConfiguration withLicenseType(String licenseType)

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

Parameters:

licenseType - the licenseType value to set

Returns:

the VirtualMachineConfiguration object itself.

withNodeAgentSKUId

public VirtualMachineConfiguration withNodeAgentSKUId(String nodeAgentSKUId)

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

Parameters:

nodeAgentSKUId - the nodeAgentSKUId value to set

Returns:

the VirtualMachineConfiguration object itself.

withWindowsConfiguration

public VirtualMachineConfiguration withWindowsConfiguration(WindowsConfiguration windowsConfiguration)

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

Parameters:

windowsConfiguration - the windowsConfiguration value to set

Returns:

the VirtualMachineConfiguration object itself.

Applies to