PoolInner Class

Package:

com.azure.resourcemanager.batch.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-batch:1.1.0-beta.4

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.batch.fluent.models.PoolInner

public final class PoolInner
extends ProxyResource

Contains information about a pool.

Constructor Summary

Constructor	Description
PoolInner()	Creates an instance of PoolInner class.

Method Summary

Modifier and Type	Method and Description
AllocationState	allocationState() Get the allocationState property: Whether the pool is resizing.
OffsetDateTime	allocationStateTransitionTime() Get the allocationStateTransitionTime property: The time at which the pool entered its current allocation state.
List<String>	applicationLicenses() Get the applicationLicenses property: The list of application licenses the Batch service will make available on each compute node in the pool.
List<ApplicationPackageReference>	applicationPackages() Get the applicationPackages property: The list of application packages to be installed on each compute node in the pool.
AutoScaleRun	autoScaleRun() Get the autoScaleRun property: The results and errors from an execution of a pool autoscale formula.
List<CertificateReference>	certificates() Get the certificates property: The list of certificates to be installed on each compute node in the pool.
OffsetDateTime	creationTime() Get the creationTime property: The creation time of the pool.
Integer	currentDedicatedNodes() Get the currentDedicatedNodes property: The number of dedicated compute nodes currently in the pool.
Integer	currentLowPriorityNodes() Get the currentLowPriorityNodes property: The number of Spot/low-priority compute nodes currently in the pool.
NodeCommunicationMode	currentNodeCommunicationMode() Get the currentNodeCommunicationMode property: Determines how a pool communicates with the Batch service.
DeploymentConfiguration	deploymentConfiguration() Get the deploymentConfiguration property: Deployment configuration properties.
String	displayName() Get the displayName property: The display name for the pool.
String	etag() Get the etag property: The ETag of the resource, used for concurrency statements.
BatchPoolIdentity	identity() Get the identity property: The type of identity used for the Batch Pool.
InterNodeCommunicationState	interNodeCommunication() Get the interNodeCommunication property: Whether the pool permits direct communication between nodes.
OffsetDateTime	lastModified() Get the lastModified property: The last modified time of the pool.
List<MetadataItem>	metadata() Get the metadata property: A list of name-value pairs associated with the pool as metadata.
List<MountConfiguration>	mountConfiguration() Get the mountConfiguration property: A list of file systems to mount on each node in the pool.
NetworkConfiguration	networkConfiguration() Get the networkConfiguration property: The network configuration for a pool.
PoolProvisioningState	provisioningState() Get the provisioningState property: The current state of the pool.
OffsetDateTime	provisioningStateTransitionTime() Get the provisioningStateTransitionTime property: The time at which the pool entered its current state.
ResizeOperationStatus	resizeOperationStatus() Get the resizeOperationStatus property: Details about the current or last completed resize operation.
Map<String,String>	resourceTags() Get the resourceTags property: The user-defined tags to be associated with the Azure Batch Pool.
ScaleSettings	scaleSettings() Get the scaleSettings property: Scale settings for the pool Defines the desired size of the pool.
StartTask	startTask() Get the startTask property: A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.
NodeCommunicationMode	targetNodeCommunicationMode() Get the targetNodeCommunicationMode property: Determines how a pool communicates with the Batch service.
TaskSchedulingPolicy	taskSchedulingPolicy() Get the taskSchedulingPolicy property: Specifies how tasks should be distributed across compute nodes.
Integer	taskSlotsPerNode() Get the taskSlotsPerNode property: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.
UpgradePolicy	upgradePolicy() Get the upgradePolicy property: Describes an upgrade policy - automatic, manual, or rolling.
List<UserAccount>	userAccounts() Get the userAccounts property: The list of user accounts to be created on each node in the pool.
void	validate() Validates the instance.
String	vmSize() Get the vmSize property: The size of virtual machines in the pool.
PoolInner	withApplicationLicenses(List<String> applicationLicenses) Set the applicationLicenses property: The list of application licenses the Batch service will make available on each compute node in the pool.
PoolInner	withApplicationPackages(List<ApplicationPackageReference> applicationPackages) Set the applicationPackages property: The list of application packages to be installed on each compute node in the pool.
PoolInner	withCertificates(List<CertificateReference> certificates) Set the certificates property: The list of certificates to be installed on each compute node in the pool.
PoolInner	withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration) Set the deploymentConfiguration property: Deployment configuration properties.
PoolInner	withDisplayName(String displayName) Set the displayName property: The display name for the pool.
PoolInner	withIdentity(BatchPoolIdentity identity) Set the identity property: The type of identity used for the Batch Pool.
PoolInner	withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication) Set the interNodeCommunication property: Whether the pool permits direct communication between nodes.
PoolInner	withMetadata(List<MetadataItem> metadata) Set the metadata property: A list of name-value pairs associated with the pool as metadata.
PoolInner	withMountConfiguration(List<MountConfiguration> mountConfiguration) Set the mountConfiguration property: A list of file systems to mount on each node in the pool.
PoolInner	withNetworkConfiguration(NetworkConfiguration networkConfiguration) Set the networkConfiguration property: The network configuration for a pool.
PoolInner	withResourceTags(Map<String,String> resourceTags) Set the resourceTags property: The user-defined tags to be associated with the Azure Batch Pool.
PoolInner	withScaleSettings(ScaleSettings scaleSettings) Set the scaleSettings property: Scale settings for the pool Defines the desired size of the pool.
PoolInner	withStartTask(StartTask startTask) Set the startTask property: A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.
PoolInner	withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode) Set the targetNodeCommunicationMode property: Determines how a pool communicates with the Batch service.
PoolInner	withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy) Set the taskSchedulingPolicy property: Specifies how tasks should be distributed across compute nodes.
PoolInner	withTaskSlotsPerNode(Integer taskSlotsPerNode) Set the taskSlotsPerNode property: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.
PoolInner	withUpgradePolicy(UpgradePolicy upgradePolicy) Set the upgradePolicy property: Describes an upgrade policy - automatic, manual, or rolling.
PoolInner	withUserAccounts(List<UserAccount> userAccounts) Set the userAccounts property: The list of user accounts to be created on each node in the pool.
PoolInner	withVmSize(String vmSize) Set the vmSize property: The size of virtual machines in the pool.

Methods inherited from ProxyResource

id name type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PoolInner

public PoolInner()

Creates an instance of PoolInner class.

Method Details

allocationState

public AllocationState allocationState()

Get the allocationState property: Whether the pool is resizing.

Returns:

the allocationState value.

allocationStateTransitionTime

public OffsetDateTime allocationStateTransitionTime()

Get the allocationStateTransitionTime property: The time at which the pool entered its current allocation state.

Returns:

the allocationStateTransitionTime value.

applicationLicenses

public List applicationLicenses()

Get the applicationLicenses property: The list of application licenses the Batch service will make available on each compute node in the pool. 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.

applicationPackages

public List applicationPackages()

Get the applicationPackages property: The list of application packages to be installed on each compute node in the pool. Changes to application package references affect all new compute 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 application package references on any given pool.

Returns:

the applicationPackages value.

autoScaleRun

public AutoScaleRun autoScaleRun()

Get the autoScaleRun property: The results and errors from an execution of a pool autoscale formula. This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

Returns:

the autoScaleRun value.

certificates

public List certificates()

Get the certificates property: The list of certificates to be installed on each compute node in the pool. For Windows compute 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 certificates value.

creationTime

public OffsetDateTime creationTime()

Get the creationTime property: The creation time of the pool.

Returns:

the creationTime value.

currentDedicatedNodes

public Integer currentDedicatedNodes()

Get the currentDedicatedNodes property: The number of dedicated compute nodes currently in the pool.

Returns:

the currentDedicatedNodes value.

currentLowPriorityNodes

public Integer currentLowPriorityNodes()

Get the currentLowPriorityNodes property: The number of Spot/low-priority compute nodes currently in the pool.

Returns:

the currentLowPriorityNodes value.

currentNodeCommunicationMode

public NodeCommunicationMode currentNodeCommunicationMode()

Get the currentNodeCommunicationMode property: Determines how a pool communicates with the Batch service.

Returns:

the currentNodeCommunicationMode value.

deploymentConfiguration

public DeploymentConfiguration deploymentConfiguration()

Get the deploymentConfiguration property: Deployment configuration properties. Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

Returns:

the deploymentConfiguration value.

displayName

public String displayName()

Get the displayName property: 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.

Returns:

the displayName value.

etag

public String etag()

Get the etag property: The ETag of the resource, used for concurrency statements.

Returns:

the etag value.

identity

public BatchPoolIdentity identity()

Get the identity property: The type of identity used for the Batch Pool.

Returns:

the identity value.

interNodeCommunication

public InterNodeCommunicationState interNodeCommunication()

Get the interNodeCommunication property: Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

Returns:

the interNodeCommunication value.

lastModified

public OffsetDateTime lastModified()

Get the lastModified property: The last modified time of the pool. This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, 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 property: A list of name-value pairs associated with the pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Returns:

the metadata value.

mountConfiguration

public List mountConfiguration()

Get the mountConfiguration property: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

Returns:

the mountConfiguration value.

networkConfiguration

public NetworkConfiguration networkConfiguration()

Get the networkConfiguration property: The network configuration for a pool.

Returns:

the networkConfiguration value.

provisioningState

public PoolProvisioningState provisioningState()

Get the provisioningState property: The current state of the pool.

Returns:

the provisioningState value.

provisioningStateTransitionTime

public OffsetDateTime provisioningStateTransitionTime()

Get the provisioningStateTransitionTime property: The time at which the pool entered its current state.

Returns:

the provisioningStateTransitionTime value.

resizeOperationStatus

public ResizeOperationStatus resizeOperationStatus()

Get the resizeOperationStatus property: Details about the current or last completed resize operation. Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

Returns:

the resizeOperationStatus value.

resourceTags

public Map resourceTags()

Get the resourceTags property: 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.

scaleSettings

public ScaleSettings scaleSettings()

Get the scaleSettings property: Scale settings for the pool Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

Returns:

the scaleSettings value.

startTask

public StartTask startTask()

Get the startTask property: A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

Returns:

the startTask value.

targetNodeCommunicationMode

public NodeCommunicationMode targetNodeCommunicationMode()

Get the targetNodeCommunicationMode property: Determines how a pool communicates with the Batch service. If omitted, the default value is Default.

Returns:

the targetNodeCommunicationMode value.

taskSchedulingPolicy

public TaskSchedulingPolicy taskSchedulingPolicy()

Get the taskSchedulingPolicy property: Specifies how tasks should be distributed across compute nodes. If not specified, the default is spread.

Returns:

the taskSchedulingPolicy value.

taskSlotsPerNode

public Integer taskSlotsPerNode()

Get the taskSlotsPerNode property: 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.

Returns:

the taskSlotsPerNode value.

upgradePolicy

public UpgradePolicy upgradePolicy()

Get the upgradePolicy property: Describes an upgrade policy - automatic, manual, or rolling.

Returns:

the upgradePolicy value.

userAccounts

public List userAccounts()

Get the userAccounts property: The list of user accounts to be created on each node in the pool.

Returns:

the userAccounts value.

validate

public void validate()

Validates the instance.

vmSize

public String vmSize()

Get the vmSize property: The size of virtual machines in the pool. All VMs in a pool are the same size. For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

Returns:

the vmSize value.

withApplicationLicenses

public PoolInner withApplicationLicenses(List applicationLicenses)

Set the applicationLicenses property: The list of application licenses the Batch service will make available on each compute node in the pool. 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 PoolInner object itself.

withApplicationPackages

public PoolInner withApplicationPackages(List applicationPackages)

Set the applicationPackages property: The list of application packages to be installed on each compute node in the pool. Changes to application package references affect all new compute 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 application package references on any given pool.

Parameters:

applicationPackages - the applicationPackages value to set.

Returns:

the PoolInner object itself.

withCertificates

public PoolInner withCertificates(List certificates)

Set the certificates property: The list of certificates to be installed on each compute node in the pool. For Windows compute 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:

certificates - the certificates value to set.

Returns:

the PoolInner object itself.

withDeploymentConfiguration

public PoolInner withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

Set the deploymentConfiguration property: Deployment configuration properties. Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

Parameters:

deploymentConfiguration - the deploymentConfiguration value to set.

Returns:

the PoolInner object itself.

withDisplayName

public PoolInner withDisplayName(String displayName)

Set the displayName property: 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.

Parameters:

displayName - the displayName value to set.

Returns:

the PoolInner object itself.

withIdentity

public PoolInner withIdentity(BatchPoolIdentity identity)

Set the identity property: The type of identity used for the Batch Pool.

Parameters:

identity - the identity value to set.

Returns:

the PoolInner object itself.

withInterNodeCommunication

public PoolInner withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication)

Set the interNodeCommunication property: Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

Parameters:

interNodeCommunication - the interNodeCommunication value to set.

Returns:

the PoolInner object itself.

withMetadata

public PoolInner withMetadata(List metadata)

Set the metadata property: A list of name-value pairs associated with the pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Parameters:

metadata - the metadata value to set.

Returns:

the PoolInner object itself.

withMountConfiguration

public PoolInner withMountConfiguration(List mountConfiguration)

Set the mountConfiguration property: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

Parameters:

mountConfiguration - the mountConfiguration value to set.

Returns:

the PoolInner object itself.

withNetworkConfiguration

public PoolInner withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Set the networkConfiguration property: The network configuration for a pool.

Parameters:

networkConfiguration - the networkConfiguration value to set.

Returns:

the PoolInner object itself.

withResourceTags

public PoolInner withResourceTags(Map resourceTags)

Set the resourceTags property: 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 PoolInner object itself.

withScaleSettings

public PoolInner withScaleSettings(ScaleSettings scaleSettings)

Set the scaleSettings property: Scale settings for the pool Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

Parameters:

scaleSettings - the scaleSettings value to set.

Returns:

the PoolInner object itself.

withStartTask

public PoolInner withStartTask(StartTask startTask)

Set the startTask property: A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

Parameters:

startTask - the startTask value to set.

Returns:

the PoolInner object itself.

withTargetNodeCommunicationMode

public PoolInner withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)

Set the targetNodeCommunicationMode property: Determines how a pool communicates with the Batch service. If omitted, the default value is Default.

Parameters:

targetNodeCommunicationMode - the targetNodeCommunicationMode value to set.

Returns:

the PoolInner object itself.

withTaskSchedulingPolicy

public PoolInner withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Set the taskSchedulingPolicy property: Specifies how tasks should be distributed across compute nodes. If not specified, the default is spread.

Parameters:

taskSchedulingPolicy - the taskSchedulingPolicy value to set.

Returns:

the PoolInner object itself.

withTaskSlotsPerNode

public PoolInner withTaskSlotsPerNode(Integer taskSlotsPerNode)

Set the taskSlotsPerNode property: 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.

Parameters:

taskSlotsPerNode - the taskSlotsPerNode value to set.

Returns:

the PoolInner object itself.

withUpgradePolicy

public PoolInner withUpgradePolicy(UpgradePolicy upgradePolicy)

Set the upgradePolicy property: Describes an upgrade policy - automatic, manual, or rolling.

Parameters:

upgradePolicy - the upgradePolicy value to set.

Returns:

the PoolInner object itself.

withUserAccounts

public PoolInner withUserAccounts(List userAccounts)

Set the userAccounts property: The list of user accounts to be created on each node in the pool.

Parameters:

userAccounts - the userAccounts value to set.

Returns:

the PoolInner object itself.

withVmSize

public PoolInner withVmSize(String vmSize)

Set the vmSize property: The size of virtual machines in the pool. All VMs in a pool are the same size. For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

Parameters:

vmSize - the vmSize value to set.

Returns:

the PoolInner object itself.