BatchPool Class

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Source:

BatchPool.cs

A Pool in the Azure Batch service.

public class BatchPool : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchPool>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchPool>

type BatchPool = class
    interface IJsonModel<BatchPool>
    interface IPersistableModel<BatchPool>

Public Class BatchPool
Implements IJsonModel(Of BatchPool), IPersistableModel(Of BatchPool)

Inheritance

Object

BatchPool

Implements

IJsonModel<BatchPool> IPersistableModel<BatchPool> IPersistableModel<T>

Properties

AllocationState	Whether the Pool is resizing.
AllocationStateTransitionTime	The time at which the Pool entered its current allocation state.
ApplicationPackageReferences	The list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool.
AutoScaleEvaluationInterval	The time interval at which to automatically adjust the Pool size according to the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
AutoScaleFormula	A formula for the desired number of Compute Nodes in the Pool. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
AutoScaleRun	The results and errors from the last execution of the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
CreationTime	The creation time of the Pool.
CurrentDedicatedNodes	The number of dedicated Compute Nodes currently in the Pool.
CurrentLowPriorityNodes	The number of Spot/Low-priority Compute Nodes currently in the Pool. Spot/Low-priority Compute Nodes which have been preempted are included in this count.
CurrentNodeCommunicationMode	The current state of the pool communication mode.
DisplayName	The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
EnableAutoScale	Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false.
EnableInterNodeCommunication	Whether the Pool permits direct communication between Compute Nodes. This imposes restrictions on which Compute Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute Nodes to be allocated in the Pool.
ETag	The ETag of the Pool. This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime.
Id	A string that uniquely identifies the Pool within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).
Identity	The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
LastModified	The last modified time of the Pool. This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state.
Metadata	A list of name-value pairs associated with the Pool as metadata.
MountConfiguration	A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
NetworkConfiguration	The network configuration for the Pool.
ResizeErrors	A list of errors encountered while performing the last resize on the Pool. This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady.
ResizeTimeout	The timeout for allocation of Compute Nodes to the Pool. This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes.
ResourceTags	The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.
StartTask	A Task specified to run on each Compute Node as it joins the Pool.
State	The current state of the Pool.
StateTransitionTime	The time at which the Pool entered its current state.
Stats	Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
TargetDedicatedNodes	The desired number of dedicated Compute Nodes in the Pool.
TargetLowPriorityNodes	The desired number of Spot/Low-priority Compute Nodes in the Pool.
TargetNodeCommunicationMode	The desired node communication mode for the pool. If omitted, the default value is Default.
TaskSchedulingPolicy	How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.
TaskSlotsPerNode	The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.
UpgradePolicy	The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling.
Url	The URL of the Pool.
UserAccounts	The list of user Accounts to be created on each Compute Node in the Pool.
VirtualMachineConfiguration	The virtual machine configuration for the Pool. This property must be specified.
VmSize	The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

Explicit Interface Implementations

IJsonModel<BatchPool>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BatchPool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BatchPool>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<BatchPool>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BatchPool>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.