CloudPool Class

Definition

A pool in the Azure Batch service.

public class CloudPool : Microsoft.Azure.Batch.IInheritedBehaviors, Microsoft.Azure.Batch.IRefreshable
type CloudPool = class
    interface IRefreshable
    interface IInheritedBehaviors
Public Class CloudPool
Implements IInheritedBehaviors, IRefreshable
Inheritance
CloudPool
Implements

Properties

AllocationState

Gets an AllocationState which indicates what node allocation activity is occurring on the pool.

AllocationStateTransitionTime

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

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 packages to be installed on each compute node in the pool.

AutoScaleEnabled

Gets or sets whether the pool size should automatically adjust according to the AutoScaleFormula.

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.

AutoScaleRun

Gets the results and errors from the last execution of the AutoScaleFormula.

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.

CreationTime

Gets the creation time for the pool.

CurrentDedicated

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

CurrentDedicatedComputeNodes

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

CurrentLowPriorityComputeNodes

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

CustomBehaviors

Gets or sets a list of behaviors that modify or customize requests to the Batch service made via this CloudPool.

DisplayName

Gets or sets the display name of the pool.

ETag

Gets the ETag for the pool.

Id

Gets or sets the id of the pool.

InterComputeNodeCommunicationEnabled

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

LastModified

Gets the last modified time of the pool.

MaxTasksPerComputeNode

Gets or sets the maximum number of tasks that can run concurrently on a single compute node in 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 of the pool.

ResizeErrors

Gets a list of errors encountered while performing the last resize on the CloudPool. Errors are returned only when the Batch service encountered an error while resizing the pool, and when the pool's AllocationState is Steady.

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.

State

Gets the current state of the pool.

StateTransitionTime

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

Statistics

Gets the resource usage statistics for the pool.

TargetDedicated

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.

Url

Gets the URL of 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.

Methods

Commit(IEnumerable<BatchClientBehavior>)

Commits this CloudPool to the Azure Batch service.

CommitAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Commits this CloudPool to the Azure Batch service.

CommitChanges(IEnumerable<BatchClientBehavior>)

Commits all pending changes to this CloudPool to the Azure Batch service.

CommitChangesAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Commits all pending changes to this CloudPool to the Azure Batch service.

Delete(IEnumerable<BatchClientBehavior>)

Deletes this pool.

DeleteAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Deletes this pool.

DisableAutoScale(IEnumerable<BatchClientBehavior>)

Disables automatic scaling on this pool.

DisableAutoScaleAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Disables automatic scaling on this pool.

EnableAutoScale(String, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Enables automatic scaling on this pool.

EnableAutoScaleAsync(String, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)

Enables automatic scaling on this pool.

EvaluateAutoScale(String, IEnumerable<BatchClientBehavior>)

Gets the result of evaluating an automatic scaling formula on this pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.

EvaluateAutoScaleAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets the result of evaluating an automatic scaling formula on this pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.

GetComputeNode(String, DetailLevel, IEnumerable<BatchClientBehavior>)

Gets the specified compute node from this pool.

GetComputeNodeAsync(String, DetailLevel, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets the specified compute node from this pool.

ListComputeNodes(DetailLevel, IEnumerable<BatchClientBehavior>)

Enumerates the ComputeNode of this pool.

Refresh(DetailLevel, IEnumerable<BatchClientBehavior>)

Refreshes the current CloudPool.

RefreshAsync(DetailLevel, IEnumerable<BatchClientBehavior>, CancellationToken)

Refreshes the current CloudPool.

RemoveFromPool(ComputeNode, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute node from this pool.

RemoveFromPool(IEnumerable<ComputeNode>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute nodes from this pool.

RemoveFromPool(IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute nodes from this pool.

RemoveFromPool(String, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute node from this pool.

RemoveFromPoolAsync(ComputeNode, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)

Removes the specified compute node from this pool.

RemoveFromPoolAsync(IEnumerable<ComputeNode>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)

Removes the specified compute nodes from this pool.

RemoveFromPoolAsync(IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)

Removes the specified compute nodes from this pool.

RemoveFromPoolAsync(String, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)

Removes the specified compute node from this pool.

Resize(Nullable<Int32>, Nullable<Int32>, Nullable<TimeSpan>, Nullable<ComputeNodeDeallocationOption>, IEnumerable<BatchClientBehavior>)

Resizes this pool.

ResizeAsync(Nullable<Int32>, Nullable<Int32>, Nullable<TimeSpan>, Nullable<ComputeNodeDeallocationOption>, IEnumerable<BatchClientBehavior>, CancellationToken)

Resizes this pool.

StopResize(IEnumerable<BatchClientBehavior>)

Stops a resize operation on this pool.

StopResizeAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Stops a resize operation on this pool.

Applies to