Share via


CloudPool Constructors

Definition

Overloads

CloudPool()

Initializes a new instance of the CloudPool class.

CloudPool(String, String, String, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<PoolState>, Nullable<DateTime>, Nullable<AllocationState>, Nullable<DateTime>, String, CloudServiceConfiguration, VirtualMachineConfiguration, Nullable<TimeSpan>, IList<ResizeError>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<TimeSpan>, AutoScaleRun, Nullable<Boolean>, NetworkConfiguration, StartTask, IList<CertificateReference>, IList<ApplicationPackageReference>, IList<String>, Nullable<Int32>, TaskSchedulingPolicy, IList<UserAccount>, IList<MetadataItem>, PoolStatistics, IList<MountConfiguration>, BatchPoolIdentity, Nullable<NodeCommunicationMode>, Nullable<NodeCommunicationMode>, UpgradePolicy, IDictionary<String,String>)

Initializes a new instance of the CloudPool class.

CloudPool()

Source:
CloudPool.cs

Initializes a new instance of the CloudPool class.

public CloudPool ();
Public Sub New ()

Applies to

CloudPool(String, String, String, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<PoolState>, Nullable<DateTime>, Nullable<AllocationState>, Nullable<DateTime>, String, CloudServiceConfiguration, VirtualMachineConfiguration, Nullable<TimeSpan>, IList<ResizeError>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, Nullable<TimeSpan>, AutoScaleRun, Nullable<Boolean>, NetworkConfiguration, StartTask, IList<CertificateReference>, IList<ApplicationPackageReference>, IList<String>, Nullable<Int32>, TaskSchedulingPolicy, IList<UserAccount>, IList<MetadataItem>, PoolStatistics, IList<MountConfiguration>, BatchPoolIdentity, Nullable<NodeCommunicationMode>, Nullable<NodeCommunicationMode>, UpgradePolicy, IDictionary<String,String>)

Source:
CloudPool.cs

Initializes a new instance of the CloudPool class.

public CloudPool (string id = default, string displayName = default, string url = default, string eTag = default, DateTime? lastModified = default, DateTime? creationTime = default, Microsoft.Azure.Batch.Protocol.Models.PoolState? state = default, DateTime? stateTransitionTime = default, Microsoft.Azure.Batch.Protocol.Models.AllocationState? allocationState = default, DateTime? allocationStateTransitionTime = default, string vmSize = default, Microsoft.Azure.Batch.Protocol.Models.CloudServiceConfiguration cloudServiceConfiguration = default, Microsoft.Azure.Batch.Protocol.Models.VirtualMachineConfiguration virtualMachineConfiguration = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ResizeError> resizeErrors = default, int? currentDedicatedNodes = default, int? currentLowPriorityNodes = default, int? targetDedicatedNodes = default, int? targetLowPriorityNodes = default, bool? enableAutoScale = default, string autoScaleFormula = default, TimeSpan? autoScaleEvaluationInterval = default, Microsoft.Azure.Batch.Protocol.Models.AutoScaleRun autoScaleRun = 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<string> applicationLicenses = default, int? taskSlotsPerNode = default, Microsoft.Azure.Batch.Protocol.Models.TaskSchedulingPolicy taskSchedulingPolicy = 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, Microsoft.Azure.Batch.Protocol.Models.PoolStatistics stats = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MountConfiguration> mountConfiguration = default, Microsoft.Azure.Batch.Protocol.Models.BatchPoolIdentity identity = default, Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode? targetNodeCommunicationMode = default, Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode? currentNodeCommunicationMode = default, Microsoft.Azure.Batch.Protocol.Models.UpgradePolicy upgradePolicy = default, System.Collections.Generic.IDictionary<string,string> resourceTags = default);
new Microsoft.Azure.Batch.Protocol.Models.CloudPool : string * string * string * string * Nullable<DateTime> * Nullable<DateTime> * Nullable<Microsoft.Azure.Batch.Protocol.Models.PoolState> * Nullable<DateTime> * Nullable<Microsoft.Azure.Batch.Protocol.Models.AllocationState> * Nullable<DateTime> * string * Microsoft.Azure.Batch.Protocol.Models.CloudServiceConfiguration * Microsoft.Azure.Batch.Protocol.Models.VirtualMachineConfiguration * Nullable<TimeSpan> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ResizeError> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * string * Nullable<TimeSpan> * Microsoft.Azure.Batch.Protocol.Models.AutoScaleRun * 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<string> * Nullable<int> * Microsoft.Azure.Batch.Protocol.Models.TaskSchedulingPolicy * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.UserAccount> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> * Microsoft.Azure.Batch.Protocol.Models.PoolStatistics * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MountConfiguration> * Microsoft.Azure.Batch.Protocol.Models.BatchPoolIdentity * Nullable<Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode> * Nullable<Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode> * Microsoft.Azure.Batch.Protocol.Models.UpgradePolicy * System.Collections.Generic.IDictionary<string, string> -> Microsoft.Azure.Batch.Protocol.Models.CloudPool
Public Sub New (Optional id As String = Nothing, Optional displayName As String = Nothing, Optional url As String = Nothing, Optional eTag As String = Nothing, Optional lastModified As Nullable(Of DateTime) = Nothing, Optional creationTime As Nullable(Of DateTime) = Nothing, Optional state As Nullable(Of PoolState) = Nothing, Optional stateTransitionTime As Nullable(Of DateTime) = Nothing, Optional allocationState As Nullable(Of AllocationState) = Nothing, Optional allocationStateTransitionTime As Nullable(Of DateTime) = Nothing, Optional vmSize As String = Nothing, Optional cloudServiceConfiguration As CloudServiceConfiguration = Nothing, Optional virtualMachineConfiguration As VirtualMachineConfiguration = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional resizeErrors As IList(Of ResizeError) = Nothing, Optional currentDedicatedNodes As Nullable(Of Integer) = Nothing, Optional currentLowPriorityNodes As Nullable(Of Integer) = 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 autoScaleRun As AutoScaleRun = 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 applicationLicenses As IList(Of String) = Nothing, Optional taskSlotsPerNode As Nullable(Of Integer) = Nothing, Optional taskSchedulingPolicy As TaskSchedulingPolicy = Nothing, Optional userAccounts As IList(Of UserAccount) = Nothing, Optional metadata As IList(Of MetadataItem) = Nothing, Optional stats As PoolStatistics = Nothing, Optional mountConfiguration As IList(Of MountConfiguration) = Nothing, Optional identity As BatchPoolIdentity = Nothing, Optional targetNodeCommunicationMode As Nullable(Of NodeCommunicationMode) = Nothing, Optional currentNodeCommunicationMode As Nullable(Of NodeCommunicationMode) = Nothing, Optional upgradePolicy As UpgradePolicy = Nothing, Optional resourceTags As IDictionary(Of String, String) = Nothing)

Parameters

id
String

A string that uniquely identifies the Pool within the Account.

displayName
String

The display name for the Pool.

url
String

The URL of the Pool.

eTag
String

The ETag of the Pool.

lastModified
Nullable<DateTime>

The last modified time of the Pool.

creationTime
Nullable<DateTime>

The creation time of the Pool.

state
Nullable<PoolState>

The current state of the Pool.

stateTransitionTime
Nullable<DateTime>

The time at which the Pool entered its current state.

allocationState
Nullable<AllocationState>

Whether the Pool is resizing.

allocationStateTransitionTime
Nullable<DateTime>

The time at which the Pool entered its current allocation state.

vmSize
String

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

cloudServiceConfiguration
CloudServiceConfiguration

The cloud service configuration for the Pool.

virtualMachineConfiguration
VirtualMachineConfiguration

The virtual machine configuration for the Pool.

resizeTimeout
Nullable<TimeSpan>

The timeout for allocation of Compute Nodes to the Pool.

resizeErrors
IList<ResizeError>

A list of errors encountered while performing the last resize on the Pool.

currentDedicatedNodes
Nullable<Int32>

The number of dedicated Compute Nodes currently in the Pool.

currentLowPriorityNodes
Nullable<Int32>

The number of Spot/Low-priority Compute Nodes currently in 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

A 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.

autoScaleRun
AutoScaleRun

The results and errors from the last execution of 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 specified to run on each Compute Node as it joins the Pool.

certificateReferences
IList<CertificateReference>

The list of Certificates to be installed on each Compute Node in the Pool.

applicationPackageReferences
IList<ApplicationPackageReference>

The list of Packages to be installed on each Compute Node in the Pool.

applicationLicenses
IList<String>

The list of application licenses the Batch service will make available on each Compute Node in 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.

userAccounts
IList<UserAccount>

The list of user Accounts to be created on each Compute Node in the Pool.

metadata
IList<MetadataItem>

A list of name-value pairs associated with the Pool as metadata.

stats
PoolStatistics

Utilization and resource usage statistics for the entire lifetime of the Pool.

mountConfiguration
IList<MountConfiguration>

A list of file systems to mount on each node in the pool.

identity
BatchPoolIdentity

The identity of the Batch pool, if configured.

targetNodeCommunicationMode
Nullable<NodeCommunicationMode>

The desired node communication mode for the pool.

currentNodeCommunicationMode
Nullable<NodeCommunicationMode>

The current state of the pool communication mode.

upgradePolicy
UpgradePolicy

The upgrade policy for the Pool.

resourceTags
IDictionary<String,String>

The user-specified tags associated with the pool.

Applies to