VirtualMachineConfiguration Class

Package:

com.azure.compute.batch.models

Maven Artifact:

com.azure:azure-compute-batch:1.0.0-beta.5

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

Implements

JsonSerializable<VirtualMachineConfiguration>

public final class VirtualMachineConfiguration
implements JsonSerializable<VirtualMachineConfiguration>

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

Constructor Summary

Constructor	Description
VirtualMachineConfiguration(BatchVmImageReference imageReference, String nodeAgentSkuId)	Creates an instance of VirtualMachineConfiguration class.

Method Summary

Modifier and Type	Method and Description
static VirtualMachineConfiguration	fromJson(JsonReader jsonReader) Reads an instance of VirtualMachineConfiguration from the JsonReader.
BatchContainerConfiguration	getContainerConfiguration() Get the containerConfiguration property: The container configuration for the Pool.
List<DataDisk>	getDataDisks() Get the dataDisks property: The configuration for data disks attached to the Compute Nodes in the Pool.
DiskEncryptionConfiguration	getDiskEncryptionConfiguration() Get the diskEncryptionConfiguration property: The disk encryption configuration for the pool.
List<VMExtension>	getExtensions() Get the extensions property: The virtual machine extension for the pool.
BatchVmImageReference	getImageReference() Get the imageReference property: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.
String	getLicenseType() Get the licenseType property: 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.
String	getNodeAgentSkuId() Get the nodeAgentSkuId property: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool.
BatchNodePlacementConfiguration	getNodePlacementConfiguration() Get the nodePlacementConfiguration property: The node placement configuration for the pool.
BatchOsDisk	getOsDisk() Get the osDisk property: Settings for the operating system disk of the Virtual Machine.
SecurityProfile	getSecurityProfile() Get the securityProfile property: Specifies the security profile settings for the virtual machine or virtual machine scale set.
ServiceArtifactReference	getServiceArtifactReference() Get the serviceArtifactReference property: 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.
WindowsConfiguration	getWindowsConfiguration() Get the windowsConfiguration property: Windows operating system settings on the virtual machine.
VirtualMachineConfiguration	setContainerConfiguration(BatchContainerConfiguration containerConfiguration) Set the containerConfiguration property: The container configuration for the Pool.
VirtualMachineConfiguration	setDataDisks(List<DataDisk> dataDisks) Set the dataDisks property: The configuration for data disks attached to the Compute Nodes in the Pool.
VirtualMachineConfiguration	setDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration) Set the diskEncryptionConfiguration property: The disk encryption configuration for the pool.
VirtualMachineConfiguration	setExtensions(List<VMExtension> extensions) Set the extensions property: The virtual machine extension for the pool.
VirtualMachineConfiguration	setLicenseType(String licenseType) Set the licenseType property: 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.
VirtualMachineConfiguration	setNodePlacementConfiguration(BatchNodePlacementConfiguration nodePlacementConfiguration) Set the nodePlacementConfiguration property: The node placement configuration for the pool.
VirtualMachineConfiguration	setOsDisk(BatchOsDisk osDisk) Set the osDisk property: Settings for the operating system disk of the Virtual Machine.
VirtualMachineConfiguration	setSecurityProfile(SecurityProfile securityProfile) Set the securityProfile property: Specifies the security profile settings for the virtual machine or virtual machine scale set.
VirtualMachineConfiguration	setServiceArtifactReference(ServiceArtifactReference serviceArtifactReference) Set the serviceArtifactReference property: 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.
VirtualMachineConfiguration	setWindowsConfiguration(WindowsConfiguration windowsConfiguration) Set the windowsConfiguration property: Windows operating system settings on the virtual machine.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VirtualMachineConfiguration

public VirtualMachineConfiguration(BatchVmImageReference imageReference, String nodeAgentSkuId)

Creates an instance of VirtualMachineConfiguration class.

Parameters:

imageReference - the imageReference value to set.

nodeAgentSkuId - the nodeAgentSkuId value to set.

Method Details

fromJson

public static VirtualMachineConfiguration fromJson(JsonReader jsonReader)

Reads an instance of VirtualMachineConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VirtualMachineConfiguration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getContainerConfiguration

public BatchContainerConfiguration getContainerConfiguration()

Get the containerConfiguration property: 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.

Returns:

the containerConfiguration value.

getDataDisks

public List<DataDisk> getDataDisks()

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

Returns:

the dataDisks value.

getDiskEncryptionConfiguration

public DiskEncryptionConfiguration getDiskEncryptionConfiguration()

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

Returns:

the diskEncryptionConfiguration value.

getExtensions

public List<VMExtension> getExtensions()

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.

getImageReference

public BatchVmImageReference getImageReference()

Get the imageReference property: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.

Returns:

the imageReference value.

getLicenseType

public String getLicenseType()

Get the licenseType property: 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.

Returns:

the licenseType value.

getNodeAgentSkuId

public String getNodeAgentSkuId()

Get the nodeAgentSkuId property: 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.

Returns:

the nodeAgentSkuId value.

getNodePlacementConfiguration

public BatchNodePlacementConfiguration getNodePlacementConfiguration()

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

Returns:

the nodePlacementConfiguration value.

getOsDisk

public BatchOsDisk getOsDisk()

Get the osDisk property: Settings for the operating system disk of the Virtual Machine.

Returns:

the osDisk value.

getSecurityProfile

public SecurityProfile getSecurityProfile()

Get the securityProfile property: Specifies the security profile settings for the virtual machine or virtual machine scale set.

Returns:

the securityProfile value.

getServiceArtifactReference

public ServiceArtifactReference getServiceArtifactReference()

Get the serviceArtifactReference property: 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}.

Returns:

the serviceArtifactReference value.

getWindowsConfiguration

public WindowsConfiguration getWindowsConfiguration()

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

Returns:

the windowsConfiguration value.

setContainerConfiguration

public VirtualMachineConfiguration setContainerConfiguration(BatchContainerConfiguration containerConfiguration)

Set the containerConfiguration property: 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.

Parameters:

containerConfiguration - the containerConfiguration value to set.

Returns:

the VirtualMachineConfiguration object itself.

setDataDisks

public VirtualMachineConfiguration setDataDisks(List<DataDisk> 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. 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.

Parameters:

dataDisks - the dataDisks value to set.

Returns:

the VirtualMachineConfiguration object itself.

setDiskEncryptionConfiguration

public VirtualMachineConfiguration setDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration)

Set the diskEncryptionConfiguration property: The disk encryption configuration for the pool. 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.

setExtensions

public VirtualMachineConfiguration setExtensions(List<VMExtension> 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.

setLicenseType

public VirtualMachineConfiguration setLicenseType(String licenseType)

Set the licenseType property: 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.

Parameters:

licenseType - the licenseType value to set.

Returns:

the VirtualMachineConfiguration object itself.

setNodePlacementConfiguration

public VirtualMachineConfiguration setNodePlacementConfiguration(BatchNodePlacementConfiguration nodePlacementConfiguration)

Set the nodePlacementConfiguration property: The node placement configuration for the pool. 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.

setOsDisk

public VirtualMachineConfiguration setOsDisk(BatchOsDisk osDisk)

Set the osDisk property: Settings for the operating system disk of the Virtual Machine.

Parameters:

osDisk - the osDisk value to set.

Returns:

the VirtualMachineConfiguration object itself.

setSecurityProfile

public VirtualMachineConfiguration setSecurityProfile(SecurityProfile securityProfile)

Set the securityProfile property: Specifies the security profile settings for the virtual machine or virtual machine scale set.

Parameters:

securityProfile - the securityProfile value to set.

Returns:

the VirtualMachineConfiguration object itself.

setServiceArtifactReference

public VirtualMachineConfiguration setServiceArtifactReference(ServiceArtifactReference serviceArtifactReference)

Set the serviceArtifactReference property: 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}.

Parameters:

serviceArtifactReference - the serviceArtifactReference value to set.

Returns:

the VirtualMachineConfiguration object itself.

setWindowsConfiguration

public VirtualMachineConfiguration setWindowsConfiguration(WindowsConfiguration windowsConfiguration)

Set the windowsConfiguration property: Windows operating system settings on the virtual machine. 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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException