Share via


Pool Class

Definition

Contains information about a pool.

[Microsoft.Rest.Serialization.JsonTransformation]
public class Pool : Microsoft.Azure.Management.Batch.Models.ProxyResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type Pool = class
    inherit ProxyResource
Public Class Pool
Inherits ProxyResource
Inheritance
Attributes

Constructors

Pool()

Initializes a new instance of the Pool class.

Pool(String, String, String, String, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<PoolProvisioningState>, Nullable<DateTime>, Nullable<AllocationState>, Nullable<DateTime>, String, DeploymentConfiguration, Nullable<Int32>, Nullable<Int32>, ScaleSettings, AutoScaleRun, Nullable<InterNodeCommunicationState>, NetworkConfiguration, Nullable<Int32>, TaskSchedulingPolicy, IList<UserAccount>, IList<MetadataItem>, StartTask, IList<CertificateReference>, IList<ApplicationPackageReference>, IList<String>, ResizeOperationStatus, IList<MountConfiguration>, Nullable<NodeCommunicationMode>, Nullable<NodeCommunicationMode>, BatchPoolIdentity)

Initializes a new instance of the Pool class.

Properties

AllocationState

Gets whether the pool is resizing.

AllocationStateTransitionTime

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

ApplicationPackages

Gets or sets the list of application packages to be installed on each compute node in the pool.

AutoScaleRun

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

Certificates

Gets or sets the list of certificates to be installed on each compute node in the pool.

CreationTime

Gets the creation time of the pool.

CurrentDedicatedNodes

Gets the number of dedicated compute nodes currently in the pool.

CurrentLowPriorityNodes

Gets the number of Spot/low-priority compute nodes currently in the pool.

CurrentNodeCommunicationMode

Gets the current state of the pool communication mode.

DeploymentConfiguration

Gets or sets this property describes how the pool nodes will be deployed - using Cloud Services or Virtual Machines.

DisplayName

Gets or sets the display name for the pool.

Etag

Gets the ETag of the resource, used for concurrency statements.

(Inherited from ProxyResource)
Id

Gets the ID of the resource.

(Inherited from ProxyResource)
Identity

Gets or sets the type of identity used for the Batch Pool.

InterNodeCommunication

Gets or sets whether the pool permits direct communication between nodes.

LastModified

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

Name

Gets the name of the resource.

(Inherited from ProxyResource)
NetworkConfiguration

Gets or sets the network configuration for the pool.

ProvisioningState

Gets the current state of the pool.

ProvisioningStateTransitionTime

Gets the time at which the pool entered its current state.

ResizeOperationStatus

Gets contains details about the current or last completed resize operation.

ScaleSettings

Gets or sets settings which configure the number of nodes in the pool.

StartTask

Gets or sets a task specified to run on each compute node as it joins 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.

Type

Gets the type of the resource.

(Inherited from ProxyResource)
UserAccounts

Gets or sets the list of user accounts to be created on each node in the pool.

VmSize

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

Methods

Validate()

Validate the object.

Applies to