VirtualMachineConfiguration Class

Package:

com.microsoft.azure.management.batch

• java.lang.Object
• • com.microsoft.azure.management.batch.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.
DiskEncryptionConfiguration	diskEncryptionConfiguration() Get if specified, encryption is performed on each node in the pool during node provisioning.
List<VMExtension>	extensions() Get if specified, the extensions mentioned in this configuration will be installed on each node.
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.
NodePlacementConfiguration	nodePlacementConfiguration() Get this configuration will specify rules on how nodes in the pool will be physically allocated.
OSDisk	osDisk() Get contains configuration for ephemeral OSDisk settings.
WindowsConfiguration	windowsConfiguration() Get this property must not be specified if the imageReference 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.
VirtualMachineConfiguration	withDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration) Set if specified, encryption is performed on each node in the pool during node provisioning.
VirtualMachineConfiguration	withExtensions(List<VMExtension> extensions) Set if specified, the extensions mentioned in this configuration will be installed on each node.
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	withNodePlacementConfiguration(NodePlacementConfiguration nodePlacementConfiguration) Set this configuration will specify rules on how nodes in the pool will be physically allocated.
VirtualMachineConfiguration	withOsDisk(OSDisk osDisk) Set contains configuration for ephemeral OSDisk settings.
VirtualMachineConfiguration	withWindowsConfiguration(WindowsConfiguration windowsConfiguration) Set this property must not be specified if the imageReference 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.

Returns:

the dataDisks value

diskEncryptionConfiguration

public DiskEncryptionConfiguration diskEncryptionConfiguration()

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

Returns:

the diskEncryptionConfiguration value

extensions

public List extensions()

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

Returns:

the extensions 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

nodePlacementConfiguration

public NodePlacementConfiguration nodePlacementConfiguration()

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

Returns:

the nodePlacementConfiguration value

osDisk

public OSDisk osDisk()

Get contains configuration for ephemeral OSDisk settings.

Returns:

the osDisk value

windowsConfiguration

public WindowsConfiguration windowsConfiguration()

Get this property must not be specified if the imageReference 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.

Parameters:

dataDisks - the dataDisks value to set

Returns:

the VirtualMachineConfiguration object itself.

withDiskEncryptionConfiguration

public VirtualMachineConfiguration withDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration)

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

Parameters:

diskEncryptionConfiguration - the diskEncryptionConfiguration value to set

Returns:

the VirtualMachineConfiguration object itself.

withExtensions

public VirtualMachineConfiguration withExtensions(List extensions)

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

Parameters:

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

withNodePlacementConfiguration

public VirtualMachineConfiguration withNodePlacementConfiguration(NodePlacementConfiguration nodePlacementConfiguration)

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

Parameters:

nodePlacementConfiguration - the nodePlacementConfiguration value to set

Returns:

the VirtualMachineConfiguration object itself.

withOsDisk

public VirtualMachineConfiguration withOsDisk(OSDisk osDisk)

Set contains configuration for ephemeral OSDisk settings.

Parameters:

osDisk - the osDisk value to set

Returns:

the VirtualMachineConfiguration object itself.

withWindowsConfiguration

public VirtualMachineConfiguration withWindowsConfiguration(WindowsConfiguration windowsConfiguration)

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

Parameters:

windowsConfiguration - the windowsConfiguration value to set

Returns:

the VirtualMachineConfiguration object itself.