PoolSpecification Class

Definition

The specification for a pool.

public class PoolSpecification
type PoolSpecification = class
    interface ITransportObjectProvider<PoolSpecification>
    interface IPropertyMetadata
    interface IModifiable
    interface IReadOnly
Public Class PoolSpecification
Inheritance
System.Object
PoolSpecification

Constructors

PoolSpecification()

Initializes a new instance of the PoolSpecification class.

Properties

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 a list of application package references to be installed on each compute node in the pool.

AutoScaleEnabled

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

AutoScaleEvaluationInterval

Gets or sets a time interval at which to automatically adjust the pool size according to the AutoScaleFormula.

AutoScaleFormula

Gets or sets a formula for the desired number of compute nodes in the pool.

CertificateReferences

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

CloudServiceConfiguration

Gets or sets the CloudServiceConfiguration for the pool.

DisplayName

Gets or sets the display name for the pool.

InterComputeNodeCommunicationEnabled

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

Metadata

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

NetworkConfiguration

Gets or sets the network configuration of the pool.

ResizeTimeout

Gets or sets the timeout for allocation of compute nodes to the pool.

StartTask

Gets or sets a task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted.

TargetDedicated
Obsolete.

This property is an alias for TargetDedicatedComputeNodes and is supported only for backward compatibility.

TargetDedicatedComputeNodes

Gets or sets the desired number of dedicated compute nodes in the pool.

TargetLowPriorityComputeNodes

Gets or sets the desired number of low-priority compute nodes in the pool.

TaskSchedulingPolicy

Gets or sets how tasks are distributed among compute nodes in the pool.

UserAccounts

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

VirtualMachineConfiguration

Gets or sets the VirtualMachineConfiguration of the pool.

VirtualMachineSize

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

Applies to