ArmBatchModelFactory.BatchVmConfiguration Method

Definition

Namespace:
Azure.ResourceManager.Batch.Models
Assembly:
Azure.ResourceManager.Batch.dll
Package:
Azure.ResourceManager.Batch v1.7.0
Source:
ArmBatchModelFactory.cs
public static Azure.ResourceManager.Batch.Models.BatchVmConfiguration BatchVmConfiguration(Azure.ResourceManager.Batch.Models.BatchImageReference imageReference = default, string nodeAgentSkuId = default, bool? isAutomaticUpdateEnabled = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchVmDataDisk> dataDisks = default, string licenseType = default, Azure.ResourceManager.Batch.Models.BatchVmContainerConfiguration containerConfiguration = default, Azure.ResourceManager.Batch.Models.BatchDiskEncryptionConfiguration diskEncryptionConfiguration = default, Azure.ResourceManager.Batch.Models.BatchNodePlacementPolicyType? nodePlacementPolicy = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchVmExtension> extensions = default, Azure.ResourceManager.Batch.Models.BatchOSDisk osDisk = default, Azure.ResourceManager.Batch.Models.BatchSecurityProfile securityProfile = default, Azure.Core.ResourceIdentifier serviceArtifactReferenceId = default);
static member BatchVmConfiguration : Azure.ResourceManager.Batch.Models.BatchImageReference * string * Nullable<bool> * seq<Azure.ResourceManager.Batch.Models.BatchVmDataDisk> * string * Azure.ResourceManager.Batch.Models.BatchVmContainerConfiguration * Azure.ResourceManager.Batch.Models.BatchDiskEncryptionConfiguration * Nullable<Azure.ResourceManager.Batch.Models.BatchNodePlacementPolicyType> * seq<Azure.ResourceManager.Batch.Models.BatchVmExtension> * Azure.ResourceManager.Batch.Models.BatchOSDisk * Azure.ResourceManager.Batch.Models.BatchSecurityProfile * Azure.Core.ResourceIdentifier -> Azure.ResourceManager.Batch.Models.BatchVmConfiguration
Public Shared Function BatchVmConfiguration (Optional imageReference As BatchImageReference = Nothing, Optional nodeAgentSkuId As String = Nothing, Optional isAutomaticUpdateEnabled As Nullable(Of Boolean) = Nothing, Optional dataDisks As IEnumerable(Of BatchVmDataDisk) = Nothing, Optional licenseType As String = Nothing, Optional containerConfiguration As BatchVmContainerConfiguration = Nothing, Optional diskEncryptionConfiguration As BatchDiskEncryptionConfiguration = Nothing, Optional nodePlacementPolicy As Nullable(Of BatchNodePlacementPolicyType) = Nothing, Optional extensions As IEnumerable(Of BatchVmExtension) = Nothing, Optional osDisk As BatchOSDisk = Nothing, Optional securityProfile As BatchSecurityProfile = Nothing, Optional serviceArtifactReferenceId As ResourceIdentifier = Nothing) As BatchVmConfiguration

Parameters

imageReference
BatchImageReference

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.

nodeAgentSkuId
String

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.

isAutomaticUpdateEnabled
Nullable<Boolean>

If omitted, the default value is true.

dataDisks
IEnumerable<BatchVmDataDisk>

This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.

licenseType
String

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.

containerConfiguration
BatchVmContainerConfiguration

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.

diskEncryptionConfiguration
BatchDiskEncryptionConfiguration

If specified, encryption is performed on each node in the pool during node provisioning.

nodePlacementPolicy
Nullable<BatchNodePlacementPolicyType>

Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

extensions
IEnumerable<BatchVmExtension>

If specified, the extensions mentioned in this configuration will be installed on each node.

osDisk
BatchOSDisk

Contains configuration for ephemeral OSDisk settings.

securityProfile
BatchSecurityProfile

Specifies the security profile settings for the virtual machine or virtual machine scale set.

serviceArtifactReferenceId
ResourceIdentifier

The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}.

Returns

BatchVmConfiguration

A new BatchVmConfiguration instance for mocking.

Applies to