PoolPatchParameter Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.PoolPatchParameter

public class PoolPatchParameter

The set of changes to be made to a Pool.

Constructor Summary

Constructor Description
PoolPatchParameter()

Method Summary

Modifier and Type Method and Description
List<ApplicationPackageReference> applicationPackageReferences()

Get 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.
List<CertificateReference> certificateReferences()

Get if this element is present, it replaces any existing Certificate references configured on the Pool.
String displayName()

Get 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.
Boolean enableInterNodeCommunication()

Get enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool.
List<MetadataItem> metadata()

Get if this element is present, it replaces any existing metadata configured on the Pool.
List<MountConfiguration> mountConfiguration()

Get mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.

This field can be updated only when the pool is empty.
NetworkConfiguration networkConfiguration()

Get this field can be updated only when the pool is empty.
Map<String,String> resourceTags()

Get the user-defined tags to be associated with the Azure Batch Pool.
StartTask startTask()

Get if this element is present, it overwrites any existing StartTask.
NodeCommunicationMode targetNodeCommunicationMode()

Get if this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool.
TaskSchedulingPolicy taskSchedulingPolicy()

Get if not specified, the default is spread.

This field can be updated only when the pool is empty.
Integer taskSlotsPerNode()

Get the default value is 1.
UpgradePolicy upgradePolicy()

Get describes an upgrade policy - automatic, manual, or rolling.

This field can be updated only when the pool is empty.
List<UserAccount> userAccounts()

Get this field can be updated only when the pool is empty.
VirtualMachineConfiguration virtualMachineConfiguration()

Get this property must be specified.

This field can be updated only when the pool is empty.
String vmSize()

Get 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).

This field can be updated only when the pool is empty.
PoolPatchParameter withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)

Set 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.
PoolPatchParameter withCertificateReferences(List<CertificateReference> certificateReferences)

Set if this element is present, it replaces any existing Certificate references configured on the Pool.
PoolPatchParameter withDisplayName(String displayName)

Set 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.
PoolPatchParameter withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)

Set enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool.
PoolPatchParameter withMetadata(List<MetadataItem> metadata)

Set if this element is present, it replaces any existing metadata configured on the Pool.
PoolPatchParameter withMountConfiguration(List<MountConfiguration> mountConfiguration)

Set mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.

This field can be updated only when the pool is empty.
PoolPatchParameter withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Set this field can be updated only when the pool is empty.
PoolPatchParameter withResourceTags(Map<String,String> resourceTags)

Set the user-defined tags to be associated with the Azure Batch Pool.
PoolPatchParameter withStartTask(StartTask startTask)

Set if this element is present, it overwrites any existing StartTask.
PoolPatchParameter withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)

Set if this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool.
PoolPatchParameter withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Set if not specified, the default is spread.

This field can be updated only when the pool is empty.
PoolPatchParameter withTaskSlotsPerNode(Integer taskSlotsPerNode)

Set the default value is 1.
PoolPatchParameter withUpgradePolicy(UpgradePolicy upgradePolicy)

Set describes an upgrade policy - automatic, manual, or rolling.

This field can be updated only when the pool is empty.
PoolPatchParameter withUserAccounts(List<UserAccount> userAccounts)

Set this field can be updated only when the pool is empty.
PoolPatchParameter withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)

Set this property must be specified.

This field can be updated only when the pool is empty.
PoolPatchParameter withVmSize(String vmSize)

Set 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).

This field can be updated only when the pool is empty.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PoolPatchParameter

public PoolPatchParameter()

Method Details

applicationPackageReferences

public List applicationPackageReferences()

Get 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.

Returns:

the applicationPackageReferences value

certificateReferences

public List certificateReferences()

Get if this element is present, it replaces any existing Certificate references configured on the Pool. If omitted, any existing Certificate references are left unchanged. For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory. Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://video2.skills-academy.com/azure/batch/batch-certificate-migration-guide) instead.

Returns:

the certificateReferences value

displayName

public String displayName()

Get 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.

Returns:

the displayName value

enableInterNodeCommunication

public Boolean enableInterNodeCommunication()

Get 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.

This field can be updated only when the pool is empty.

Returns:

the enableInterNodeCommunication value

metadata

public List metadata()

Get 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.

Returns:

the metadata value

mountConfiguration

public List mountConfiguration()

Get mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.

This field can be updated only when the pool is empty.

Returns:

the mountConfiguration value

networkConfiguration

public NetworkConfiguration networkConfiguration()

Get this field can be updated only when the pool is empty.

Returns:

the networkConfiguration value

resourceTags

public Map resourceTags()

Get 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'.

This field can be updated only when the pool is empty.

Returns:

the resourceTags value

startTask

public StartTask startTask()

Get if this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.

Returns:

the startTask value

targetNodeCommunicationMode

public NodeCommunicationMode targetNodeCommunicationMode()

Get if this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged. Possible values include: 'default', 'classic', 'simplified'.

Returns:

the targetNodeCommunicationMode value

taskSchedulingPolicy

public TaskSchedulingPolicy taskSchedulingPolicy()

Get if not specified, the default is spread.

This field can be updated only when the pool is empty.

Returns:

the taskSchedulingPolicy value

taskSlotsPerNode

public Integer taskSlotsPerNode()

Get 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.

This field can be updated only when the pool is empty.

Returns:

the taskSlotsPerNode value

upgradePolicy

public UpgradePolicy upgradePolicy()

Get describes an upgrade policy - automatic, manual, or rolling.

This field can be updated only when the pool is empty.

Returns:

the upgradePolicy value

userAccounts

public List userAccounts()

Get this field can be updated only when the pool is empty.

Returns:

the userAccounts value

virtualMachineConfiguration

public VirtualMachineConfiguration virtualMachineConfiguration()

Get this property must be specified.

This field can be updated only when the pool is empty.

Returns:

the virtualMachineConfiguration value

vmSize

public String vmSize()

Get 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).

This field can be updated only when the pool is empty.

Returns:

the vmSize value

withApplicationPackageReferences

public PoolPatchParameter withApplicationPackageReferences(List applicationPackageReferences)

Set 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.

Parameters:

applicationPackageReferences - the applicationPackageReferences value to set

Returns:

the PoolPatchParameter object itself.

withCertificateReferences

public PoolPatchParameter withCertificateReferences(List certificateReferences)

Set if this element is present, it replaces any existing Certificate references configured on the Pool. If omitted, any existing Certificate references are left unchanged. For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory. Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://video2.skills-academy.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

certificateReferences - the certificateReferences value to set

Returns:

the PoolPatchParameter object itself.

withDisplayName

public PoolPatchParameter withDisplayName(String displayName)

Set 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.

Parameters:

displayName - the displayName value to set

Returns:

the PoolPatchParameter object itself.

withEnableInterNodeCommunication

public PoolPatchParameter withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)

Set 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.

This field can be updated only when the pool is empty.

Parameters:

enableInterNodeCommunication - the enableInterNodeCommunication value to set

Returns:

the PoolPatchParameter object itself.

withMetadata

public PoolPatchParameter withMetadata(List metadata)

Set 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.

Parameters:

metadata - the metadata value to set

Returns:

the PoolPatchParameter object itself.

withMountConfiguration

public PoolPatchParameter withMountConfiguration(List mountConfiguration)

Set mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.

This field can be updated only when the pool is empty.

Parameters:

mountConfiguration - the mountConfiguration value to set

Returns:

the PoolPatchParameter object itself.

withNetworkConfiguration

public PoolPatchParameter withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Set this field can be updated only when the pool is empty.

Parameters:

networkConfiguration - the networkConfiguration value to set

Returns:

the PoolPatchParameter object itself.

withResourceTags

public PoolPatchParameter withResourceTags(Map resourceTags)

Set 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'.

This field can be updated only when the pool is empty.

Parameters:

resourceTags - the resourceTags value to set

Returns:

the PoolPatchParameter object itself.

withStartTask

public PoolPatchParameter withStartTask(StartTask startTask)

Set if this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.

Parameters:

startTask - the startTask value to set

Returns:

the PoolPatchParameter object itself.

withTargetNodeCommunicationMode

public PoolPatchParameter withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)

Set if this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged. Possible values include: 'default', 'classic', 'simplified'.

Parameters:

targetNodeCommunicationMode - the targetNodeCommunicationMode value to set

Returns:

the PoolPatchParameter object itself.

withTaskSchedulingPolicy

public PoolPatchParameter withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Set if not specified, the default is spread.

This field can be updated only when the pool is empty.

Parameters:

taskSchedulingPolicy - the taskSchedulingPolicy value to set

Returns:

the PoolPatchParameter object itself.

withTaskSlotsPerNode

public PoolPatchParameter withTaskSlotsPerNode(Integer taskSlotsPerNode)

Set 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.

This field can be updated only when the pool is empty.

Parameters:

taskSlotsPerNode - the taskSlotsPerNode value to set

Returns:

the PoolPatchParameter object itself.

withUpgradePolicy

public PoolPatchParameter withUpgradePolicy(UpgradePolicy upgradePolicy)

Set describes an upgrade policy - automatic, manual, or rolling.

This field can be updated only when the pool is empty.

Parameters:

upgradePolicy - the upgradePolicy value to set

Returns:

the PoolPatchParameter object itself.

withUserAccounts

public PoolPatchParameter withUserAccounts(List userAccounts)

Set this field can be updated only when the pool is empty.

Parameters:

userAccounts - the userAccounts value to set

Returns:

the PoolPatchParameter object itself.

withVirtualMachineConfiguration

public PoolPatchParameter withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)

Set this property must be specified.

This field can be updated only when the pool is empty.

Parameters:

virtualMachineConfiguration - the virtualMachineConfiguration value to set

Returns:

the PoolPatchParameter object itself.

withVmSize

public PoolPatchParameter withVmSize(String vmSize)

Set 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).

This field can be updated only when the pool is empty.

Parameters:

vmSize - the vmSize value to set

Returns:

the PoolPatchParameter object itself.

Applies to