ComputeBatchModelFactory.BatchPool Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initializes a new instance of BatchPool.
public static Azure.Compute.Batch.BatchPool BatchPool(string id = default, string displayName = default, Uri uri = default, Azure.ETag eTag = default, DateTimeOffset lastModified = default, DateTimeOffset creationTime = default, Azure.Compute.Batch.BatchPoolState state = default, DateTimeOffset stateTransitionTime = default, Azure.Compute.Batch.AllocationState? allocationState = default, DateTimeOffset? allocationStateTransitionTime = default, string vmSize = default, Azure.Compute.Batch.VirtualMachineConfiguration virtualMachineConfiguration = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.ResizeError> resizeErrors = default, int currentDedicatedNodes = 0, int currentLowPriorityNodes = 0, int? targetDedicatedNodes = default, int? targetLowPriorityNodes = default, bool? enableAutoScale = default, string autoScaleFormula = default, TimeSpan? autoScaleEvaluationInterval = default, Azure.Compute.Batch.AutoScaleRun autoScaleRun = default, bool? enableInterNodeCommunication = default, Azure.Compute.Batch.NetworkConfiguration networkConfiguration = default, Azure.Compute.Batch.BatchStartTask startTask = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.BatchApplicationPackageReference> applicationPackageReferences = default, int? taskSlotsPerNode = default, Azure.Compute.Batch.BatchTaskSchedulingPolicy taskSchedulingPolicy = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.UserAccount> userAccounts = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.BatchMetadataItem> metadata = default, Azure.Compute.Batch.BatchPoolStatistics poolStatistics = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.MountConfiguration> mountConfiguration = default, Azure.Compute.Batch.BatchPoolIdentity identity = default, Azure.Compute.Batch.UpgradePolicy upgradePolicy = default);static member BatchPool : string * string * Uri * Azure.ETag * DateTimeOffset * DateTimeOffset * Azure.Compute.Batch.BatchPoolState * DateTimeOffset * Nullable<Azure.Compute.Batch.AllocationState> * Nullable<DateTimeOffset> * string * Azure.Compute.Batch.VirtualMachineConfiguration * Nullable<TimeSpan> * seq<Azure.Compute.Batch.ResizeError> * int * int * Nullable<int> * Nullable<int> * Nullable<bool> * string * Nullable<TimeSpan> * Azure.Compute.Batch.AutoScaleRun * Nullable<bool> * Azure.Compute.Batch.NetworkConfiguration * Azure.Compute.Batch.BatchStartTask * seq<Azure.Compute.Batch.BatchApplicationPackageReference> * Nullable<int> * Azure.Compute.Batch.BatchTaskSchedulingPolicy * seq<Azure.Compute.Batch.UserAccount> * seq<Azure.Compute.Batch.BatchMetadataItem> * Azure.Compute.Batch.BatchPoolStatistics * seq<Azure.Compute.Batch.MountConfiguration> * Azure.Compute.Batch.BatchPoolIdentity * Azure.Compute.Batch.UpgradePolicy -> Azure.Compute.Batch.BatchPoolPublic Shared Function BatchPool (Optional id As String = Nothing, Optional displayName As String = Nothing, Optional uri As Uri = Nothing, Optional eTag As ETag = Nothing, Optional lastModified As DateTimeOffset = Nothing, Optional creationTime As DateTimeOffset = Nothing, Optional state As BatchPoolState = Nothing, Optional stateTransitionTime As DateTimeOffset = Nothing, Optional allocationState As Nullable(Of AllocationState) = Nothing, Optional allocationStateTransitionTime As Nullable(Of DateTimeOffset) = Nothing, Optional vmSize As String = Nothing, Optional virtualMachineConfiguration As VirtualMachineConfiguration = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional resizeErrors As IEnumerable(Of ResizeError) = Nothing, Optional currentDedicatedNodes As Integer = 0, Optional currentLowPriorityNodes As Integer = 0, Optional targetDedicatedNodes As Nullable(Of Integer) = Nothing, Optional targetLowPriorityNodes As Nullable(Of Integer) = Nothing, Optional enableAutoScale As Nullable(Of Boolean) = Nothing, Optional autoScaleFormula As String = Nothing, Optional autoScaleEvaluationInterval As Nullable(Of TimeSpan) = Nothing, Optional autoScaleRun As AutoScaleRun = Nothing, Optional enableInterNodeCommunication As Nullable(Of Boolean) = Nothing, Optional networkConfiguration As NetworkConfiguration = Nothing, Optional startTask As BatchStartTask = Nothing, Optional applicationPackageReferences As IEnumerable(Of BatchApplicationPackageReference) = Nothing, Optional taskSlotsPerNode As Nullable(Of Integer) = Nothing, Optional taskSchedulingPolicy As BatchTaskSchedulingPolicy = Nothing, Optional userAccounts As IEnumerable(Of UserAccount) = Nothing, Optional metadata As IEnumerable(Of BatchMetadataItem) = Nothing, Optional poolStatistics As BatchPoolStatistics = Nothing, Optional mountConfiguration As IEnumerable(Of MountConfiguration) = Nothing, Optional identity As BatchPoolIdentity = Nothing, Optional upgradePolicy As UpgradePolicy = Nothing) As BatchPoolParameters
- id
- String
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).
- displayName
- String
The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
- uri
- Uri
The URL of the Pool.
- eTag
- 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.
- lastModified
- DateTimeOffset
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.
- creationTime
- DateTimeOffset
The creation time of the Pool.
- state
- BatchPoolState
The current state of the Pool.
- stateTransitionTime
- DateTimeOffset
The time at which the Pool entered its current state.
- allocationState
- Nullable<AllocationState>
Whether the Pool is resizing.
- allocationStateTransitionTime
- Nullable<DateTimeOffset>
The time at which the Pool entered its current allocation state.
- vmSize
- String
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://dori-uw-1.kuma-moon.com/azure/batch/batch-pool-vm-sizes).
- virtualMachineConfiguration
- VirtualMachineConfiguration
The virtual machine configuration for the Pool. This property must be specified.
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.
- resizeErrors
- IEnumerable<ResizeError>
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.
- currentDedicatedNodes
- Int32
The number of dedicated Compute Nodes currently in the Pool.
- currentLowPriorityNodes
- Int32
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.
The desired number of Spot/Low-priority Compute Nodes in the Pool.
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.
- autoScaleFormula
- String
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.
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.
- autoScaleRun
- 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.
Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.
- networkConfiguration
- NetworkConfiguration
The network configuration for the Pool.
- startTask
- BatchStartTask
A Task specified to run on each Compute Node as it joins the Pool.
- applicationPackageReferences
- IEnumerable<BatchApplicationPackageReference>
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.
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.
- taskSchedulingPolicy
- BatchTaskSchedulingPolicy
How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.
- userAccounts
- IEnumerable<UserAccount>
The list of user Accounts to be created on each Compute Node in the Pool.
- metadata
- IEnumerable<BatchMetadataItem>
A list of name-value pairs associated with the Pool as metadata.
- poolStatistics
- BatchPoolStatistics
Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the BatchPool 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.
- mountConfiguration
- IEnumerable<MountConfiguration>
Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.
- identity
- BatchPoolIdentity
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}'.
- upgradePolicy
- UpgradePolicy
The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling.
Returns
A new BatchPool instance for mocking.
