CloudPool Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. CloudPool
- com.
public class CloudPool
A Pool in the Azure Batch service.
Constructor Summary
Constructor | Description | |
---|---|---|
CloudPool() |
Method Summary
Modifier and Type | Method and Description |
---|---|
Allocation |
allocationState()
Get possible values include: 'steady', 'resizing', 'stopping'. |
org.joda.time.DateTime |
allocationStateTransitionTime()
Get the allocation |
List<Application |
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. |
String |
autoScaleFormula()
Get this property is set only if the Pool automatically scales, i. |
Auto |
autoScaleRun()
Get this property is set only if the Pool automatically scales, i. |
List<Certificate |
certificateReferences()
Get for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. |
org.joda.time.DateTime |
creationTime()
Get the creation |
Integer |
currentDedicatedNodes()
Get the current |
Integer |
currentLowPriorityNodes()
Get spot/Low-priority Compute Nodes which have been preempted are included in this count. |
Node |
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 target |
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. |
Batch |
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 target |
List<Metadata |
metadata()
Get the metadata value. |
List<Mount |
mountConfiguration()
Get this supports Azure Files, NFS, CIFS/SMB, and Blobfuse. |
Network |
networkConfiguration()
Get the network |
List<Resize |
resizeErrors()
Get this property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocation |
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. |
Start |
startTask()
Get the start |
Pool |
state()
Get possible values include: 'active', 'deleting'. |
org.joda.time.DateTime |
stateTransitionTime()
Get the state |
Pool |
stats()
Get this property is populated only if the Cloud |
Integer |
targetDedicatedNodes()
Get the target |
Integer |
targetLowPriorityNodes()
Get the target |
Node |
targetNodeCommunicationMode()
Get if omitted, the default value is Default. |
Task |
taskSchedulingPolicy()
Get if not specified, the default is spread. |
Integer |
taskSlotsPerNode()
Get the default value is 1. |
Upgrade |
upgradePolicy()
Get describes an upgrade policy - automatic, manual, or rolling. |
String |
url()
Get the url value. |
List<User |
userAccounts()
Get the user |
Virtual |
virtualMachineConfiguration()
Get this property 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. |
Cloud |
withAllocationState(AllocationState allocationState)
Set possible values include: 'steady', 'resizing', 'stopping'. |
Cloud |
withAllocationStateTransitionTime(DateTime allocationStateTransitionTime)
Set the allocation |
Cloud |
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. |
Cloud |
withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)
Set this property is set only if the Pool automatically scales, i. |
Cloud |
withAutoScaleFormula(String autoScaleFormula)
Set this property is set only if the Pool automatically scales, i. |
Cloud |
withAutoScaleRun(AutoScaleRun autoScaleRun)
Set this property is set only if the Pool automatically scales, i. |
Cloud |
withCertificateReferences(List<CertificateReference> certificateReferences)
Set for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. |
Cloud |
withCreationTime(DateTime creationTime)
Set the creation |
Cloud |
withCurrentDedicatedNodes(Integer currentDedicatedNodes)
Set the current |
Cloud |
withCurrentLowPriorityNodes(Integer currentLowPriorityNodes)
Set spot/Low-priority Compute Nodes which have been preempted are included in this count. |
Cloud |
withDisplayName(String displayName)
Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. |
Cloud |
withETag(String eTag)
Set this is an opaque string. |
Cloud |
withEnableAutoScale(Boolean enableAutoScale)
Set if false, at least one of target |
Cloud |
withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)
Set this imposes restrictions on which Compute Nodes can be assigned to the Pool. |
Cloud |
withId(String id)
Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. |
Cloud |
withIdentity(BatchPoolIdentity identity)
Set the list of user identities associated with the Batch pool. |
Cloud |
withLastModified(DateTime lastModified)
Set this is the last time at which the Pool level data, such as the target |
Cloud |
withMetadata(List<MetadataItem> metadata)
Set the metadata value. |
Cloud |
withMountConfiguration(List<MountConfiguration> mountConfiguration)
Set this supports Azure Files, NFS, CIFS/SMB, and Blobfuse. |
Cloud |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Set the network |
Cloud |
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 allocation |
Cloud |
withResizeTimeout(Period resizeTimeout)
Set this is the timeout for the most recent resize operation. |
Cloud |
withResourceTags(Map<String,String> resourceTags)
Set the user-defined tags to be associated with the Azure Batch Pool. |
Cloud |
withStartTask(StartTask startTask)
Set the start |
Cloud |
withState(PoolState state)
Set possible values include: 'active', 'deleting'. |
Cloud |
withStateTransitionTime(DateTime stateTransitionTime)
Set the state |
Cloud |
withStats(PoolStatistics stats)
Set this property is populated only if the Cloud |
Cloud |
withTargetDedicatedNodes(Integer targetDedicatedNodes)
Set the target |
Cloud |
withTargetLowPriorityNodes(Integer targetLowPriorityNodes)
Set the target |
Cloud |
withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)
Set if omitted, the default value is Default. |
Cloud |
withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)
Set if not specified, the default is spread. |
Cloud |
withTaskSlotsPerNode(Integer taskSlotsPerNode)
Set the default value is 1. |
Cloud |
withUpgradePolicy(UpgradePolicy upgradePolicy)
Set describes an upgrade policy - automatic, manual, or rolling. |
Cloud |
withUrl(String url)
Set the url value. |
Cloud |
withUserAccounts(List<UserAccount> userAccounts)
Set the user |
Cloud |
withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)
Set this property must be specified. |
Cloud |
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. |
Methods inherited from java.lang.Object
Constructor Details
CloudPool
public CloudPool()
Method Details
allocationState
public AllocationState allocationState()
Get possible values include: 'steady', 'resizing', 'stopping'.
Returns:
allocationStateTransitionTime
public DateTime allocationStateTransitionTime()
Get the allocationStateTransitionTime value.
Returns:
applicationPackageReferences
public List
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:
autoScaleEvaluationInterval
public Period autoScaleEvaluationInterval()
Get this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
Returns:
autoScaleFormula
public String autoScaleFormula()
Get this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
Returns:
autoScaleRun
public AutoScaleRun autoScaleRun()
Get this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
Returns:
certificateReferences
public List
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:
creationTime
public DateTime creationTime()
Get the creationTime value.
Returns:
currentDedicatedNodes
public Integer currentDedicatedNodes()
Get the currentDedicatedNodes value.
Returns:
currentLowPriorityNodes
public Integer currentLowPriorityNodes()
Get spot/Low-priority Compute Nodes which have been preempted are included in this count.
Returns:
currentNodeCommunicationMode
public NodeCommunicationMode currentNodeCommunicationMode()
Get possible values include: 'default', 'classic', 'simplified'.
Returns:
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:
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:
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:
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:
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:
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:
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:
metadata
public List
Get the metadata value.
Returns:
mountConfiguration
public List
Get this supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
Returns:
networkConfiguration
public NetworkConfiguration networkConfiguration()
Get the networkConfiguration value.
Returns:
resizeErrors
public List
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:
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:
resourceTags
public Map
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:
startTask
public StartTask startTask()
Get the startTask value.
Returns:
state
public PoolState state()
Get possible values include: 'active', 'deleting'.
Returns:
stateTransitionTime
public DateTime stateTransitionTime()
Get the stateTransitionTime value.
Returns:
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:
targetDedicatedNodes
public Integer targetDedicatedNodes()
Get the targetDedicatedNodes value.
Returns:
targetLowPriorityNodes
public Integer targetLowPriorityNodes()
Get the targetLowPriorityNodes value.
Returns:
targetNodeCommunicationMode
public NodeCommunicationMode targetNodeCommunicationMode()
Get if omitted, the default value is Default. Possible values include: 'default', 'classic', 'simplified'.
Returns:
taskSchedulingPolicy
public TaskSchedulingPolicy taskSchedulingPolicy()
Get if not specified, the default is spread.
Returns:
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:
upgradePolicy
public UpgradePolicy upgradePolicy()
Get describes an upgrade policy - automatic, manual, or rolling.
Returns:
url
public String url()
Get the url value.
Returns:
userAccounts
public List
Get the userAccounts value.
Returns:
virtualMachineConfiguration
public VirtualMachineConfiguration virtualMachineConfiguration()
Get this property must be specified.
Returns:
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:
withAllocationState
public CloudPool withAllocationState(AllocationState allocationState)
Set possible values include: 'steady', 'resizing', 'stopping'.
Parameters:
Returns:
withAllocationStateTransitionTime
public CloudPool withAllocationStateTransitionTime(DateTime allocationStateTransitionTime)
Set the allocationStateTransitionTime value.
Parameters:
Returns:
withApplicationPackageReferences
public CloudPool withApplicationPackageReferences(List
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:
Returns:
withAutoScaleEvaluationInterval
public CloudPool withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)
Set this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
Parameters:
Returns:
withAutoScaleFormula
public CloudPool withAutoScaleFormula(String autoScaleFormula)
Set this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
Parameters:
Returns:
withAutoScaleRun
public CloudPool withAutoScaleRun(AutoScaleRun autoScaleRun)
Set this property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
Parameters:
Returns:
withCertificateReferences
public CloudPool withCertificateReferences(List
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:
Returns:
withCreationTime
public CloudPool withCreationTime(DateTime creationTime)
Set the creationTime value.
Parameters:
Returns:
withCurrentDedicatedNodes
public CloudPool withCurrentDedicatedNodes(Integer currentDedicatedNodes)
Set the currentDedicatedNodes value.
Parameters:
Returns:
withCurrentLowPriorityNodes
public CloudPool withCurrentLowPriorityNodes(Integer currentLowPriorityNodes)
Set spot/Low-priority Compute Nodes which have been preempted are included in this count.
Parameters:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
withMetadata
public CloudPool withMetadata(List
Set the metadata value.
Parameters:
Returns:
withMountConfiguration
public CloudPool withMountConfiguration(List
Set this supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
Parameters:
Returns:
withNetworkConfiguration
public CloudPool withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Set the networkConfiguration value.
Parameters:
Returns:
withResizeErrors
public CloudPool withResizeErrors(List
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:
Returns:
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:
Returns:
withResourceTags
public CloudPool withResourceTags(Map
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:
Returns:
withStartTask
public CloudPool withStartTask(StartTask startTask)
Set the startTask value.
Parameters:
Returns:
withState
public CloudPool withState(PoolState state)
Set possible values include: 'active', 'deleting'.
Parameters:
Returns:
withStateTransitionTime
public CloudPool withStateTransitionTime(DateTime stateTransitionTime)
Set the stateTransitionTime value.
Parameters:
Returns:
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:
Returns:
withTargetDedicatedNodes
public CloudPool withTargetDedicatedNodes(Integer targetDedicatedNodes)
Set the targetDedicatedNodes value.
Parameters:
Returns:
withTargetLowPriorityNodes
public CloudPool withTargetLowPriorityNodes(Integer targetLowPriorityNodes)
Set the targetLowPriorityNodes value.
Parameters:
Returns:
withTargetNodeCommunicationMode
public CloudPool withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)
Set if omitted, the default value is Default. Possible values include: 'default', 'classic', 'simplified'.
Parameters:
Returns:
withTaskSchedulingPolicy
public CloudPool withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)
Set if not specified, the default is spread.
Parameters:
Returns:
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:
Returns:
withUpgradePolicy
public CloudPool withUpgradePolicy(UpgradePolicy upgradePolicy)
Set describes an upgrade policy - automatic, manual, or rolling.
Parameters:
Returns:
withUrl
public CloudPool withUrl(String url)
Set the url value.
Parameters:
Returns:
withUserAccounts
public CloudPool withUserAccounts(List
Set the userAccounts value.
Parameters:
Returns:
withVirtualMachineConfiguration
public CloudPool withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)
Set this property must be specified.
Parameters:
Returns:
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:
Returns:
Applies to
Azure SDK for Java