CloudPool Class

Package:

com.microsoft.azure.batch.protocol.models

Maven Artifact:

com.microsoft.azure:azure-batch:11.1.1

• java.lang.Object
• • com.microsoft.azure.batch.protocol.models.CloudPool

public class CloudPool

A Pool in the Azure Batch service.

Constructor Summary

Constructor	Description
CloudPool()

Method Summary

Modifier and Type	Method and Description
AllocationState	allocationState() Get possible values include: 'steady', 'resizing', 'stopping'.
org.joda.time.DateTime	allocationStateTransitionTime() Get the allocationStateTransitionTime value.
List<String>	applicationLicenses() Get the list of application licenses must be a subset of available Batch service application licenses.
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.
org.joda.time.Period	autoScaleEvaluationInterval() Get this property is set only if the Pool automatically scales, i.e.
String	autoScaleFormula() Get this property is set only if the Pool automatically scales, i.e.
AutoScaleRun	autoScaleRun() Get this property is set only if the Pool automatically scales, i.e.
List<CertificateReference>	certificateReferences() Get for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location.
CloudServiceConfiguration	cloudServiceConfiguration() Get this property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified.
org.joda.time.DateTime	creationTime() Get the creationTime value.
Integer	currentDedicatedNodes() Get the currentDedicatedNodes value.
Integer	currentLowPriorityNodes() Get spot/Low-priority Compute Nodes which have been preempted are included in this count.
NodeCommunicationMode	currentNodeCommunicationMode() Get possible values include: 'default', 'classic', 'simplified'.
String	displayName() Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
String	eTag() Get this is an opaque string.
Boolean	enableAutoScale() Get if false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified.
Boolean	enableInterNodeCommunication() Get this imposes restrictions on which Compute Nodes can be assigned to the Pool.
String	id() Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.
BatchPoolIdentity	identity() Get the list of user identities associated with the Batch pool.
org.joda.time.DateTime	lastModified() Get this is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed.
List<MetadataItem>	metadata() Get the metadata value.
List<MountConfiguration>	mountConfiguration() Get this supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
NetworkConfiguration	networkConfiguration() Get the networkConfiguration value.
List<ResizeError>	resizeErrors() Get this property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady.
org.joda.time.Period	resizeTimeout() Get this is the timeout for the most recent resize operation.
Map<String,String>	resourceTags() Get the user-defined tags to be associated with the Azure Batch Pool.
StartTask	startTask() Get the startTask value.
PoolState	state() Get possible values include: 'active', 'deleting'.
org.joda.time.DateTime	stateTransitionTime() Get the stateTransitionTime value.
PoolStatistics	stats() Get this property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null.
Integer	targetDedicatedNodes() Get the targetDedicatedNodes value.
Integer	targetLowPriorityNodes() Get the targetLowPriorityNodes value.
NodeCommunicationMode	targetNodeCommunicationMode() Get if omitted, the default value is Default.
TaskSchedulingPolicy	taskSchedulingPolicy() Get if not specified, the default is spread.
Integer	taskSlotsPerNode() Get the default value is 1.
UpgradePolicy	upgradePolicy() Get describes an upgrade policy - automatic, manual, or rolling.
String	url() Get the url value.
List<UserAccount>	userAccounts() Get the userAccounts value.
VirtualMachineConfiguration	virtualMachineConfiguration() Get this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
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).
CloudPool	withAllocationState(AllocationState allocationState) Set possible values include: 'steady', 'resizing', 'stopping'.
CloudPool	withAllocationStateTransitionTime(DateTime allocationStateTransitionTime) Set the allocationStateTransitionTime value.
CloudPool	withApplicationLicenses(List<String> applicationLicenses) Set the list of application licenses must be a subset of available Batch service application licenses.
CloudPool	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.
CloudPool	withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval) Set this property is set only if the Pool automatically scales, i.e.
CloudPool	withAutoScaleFormula(String autoScaleFormula) Set this property is set only if the Pool automatically scales, i.e.
CloudPool	withAutoScaleRun(AutoScaleRun autoScaleRun) Set this property is set only if the Pool automatically scales, i.e.
CloudPool	withCertificateReferences(List<CertificateReference> certificateReferences) Set for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location.
CloudPool	withCloudServiceConfiguration(CloudServiceConfiguration cloudServiceConfiguration) Set this property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified.
CloudPool	withCreationTime(DateTime creationTime) Set the creationTime value.
CloudPool	withCurrentDedicatedNodes(Integer currentDedicatedNodes) Set the currentDedicatedNodes value.
CloudPool	withCurrentLowPriorityNodes(Integer currentLowPriorityNodes) Set spot/Low-priority Compute Nodes which have been preempted are included in this count.
CloudPool	withDisplayName(String displayName) Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
CloudPool	withETag(String eTag) Set this is an opaque string.
CloudPool	withEnableAutoScale(Boolean enableAutoScale) Set if false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified.
CloudPool	withEnableInterNodeCommunication(Boolean enableInterNodeCommunication) Set this imposes restrictions on which Compute Nodes can be assigned to the Pool.
CloudPool	withId(String id) Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.
CloudPool	withIdentity(BatchPoolIdentity identity) Set the list of user identities associated with the Batch pool.
CloudPool	withLastModified(DateTime lastModified) Set this is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed.
CloudPool	withMetadata(List<MetadataItem> metadata) Set the metadata value.
CloudPool	withMountConfiguration(List<MountConfiguration> mountConfiguration) Set this supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
CloudPool	withNetworkConfiguration(NetworkConfiguration networkConfiguration) Set the networkConfiguration value.
CloudPool	withResizeErrors(List<ResizeError> resizeErrors) Set this property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady.
CloudPool	withResizeTimeout(Period resizeTimeout) Set this is the timeout for the most recent resize operation.
CloudPool	withResourceTags(Map<String,String> resourceTags) Set the user-defined tags to be associated with the Azure Batch Pool.
CloudPool	withStartTask(StartTask startTask) Set the startTask value.
CloudPool	withState(PoolState state) Set possible values include: 'active', 'deleting'.
CloudPool	withStateTransitionTime(DateTime stateTransitionTime) Set the stateTransitionTime value.
CloudPool	withStats(PoolStatistics stats) Set this property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null.
CloudPool	withTargetDedicatedNodes(Integer targetDedicatedNodes) Set the targetDedicatedNodes value.
CloudPool	withTargetLowPriorityNodes(Integer targetLowPriorityNodes) Set the targetLowPriorityNodes value.
CloudPool	withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode) Set if omitted, the default value is Default.
CloudPool	withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy) Set if not specified, the default is spread.
CloudPool	withTaskSlotsPerNode(Integer taskSlotsPerNode) Set the default value is 1.
CloudPool	withUpgradePolicy(UpgradePolicy upgradePolicy) Set describes an upgrade policy - automatic, manual, or rolling.
CloudPool	withUrl(String url) Set the url value.
CloudPool	withUserAccounts(List<UserAccount> userAccounts) Set the userAccounts value.
CloudPool	withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration) Set this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
CloudPool	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).

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CloudPool

public CloudPool()

Method Details

allocationState

public AllocationState allocationState()

Get possible values include: 'steady', 'resizing', 'stopping'.

Returns:

the allocationState value

allocationStateTransitionTime

public DateTime allocationStateTransitionTime()

Get the allocationStateTransitionTime value.

Returns:

the allocationStateTransitionTime value

applicationLicenses

public List applicationLicenses()

Get the list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail.

Returns:

the applicationLicenses value

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. There is a maximum of 10 Package references on any given Pool.

Returns:

the applicationPackageReferences value

autoScaleEvaluationInterval

public Period autoScaleEvaluationInterval()

Get this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

Returns:

the autoScaleEvaluationInterval value

autoScaleFormula

public String autoScaleFormula()

Get this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

Returns:

the autoScaleFormula value

autoScaleRun

public AutoScaleRun autoScaleRun()

Get this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

Returns:

the autoScaleRun value

certificateReferences

public List certificateReferences()

Get 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://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Returns:

the certificateReferences value

cloudServiceConfiguration

public CloudServiceConfiguration cloudServiceConfiguration()

Get this property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'.

Returns:

the cloudServiceConfiguration value

creationTime

public DateTime creationTime()

Get the creationTime value.

Returns:

the creationTime value

currentDedicatedNodes

public Integer currentDedicatedNodes()

Get the currentDedicatedNodes value.

Returns:

the currentDedicatedNodes value

currentLowPriorityNodes

public Integer currentLowPriorityNodes()

Get spot/Low-priority Compute Nodes which have been preempted are included in this count.

Returns:

the currentLowPriorityNodes value

currentNodeCommunicationMode

public NodeCommunicationMode currentNodeCommunicationMode()

Get possible values include: 'default', 'classic', 'simplified'.

Returns:

the currentNodeCommunicationMode 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.

Returns:

the displayName value

eTag

public String eTag()

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

Returns:

the eTag value

enableAutoScale

public Boolean enableAutoScale()

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

Returns:

the enableAutoScale value

enableInterNodeCommunication

public Boolean enableInterNodeCommunication()

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

Returns:

the enableInterNodeCommunication value

id

public String id()

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

Returns:

the id value

identity

public BatchPoolIdentity identity()

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

Returns:

the identity value

lastModified

public DateTime lastModified()

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

Returns:

the lastModified value

metadata

public List metadata()

Get the metadata value.

Returns:

the metadata value

mountConfiguration

public List mountConfiguration()

Get this supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

Returns:

the mountConfiguration value

networkConfiguration

public NetworkConfiguration networkConfiguration()

Get the networkConfiguration value.

Returns:

the networkConfiguration value

resizeErrors

public List resizeErrors()

Get this property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady.

Returns:

the resizeErrors value

resizeTimeout

public Period resizeTimeout()

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

Returns:

the resizeTimeout 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'.

Returns:

the resourceTags value

startTask

public StartTask startTask()

Get the startTask value.

Returns:

the startTask value

state

public PoolState state()

Get possible values include: 'active', 'deleting'.

Returns:

the state value

stateTransitionTime

public DateTime stateTransitionTime()

Get the stateTransitionTime value.

Returns:

the stateTransitionTime value

stats

public PoolStatistics stats()

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

Returns:

the stats value

targetDedicatedNodes

public Integer targetDedicatedNodes()

Get the targetDedicatedNodes value.

Returns:

the targetDedicatedNodes value

targetLowPriorityNodes

public Integer targetLowPriorityNodes()

Get the targetLowPriorityNodes value.

Returns:

the targetLowPriorityNodes value

targetNodeCommunicationMode

public NodeCommunicationMode targetNodeCommunicationMode()

Get if omitted, the default value is Default. Possible values include: 'default', 'classic', 'simplified'.

Returns:

the targetNodeCommunicationMode value

taskSchedulingPolicy

public TaskSchedulingPolicy taskSchedulingPolicy()

Get if not specified, the default is spread.

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.

Returns:

the taskSlotsPerNode value

upgradePolicy

public UpgradePolicy upgradePolicy()

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

Returns:

the upgradePolicy value

url

public String url()

Get the url value.

Returns:

the url value

userAccounts

public List userAccounts()

Get the userAccounts value.

Returns:

the userAccounts value

virtualMachineConfiguration

public VirtualMachineConfiguration virtualMachineConfiguration()

Get this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

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

Returns:

the vmSize value

withAllocationState

public CloudPool withAllocationState(AllocationState allocationState)

Set possible values include: 'steady', 'resizing', 'stopping'.

Parameters:

allocationState - the allocationState value to set

Returns:

the CloudPool object itself.

withAllocationStateTransitionTime

public CloudPool withAllocationStateTransitionTime(DateTime allocationStateTransitionTime)

Set the allocationStateTransitionTime value.

Parameters:

allocationStateTransitionTime - the allocationStateTransitionTime value to set

Returns:

the CloudPool object itself.

withApplicationLicenses

public CloudPool withApplicationLicenses(List applicationLicenses)

Set the list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail.

Parameters:

applicationLicenses - the applicationLicenses value to set

Returns:

the CloudPool object itself.

withApplicationPackageReferences

public CloudPool 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. There is a maximum of 10 Package references on any given Pool.

Parameters:

applicationPackageReferences - the applicationPackageReferences value to set

Returns:

the CloudPool object itself.

withAutoScaleEvaluationInterval

public CloudPool withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)

Set this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

Parameters:

autoScaleEvaluationInterval - the autoScaleEvaluationInterval value to set

Returns:

the CloudPool object itself.

withAutoScaleFormula

public CloudPool withAutoScaleFormula(String autoScaleFormula)

Set this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

Parameters:

autoScaleFormula - the autoScaleFormula value to set

Returns:

the CloudPool object itself.

withAutoScaleRun

public CloudPool withAutoScaleRun(AutoScaleRun autoScaleRun)

Set this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

Parameters:

autoScaleRun - the autoScaleRun value to set

Returns:

the CloudPool object itself.

withCertificateReferences

public CloudPool withCertificateReferences(List certificateReferences)

Set 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://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

certificateReferences - the certificateReferences value to set

Returns:

the CloudPool object itself.

withCloudServiceConfiguration

public CloudPool withCloudServiceConfiguration(CloudServiceConfiguration cloudServiceConfiguration)

Set this property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'.

Parameters:

cloudServiceConfiguration - the cloudServiceConfiguration value to set

Returns:

the CloudPool object itself.

withCreationTime

public CloudPool withCreationTime(DateTime creationTime)

Set the creationTime value.

Parameters:

creationTime - the creationTime value to set

Returns:

the CloudPool object itself.

withCurrentDedicatedNodes

public CloudPool withCurrentDedicatedNodes(Integer currentDedicatedNodes)

Set the currentDedicatedNodes value.

Parameters:

currentDedicatedNodes - the currentDedicatedNodes value to set

Returns:

the CloudPool object itself.

withCurrentLowPriorityNodes

public CloudPool withCurrentLowPriorityNodes(Integer currentLowPriorityNodes)

Set spot/Low-priority Compute Nodes which have been preempted are included in this count.

Parameters:

currentLowPriorityNodes - the currentLowPriorityNodes value to set

Returns:

the CloudPool object itself.

withDisplayName

public CloudPool withDisplayName(String displayName)

Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Parameters:

displayName - the displayName value to set

Returns:

the CloudPool object itself.

withETag

public CloudPool withETag(String eTag)

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

Parameters:

eTag - the eTag value to set

Returns:

the CloudPool object itself.

withEnableAutoScale

public CloudPool withEnableAutoScale(Boolean enableAutoScale)

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

Parameters:

enableAutoScale - the enableAutoScale value to set

Returns:

the CloudPool object itself.

withEnableInterNodeCommunication

public CloudPool withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)

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

Parameters:

enableInterNodeCommunication - the enableInterNodeCommunication value to set

Returns:

the CloudPool object itself.

withId

public CloudPool withId(String id)

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

Parameters:

id - the id value to set

Returns:

the CloudPool object itself.

withIdentity

public CloudPool withIdentity(BatchPoolIdentity identity)

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

Parameters:

identity - the identity value to set

Returns:

the CloudPool object itself.

withLastModified

public CloudPool withLastModified(DateTime lastModified)

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

Parameters:

lastModified - the lastModified value to set

Returns:

the CloudPool object itself.

withMetadata

public CloudPool withMetadata(List metadata)

Set the metadata value.

Parameters:

metadata - the metadata value to set

Returns:

the CloudPool object itself.

withMountConfiguration

public CloudPool withMountConfiguration(List mountConfiguration)

Set this supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

Parameters:

mountConfiguration - the mountConfiguration value to set

Returns:

the CloudPool object itself.

withNetworkConfiguration

public CloudPool withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Set the networkConfiguration value.

Parameters:

networkConfiguration - the networkConfiguration value to set

Returns:

the CloudPool object itself.

withResizeErrors

public CloudPool withResizeErrors(List resizeErrors)

Set this property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady.

Parameters:

resizeErrors - the resizeErrors value to set

Returns:

the CloudPool object itself.

withResizeTimeout

public CloudPool withResizeTimeout(Period resizeTimeout)

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

Parameters:

resizeTimeout - the resizeTimeout value to set

Returns:

the CloudPool object itself.

withResourceTags

public CloudPool 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'.

Parameters:

resourceTags - the resourceTags value to set

Returns:

the CloudPool object itself.

withStartTask

public CloudPool withStartTask(StartTask startTask)

Set the startTask value.

Parameters:

startTask - the startTask value to set

Returns:

the CloudPool object itself.

withState

public CloudPool withState(PoolState state)

Set possible values include: 'active', 'deleting'.

Parameters:

state - the state value to set

Returns:

the CloudPool object itself.

withStateTransitionTime

public CloudPool withStateTransitionTime(DateTime stateTransitionTime)

Set the stateTransitionTime value.

Parameters:

stateTransitionTime - the stateTransitionTime value to set

Returns:

the CloudPool object itself.

withStats

public CloudPool withStats(PoolStatistics stats)

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

Parameters:

stats - the stats value to set

Returns:

the CloudPool object itself.

withTargetDedicatedNodes

public CloudPool withTargetDedicatedNodes(Integer targetDedicatedNodes)

Set the targetDedicatedNodes value.

Parameters:

targetDedicatedNodes - the targetDedicatedNodes value to set

Returns:

the CloudPool object itself.

withTargetLowPriorityNodes

public CloudPool withTargetLowPriorityNodes(Integer targetLowPriorityNodes)

Set the targetLowPriorityNodes value.

Parameters:

targetLowPriorityNodes - the targetLowPriorityNodes value to set

Returns:

the CloudPool object itself.

withTargetNodeCommunicationMode

public CloudPool withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)

Set if omitted, the default value is Default. Possible values include: 'default', 'classic', 'simplified'.

Parameters:

targetNodeCommunicationMode - the targetNodeCommunicationMode value to set

Returns:

the CloudPool object itself.

withTaskSchedulingPolicy

public CloudPool withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Set if not specified, the default is spread.

Parameters:

taskSchedulingPolicy - the taskSchedulingPolicy value to set

Returns:

the CloudPool object itself.

withTaskSlotsPerNode

public CloudPool 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.

Parameters:

taskSlotsPerNode - the taskSlotsPerNode value to set

Returns:

the CloudPool object itself.

withUpgradePolicy

public CloudPool withUpgradePolicy(UpgradePolicy upgradePolicy)

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

Parameters:

upgradePolicy - the upgradePolicy value to set

Returns:

the CloudPool object itself.

withUrl

public CloudPool withUrl(String url)

Set the url value.

Parameters:

url - the url value to set

Returns:

the CloudPool object itself.

withUserAccounts

public CloudPool withUserAccounts(List userAccounts)

Set the userAccounts value.

Parameters:

userAccounts - the userAccounts value to set

Returns:

the CloudPool object itself.

withVirtualMachineConfiguration

public CloudPool withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)

Set this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

Parameters:

virtualMachineConfiguration - the virtualMachineConfiguration value to set

Returns:

the CloudPool object itself.

withVmSize

public CloudPool 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).

Parameters:

vmSize - the vmSize value to set

Returns:

the CloudPool object itself.