BatchVmConfiguration Class

Definition

Namespace:

Azure.ResourceManager.Batch.Models

Assembly:

Azure.ResourceManager.Batch.dll

Package:

Azure.ResourceManager.Batch v1.5.0

Source:

BatchVmConfiguration.cs

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

public class BatchVmConfiguration : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Batch.Models.BatchVmConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Batch.Models.BatchVmConfiguration>

type BatchVmConfiguration = class
    interface IJsonModel<BatchVmConfiguration>
    interface IPersistableModel<BatchVmConfiguration>

Public Class BatchVmConfiguration
Implements IJsonModel(Of BatchVmConfiguration), IPersistableModel(Of BatchVmConfiguration)

Inheritance

Object

BatchVmConfiguration

Implements

IJsonModel<BatchVmConfiguration> IPersistableModel<BatchVmConfiguration> IPersistableModel<T>

Constructors

BatchVmConfiguration(BatchImageReference, String)

Initializes a new instance of BatchVmConfiguration.

Properties

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.
DataDisks	This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.
DiskEncryptionTargets	On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.
EphemeralOSDiskPlacement	This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.
Extensions	If specified, the extensions mentioned in this configuration will be installed on each node.
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.
IsAutomaticUpdateEnabled	If omitted, the default value is true.
LicenseType	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.
NodeAgentSkuId	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.
NodePlacementPolicy	Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.
OSDisk	Contains configuration for ephemeral OSDisk settings.
SecurityProfile	Specifies the security profile settings for the virtual machine or virtual machine scale set.
ServiceArtifactReferenceId	Gets or sets Id.

Explicit Interface Implementations

IJsonModel<BatchVmConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BatchVmConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BatchVmConfiguration>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<BatchVmConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BatchVmConfiguration>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.