CloudPool Class

Definition

A Pool in the Azure Batch service.

public class CloudPool
type CloudPool = class
Public Class CloudPool
Inheritance
CloudPool

Constructors

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.

Properties

AllocationState

Gets or sets whether the Pool is resizing.

AllocationStateTransitionTime

Gets or sets the time at which the Pool entered its current allocation state.

ApplicationLicenses

Gets or sets the list of application licenses the Batch service will make available on each Compute Node in the Pool.

ApplicationPackageReferences

Gets or sets the list of Packages to be installed on each Compute Node in the Pool.

AutoScaleEvaluationInterval

Gets or sets the time interval at which to automatically adjust the Pool size according to the autoscale formula.

AutoScaleFormula

Gets or sets a formula for the desired number of Compute Nodes in the Pool.

AutoScaleRun

Gets or sets the results and errors from the last execution of the autoscale formula.

CertificateReferences

Gets or sets the list of Certificates to be installed on each Compute Node in the Pool.

CloudServiceConfiguration

Gets or sets the cloud service configuration for the Pool.

CreationTime

Gets or sets the creation time of the Pool.

CurrentDedicatedNodes

Gets or sets the number of dedicated Compute Nodes currently in the Pool.

CurrentLowPriorityNodes

Gets or sets the number of Spot/Low-priority Compute Nodes currently in the Pool.

CurrentNodeCommunicationMode

Gets the current state of the pool communication mode.

DisplayName

Gets or sets the display name for the Pool.

EnableAutoScale

Gets or sets whether the Pool size should automatically adjust over time.

EnableInterNodeCommunication

Gets or sets whether the Pool permits direct communication between Compute Nodes.

ETag

Gets or sets the ETag of the Pool.

Id

Gets or sets a string that uniquely identifies the Pool within the Account.

Identity

Gets or sets the identity of the Batch pool, if configured.

LastModified

Gets or sets the last modified time of the Pool.

Metadata

Gets or sets a list of name-value pairs associated with the Pool as metadata.

MountConfiguration

Gets or sets a list of file systems to mount on each node in the pool.

NetworkConfiguration

Gets or sets the network configuration for the Pool.

ResizeErrors

Gets or sets a list of errors encountered while performing the last resize on the Pool.

ResizeTimeout

Gets or sets the timeout for allocation of Compute Nodes to the Pool.

ResourceTags

Gets or sets the user-specified tags associated with the pool.

StartTask

Gets or sets a Task specified to run on each Compute Node as it joins the Pool.

State

Gets or sets the current state of the Pool.

StateTransitionTime

Gets or sets the time at which the Pool entered its current state.

Stats

Gets or sets utilization and resource usage statistics for the entire lifetime of the Pool.

TargetDedicatedNodes

Gets or sets the desired number of dedicated Compute Nodes in the Pool.

TargetLowPriorityNodes

Gets or sets the desired number of Spot/Low-priority Compute Nodes in the Pool.

TargetNodeCommunicationMode

Gets or sets the desired node communication mode for the pool.

TaskSchedulingPolicy

Gets or sets how Tasks are distributed across Compute Nodes in a Pool.

TaskSlotsPerNode

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

UpgradePolicy

Gets or sets the upgrade policy for the Pool.

Url

Gets or sets the URL of the Pool.

UserAccounts

Gets or sets the list of user Accounts to be created on each Compute Node in the Pool.

VirtualMachineConfiguration

Gets or sets the virtual machine configuration for the Pool.

VmSize

Gets or sets the size of virtual machines in the Pool. All virtual machines in a Pool are the same size.

Applies to