PoolSpecification Constructors

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol.Models

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

PoolSpecification()

Initializes a new instance of the PoolSpecification class.

PoolSpecification(String, String, VirtualMachineConfiguration, Nullable<Int32>, TaskSchedulingPolicy, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<TimeSpan>, Nullable<Boolean>, NetworkConfiguration, StartTask, IList<CertificateReference>, IList<ApplicationPackageReference>, IList<UserAccount>, IList<MetadataItem>, IList<MountConfiguration>, Nullable<NodeCommunicationMode>, UpgradePolicy, IDictionary<String,String>)

Initializes a new instance of the PoolSpecification class.

PoolSpecification()

Source:: PoolSpecification.cs

Initializes a new instance of the PoolSpecification class.

public PoolSpecification ();

Public Sub New ()

Applies to

PoolSpecification(String, String, VirtualMachineConfiguration, Nullable<Int32>, TaskSchedulingPolicy, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<TimeSpan>, Nullable<Boolean>, NetworkConfiguration, StartTask, IList<CertificateReference>, IList<ApplicationPackageReference>, IList<UserAccount>, IList<MetadataItem>, IList<MountConfiguration>, Nullable<NodeCommunicationMode>, UpgradePolicy, IDictionary<String,String>)

Source:: PoolSpecification.cs

Initializes a new instance of the PoolSpecification class.

public PoolSpecification (string vmSize, string displayName = default, Microsoft.Azure.Batch.Protocol.Models.VirtualMachineConfiguration virtualMachineConfiguration = default, int? taskSlotsPerNode = default, Microsoft.Azure.Batch.Protocol.Models.TaskSchedulingPolicy taskSchedulingPolicy = default, TimeSpan? resizeTimeout = default, int? targetDedicatedNodes = default, int? targetLowPriorityNodes = default, bool? enableAutoScale = default, string autoScaleFormula = default, TimeSpan? autoScaleEvaluationInterval = default, bool? enableInterNodeCommunication = default, Microsoft.Azure.Batch.Protocol.Models.NetworkConfiguration networkConfiguration = default, Microsoft.Azure.Batch.Protocol.Models.StartTask startTask = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference> certificateReferences = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> applicationPackageReferences = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.UserAccount> userAccounts = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> metadata = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MountConfiguration> mountConfiguration = default, Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode? targetNodeCommunicationMode = default, Microsoft.Azure.Batch.Protocol.Models.UpgradePolicy upgradePolicy = default, System.Collections.Generic.IDictionary<string,string> resourceTags = default);

new Microsoft.Azure.Batch.Protocol.Models.PoolSpecification : string * string * Microsoft.Azure.Batch.Protocol.Models.VirtualMachineConfiguration * Nullable<int> * Microsoft.Azure.Batch.Protocol.Models.TaskSchedulingPolicy * Nullable<TimeSpan> * Nullable<int> * Nullable<int> * Nullable<bool> * string * Nullable<TimeSpan> * Nullable<bool> * Microsoft.Azure.Batch.Protocol.Models.NetworkConfiguration * Microsoft.Azure.Batch.Protocol.Models.StartTask * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.UserAccount> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MountConfiguration> * Nullable<Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode> * Microsoft.Azure.Batch.Protocol.Models.UpgradePolicy * System.Collections.Generic.IDictionary<string, string> -> Microsoft.Azure.Batch.Protocol.Models.PoolSpecification

Public Sub New (vmSize As String, Optional displayName As String = Nothing, Optional virtualMachineConfiguration As VirtualMachineConfiguration = Nothing, Optional taskSlotsPerNode As Nullable(Of Integer) = Nothing, Optional taskSchedulingPolicy As TaskSchedulingPolicy = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional targetDedicatedNodes As Nullable(Of Integer) = Nothing, Optional targetLowPriorityNodes As Nullable(Of Integer) = Nothing, Optional enableAutoScale As Nullable(Of Boolean) = Nothing, Optional autoScaleFormula As String = Nothing, Optional autoScaleEvaluationInterval As Nullable(Of TimeSpan) = Nothing, Optional enableInterNodeCommunication As Nullable(Of Boolean) = Nothing, Optional networkConfiguration As NetworkConfiguration = Nothing, Optional startTask As StartTask = Nothing, Optional certificateReferences As IList(Of CertificateReference) = Nothing, Optional applicationPackageReferences As IList(Of ApplicationPackageReference) = Nothing, Optional userAccounts As IList(Of UserAccount) = Nothing, Optional metadata As IList(Of MetadataItem) = Nothing, Optional mountConfiguration As IList(Of MountConfiguration) = Nothing, Optional targetNodeCommunicationMode As Nullable(Of NodeCommunicationMode) = Nothing, Optional upgradePolicy As UpgradePolicy = Nothing, Optional resourceTags As IDictionary(Of String, String) = Nothing)

Parameters

vmSize: String

The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size.

displayName: String

The display name for the Pool.

virtualMachineConfiguration: VirtualMachineConfiguration

The virtual machine configuration for the Pool.

taskSlotsPerNode: Nullable<Int32>

The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.

taskSchedulingPolicy: TaskSchedulingPolicy

How Tasks are distributed across Compute Nodes in a Pool.

resizeTimeout: Nullable<TimeSpan>

The timeout for allocation of Compute Nodes to the Pool.

targetDedicatedNodes: Nullable<Int32>

The desired number of dedicated Compute Nodes in the Pool.

targetLowPriorityNodes: Nullable<Int32>

The desired number of Spot/Low-priority Compute Nodes in the Pool.

enableAutoScale: Nullable<Boolean>

Whether the Pool size should automatically adjust over time.

autoScaleFormula: String

The formula for the desired number of Compute Nodes in the Pool.

autoScaleEvaluationInterval: Nullable<TimeSpan>

The time interval at which to automatically adjust the Pool size according to the autoscale formula.

enableInterNodeCommunication: Nullable<Boolean>

Whether the Pool permits direct communication between Compute Nodes.

networkConfiguration: NetworkConfiguration

The network configuration for the Pool.

startTask: StartTask

A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted.