VirtualMachineConfiguration Class

Reference

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

All required parameters must be populated in order to send to server.

Inheritance: azure.mgmt.batch._serialization.Model

VirtualMachineConfiguration

Constructor

VirtualMachineConfiguration(*, image_reference: _models.ImageReference, node_agent_sku_id: str, windows_configuration: _models.WindowsConfiguration | None = None, data_disks: List[_models.DataDisk] | None = None, license_type: str | None = None, container_configuration: _models.ContainerConfiguration | None = None, disk_encryption_configuration: _models.DiskEncryptionConfiguration | None = None, node_placement_configuration: _models.NodePlacementConfiguration | None = None, extensions: List[_models.VMExtension] | None = None, os_disk: _models.OSDisk | None = None, security_profile: _models.SecurityProfile | None = None, service_artifact_reference: _models.ServiceArtifactReference | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
image_reference	ImageReference 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. Required.
node_agent_sku_id	str 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. Required.
windows_configuration	WindowsConfiguration This property must not be specified if the imageReference specifies a Linux OS image.
data_disks	list[DataDisk] This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.
license_type	str 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.
container_configuration	ContainerConfiguration 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.
disk_encryption_configuration	DiskEncryptionConfiguration If specified, encryption is performed on each node in the pool during node provisioning.
node_placement_configuration	NodePlacementConfiguration This configuration will specify rules on how nodes in the pool will be physically allocated.
extensions	list[VMExtension] If specified, the extensions mentioned in this configuration will be installed on each node.
os_disk	OSDisk Contains configuration for ephemeral OSDisk settings.
security_profile	SecurityProfile Specifies the security profile settings for the virtual machine or virtual machine scale set.
service_artifact_reference	ServiceArtifactReference The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}. # pylint: disable=line-too-long

Variables

Name	Description
image_reference	ImageReference 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. Required.
node_agent_sku_id	str 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. Required.
windows_configuration	WindowsConfiguration This property must not be specified if the imageReference specifies a Linux OS image.
data_disks	list[DataDisk] This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.
license_type	str 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.
container_configuration	ContainerConfiguration 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.
disk_encryption_configuration	DiskEncryptionConfiguration If specified, encryption is performed on each node in the pool during node provisioning.
node_placement_configuration	NodePlacementConfiguration This configuration will specify rules on how nodes in the pool will be physically allocated.
extensions	list[VMExtension] If specified, the extensions mentioned in this configuration will be installed on each node.
os_disk	OSDisk Contains configuration for ephemeral OSDisk settings.
security_profile	SecurityProfile Specifies the security profile settings for the virtual machine or virtual machine scale set.
service_artifact_reference	ServiceArtifactReference The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}. # pylint: disable=line-too-long

Share via

VirtualMachineConfiguration Class

Constructor

Keyword-Only Parameters

Variables

Additional resources