VirtualMachineConfiguration Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. VirtualMachineConfiguration
- com.
public 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 |
---|---|
Container |
containerConfiguration()
Get if specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. |
List<Data |
dataDisks()
Get this property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. |
Disk |
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. |
Image |
imageReference()
Get the image |
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 Compute Nodes which will be deployed. |
String |
nodeAgentSKUId()
Get 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. |
Node |
nodePlacementConfiguration()
Get this configuration will specify rules on how nodes in the pool will be physically allocated. |
OSDisk |
osDisk()
Get the os |
Security |
securityProfile()
Get the security |
Service |
serviceArtifactReference()
Get the service artifact reference id in the form of /subscriptions/{subscription |
Windows |
windowsConfiguration()
Get this property must not be specified if the image |
Virtual |
withContainerConfiguration(ContainerConfiguration containerConfiguration)
Set if specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. |
Virtual |
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. |
Virtual |
withDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration)
Set if specified, encryption is performed on each node in the pool during node provisioning. |
Virtual |
withExtensions(List<VMExtension> extensions)
Set if specified, the extensions mentioned in this configuration will be installed on each node. |
Virtual |
withImageReference(ImageReference imageReference)
Set the image |
Virtual |
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 Compute Nodes which will be deployed. |
Virtual |
withNodeAgentSKUId(String nodeAgentSKUId)
Set 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. |
Virtual |
withNodePlacementConfiguration(NodePlacementConfiguration nodePlacementConfiguration)
Set this configuration will specify rules on how nodes in the pool will be physically allocated. |
Virtual |
withOsDisk(OSDisk osDisk)
Set the os |
Virtual |
withSecurityProfile(SecurityProfile securityProfile)
Set the security |
Virtual |
withServiceArtifactReference(ServiceArtifactReference serviceArtifactReference)
Set the service artifact reference id in the form of /subscriptions/{subscription |
Virtual |
withWindowsConfiguration(WindowsConfiguration windowsConfiguration)
Set this property must not be specified if the image |
Methods inherited from java.lang.Object
Constructor Details
VirtualMachineConfiguration
public VirtualMachineConfiguration()
Method Details
containerConfiguration
public ContainerConfiguration containerConfiguration()
Get 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:
dataDisks
public List
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 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://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk\#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps\#add-an-empty-data-disk-to-a-virtual-machine.
Returns:
diskEncryptionConfiguration
public DiskEncryptionConfiguration diskEncryptionConfiguration()
Get if specified, encryption is performed on each node in the pool during node provisioning.
Returns:
extensions
public List
Get if specified, the extensions mentioned in this configuration will be installed on each node.
Returns:
imageReference
public ImageReference imageReference()
Get the imageReference value.
Returns:
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 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:
nodeAgentSKUId
public String nodeAgentSKUId()
Get 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:
nodePlacementConfiguration
public NodePlacementConfiguration nodePlacementConfiguration()
Get this configuration will specify rules on how nodes in the pool will be physically allocated.
Returns:
osDisk
public OSDisk osDisk()
Get the osDisk value.
Returns:
securityProfile
public SecurityProfile securityProfile()
Get the securityProfile value.
Returns:
serviceArtifactReference
public ServiceArtifactReference serviceArtifactReference()
Get the service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}.
Returns:
windowsConfiguration
public WindowsConfiguration windowsConfiguration()
Get this property must not be specified if the imageReference property specifies a Linux OS Image.
Returns:
withContainerConfiguration
public VirtualMachineConfiguration withContainerConfiguration(ContainerConfiguration containerConfiguration)
Set 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:
Returns:
withDataDisks
public VirtualMachineConfiguration withDataDisks(List
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 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://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk\#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps\#add-an-empty-data-disk-to-a-virtual-machine.
Parameters:
Returns:
withDiskEncryptionConfiguration
public VirtualMachineConfiguration withDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration)
Set if specified, encryption is performed on each node in the pool during node provisioning.
Parameters:
Returns:
withExtensions
public VirtualMachineConfiguration withExtensions(List
Set if specified, the extensions mentioned in this configuration will be installed on each node.
Parameters:
Returns:
withImageReference
public VirtualMachineConfiguration withImageReference(ImageReference imageReference)
Set the imageReference value.
Parameters:
Returns:
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 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:
Returns:
withNodeAgentSKUId
public VirtualMachineConfiguration withNodeAgentSKUId(String nodeAgentSKUId)
Set 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.
Parameters:
Returns:
withNodePlacementConfiguration
public VirtualMachineConfiguration withNodePlacementConfiguration(NodePlacementConfiguration nodePlacementConfiguration)
Set this configuration will specify rules on how nodes in the pool will be physically allocated.
Parameters:
Returns:
withOsDisk
public VirtualMachineConfiguration withOsDisk(OSDisk osDisk)
Set the osDisk value.
Parameters:
Returns:
withSecurityProfile
public VirtualMachineConfiguration withSecurityProfile(SecurityProfile securityProfile)
Set the securityProfile value.
Parameters:
Returns:
withServiceArtifactReference
public VirtualMachineConfiguration withServiceArtifactReference(ServiceArtifactReference serviceArtifactReference)
Set the service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}.
Parameters:
Returns:
withWindowsConfiguration
public VirtualMachineConfiguration withWindowsConfiguration(WindowsConfiguration windowsConfiguration)
Set this property must not be specified if the imageReference property specifies a Linux OS Image.
Parameters:
Returns:
Applies to
Azure SDK for Java