VirtualMachineConfiguration Class

Package:

com.azure.resourcemanager.batch.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-batch:1.0.0

• java.lang.Object
• • com.azure.resourcemanager.batch.models.VirtualMachineConfiguration

public final class VirtualMachineConfiguration

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

Constructor Summary

Constructor	Description
VirtualMachineConfiguration()

Method Summary

Modifier and Type	Method and Description
ContainerConfiguration	containerConfiguration() Get the containerConfiguration property: The configuration for container-enabled pools.
List<DataDisk>	dataDisks() Get the dataDisks property: The configuration for data disks attached to the compute nodes in the pool.
DiskEncryptionConfiguration	diskEncryptionConfiguration() Get the diskEncryptionConfiguration property: If specified, encryption is performed on each node in the pool during node provisioning.
List<VMExtension>	extensions() Get the extensions property: The virtual machine extension for the pool.
ImageReference	imageReference() Get the imageReference property: A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine.
String	licenseType() Get the licenseType property: The type of on-premises license to be used when deploying the operating system.
String	nodeAgentSkuId() Get the nodeAgentSkuId property: The SKU of the Batch node agent to be provisioned on compute nodes in the pool.
NodePlacementConfiguration	nodePlacementConfiguration() Get the nodePlacementConfiguration property: Node placement configuration for batch pools.
OSDisk	osDisk() Get the osDisk property: Settings for the operating system disk of the virtual machine.
void	validate() Validates the instance.
WindowsConfiguration	windowsConfiguration() Get the windowsConfiguration property: Windows operating system settings to apply to the virtual machine.
VirtualMachineConfiguration	withContainerConfiguration(ContainerConfiguration containerConfiguration) Set the containerConfiguration property: The configuration for container-enabled pools.
VirtualMachineConfiguration	withDataDisks(List<DataDisk> dataDisks) Set the dataDisks property: The configuration for data disks attached to the compute nodes in the pool.
VirtualMachineConfiguration	withDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration) Set the diskEncryptionConfiguration property: If specified, encryption is performed on each node in the pool during node provisioning.
VirtualMachineConfiguration	withExtensions(List<VMExtension> extensions) Set the extensions property: The virtual machine extension for the pool.
VirtualMachineConfiguration	withImageReference(ImageReference imageReference) Set the imageReference property: A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine.
VirtualMachineConfiguration	withLicenseType(String licenseType) Set the licenseType property: The type of on-premises license to be used when deploying the operating system.
VirtualMachineConfiguration	withNodeAgentSkuId(String nodeAgentSkuId) Set the nodeAgentSkuId property: The SKU of the Batch node agent to be provisioned on compute nodes in the pool.
VirtualMachineConfiguration	withNodePlacementConfiguration(NodePlacementConfiguration nodePlacementConfiguration) Set the nodePlacementConfiguration property: Node placement configuration for batch pools.
VirtualMachineConfiguration	withOsDisk(OSDisk osDisk) Set the osDisk property: Settings for the operating system disk of the virtual machine.
VirtualMachineConfiguration	withWindowsConfiguration(WindowsConfiguration windowsConfiguration) Set the windowsConfiguration property: Windows operating system settings to apply to the virtual machine.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VirtualMachineConfiguration

public VirtualMachineConfiguration()

Method Details

containerConfiguration

public ContainerConfiguration containerConfiguration()

Get the containerConfiguration property: The configuration for container-enabled pools. 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 the dataDisks property: 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.

Returns:

the dataDisks value.

diskEncryptionConfiguration

public DiskEncryptionConfiguration diskEncryptionConfiguration()

Get the diskEncryptionConfiguration property: If specified, encryption is performed on each node in the pool during node provisioning.

Returns:

the diskEncryptionConfiguration value.

extensions

public List extensions()

Get the extensions property: The virtual machine extension for the pool. 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 property: 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.

Returns:

the imageReference value.

licenseType

public String licenseType()

Get the licenseType property: The type of on-premises license to be used when deploying the operating system. 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 nodeAgentSkuId property: The SKU of the Batch node agent to be provisioned on compute nodes in the pool. 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 the nodePlacementConfiguration property: Node placement configuration for batch pools. This configuration will specify rules on how nodes in the pool will be physically allocated.

Returns:

the nodePlacementConfiguration value.

osDisk

public OSDisk osDisk()

Get the osDisk property: Settings for the operating system disk of the virtual machine. Contains configuration for ephemeral OSDisk settings.

Returns:

the osDisk value.

validate

public void validate()

Validates the instance.

windowsConfiguration

public WindowsConfiguration windowsConfiguration()

Get the windowsConfiguration property: Windows operating system settings to apply to the virtual machine. 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 the containerConfiguration property: The configuration for container-enabled pools. 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 the dataDisks property: 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.

Parameters:

dataDisks - the dataDisks value to set.

Returns:

the VirtualMachineConfiguration object itself.

withDiskEncryptionConfiguration

public VirtualMachineConfiguration withDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration)

Set the diskEncryptionConfiguration property: 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 the extensions property: The virtual machine extension for the pool. 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 property: 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.

Parameters:

imageReference - the imageReference value to set.

Returns:

the VirtualMachineConfiguration object itself.

withLicenseType

public VirtualMachineConfiguration withLicenseType(String licenseType)

Set the licenseType property: The type of on-premises license to be used when deploying the operating system. 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 nodeAgentSkuId property: The SKU of the Batch node agent to be provisioned on compute nodes in the pool. 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 the nodePlacementConfiguration property: Node placement configuration for batch pools. 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 the osDisk property: Settings for the operating system disk of the virtual machine. 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 the windowsConfiguration property: Windows operating system settings to apply to the virtual machine. 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.