ComputeBatchModelFactory.BatchPoolUpdateOptions 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.
Parameters for updating an Azure Batch Pool.
public static Azure.Compute.Batch.BatchPoolUpdateOptions BatchPoolUpdateOptions(string displayName = default, string vmSize = default, bool? enableInterNodeCommunication = default, Azure.Compute.Batch.BatchStartTask startTask = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.BatchApplicationPackageReference> applicationPackageReferences = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.BatchMetadataItem> metadata = default, Azure.Compute.Batch.VirtualMachineConfiguration virtualMachineConfiguration = default, int? taskSlotsPerNode = default, Azure.Compute.Batch.BatchTaskSchedulingPolicy taskSchedulingPolicy = default, Azure.Compute.Batch.NetworkConfiguration networkConfiguration = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.UserAccount> userAccounts = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.MountConfiguration> mountConfiguration = default, Azure.Compute.Batch.UpgradePolicy upgradePolicy = default);static member BatchPoolUpdateOptions : string * string * Nullable<bool> * Azure.Compute.Batch.BatchStartTask * seq<Azure.Compute.Batch.BatchApplicationPackageReference> * seq<Azure.Compute.Batch.BatchMetadataItem> * Azure.Compute.Batch.VirtualMachineConfiguration * Nullable<int> * Azure.Compute.Batch.BatchTaskSchedulingPolicy * Azure.Compute.Batch.NetworkConfiguration * seq<Azure.Compute.Batch.UserAccount> * seq<Azure.Compute.Batch.MountConfiguration> * Azure.Compute.Batch.UpgradePolicy -> Azure.Compute.Batch.BatchPoolUpdateOptionsPublic Shared Function BatchPoolUpdateOptions (Optional displayName As String = Nothing, Optional vmSize As String = Nothing, Optional enableInterNodeCommunication As Nullable(Of Boolean) = Nothing, Optional startTask As BatchStartTask = Nothing, Optional applicationPackageReferences As IEnumerable(Of BatchApplicationPackageReference) = Nothing, Optional metadata As IEnumerable(Of BatchMetadataItem) = Nothing, Optional virtualMachineConfiguration As VirtualMachineConfiguration = Nothing, Optional taskSlotsPerNode As Nullable(Of Integer) = Nothing, Optional taskSchedulingPolicy As BatchTaskSchedulingPolicy = Nothing, Optional networkConfiguration As NetworkConfiguration = Nothing, Optional userAccounts As IEnumerable(Of UserAccount) = Nothing, Optional mountConfiguration As IEnumerable(Of MountConfiguration) = Nothing, Optional upgradePolicy As UpgradePolicy = Nothing) As BatchPoolUpdateOptionsParameters
- displayName
- String
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. This field can be updated only when the pool is empty.
- vmSize
- String
The size of virtual machines in the Pool. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).<br /><br />This field can be updated only when the pool is empty.
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.<br /><br />This field can be updated only when the pool is empty.
- startTask
- BatchStartTask
A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.
- applicationPackageReferences
- IEnumerable<BatchApplicationPackageReference>
A 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. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged.
- metadata
- IEnumerable<BatchMetadataItem>
A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged.
- virtualMachineConfiguration
- VirtualMachineConfiguration
The virtual machine configuration for the Pool. This property must be specified.<br /><br />This field can be updated only when the pool is empty.
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.<br /><br />This field can be updated only when the pool is empty.
- taskSchedulingPolicy
- BatchTaskSchedulingPolicy
How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.<br /><br />This field can be updated only when the pool is empty.
- networkConfiguration
- NetworkConfiguration
The network configuration for the Pool. This field can be updated only when the pool is empty.
- userAccounts
- IEnumerable<UserAccount>
The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool is empty.
- 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.<br /><br />This field can be updated only when the pool is empty.
- upgradePolicy
- UpgradePolicy
The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling.<br /><br />This field can be updated only when the pool is empty.
Returns
A new BatchPoolUpdateOptions instance for mocking.
