Pool Interface

public abstract AllocationState allocationState()

Gets the allocationState property: Whether the pool is resizing.

Returns:

public abstract OffsetDateTime allocationStateTransitionTime()

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

Returns:

public abstract List<String> applicationLicenses()

Gets the applicationLicenses property: 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:

public abstract List<ApplicationPackageReference> applicationPackages()

Gets the applicationPackages property: 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:

public abstract AutoScaleRun autoScaleRun()

Gets the autoScaleRun property: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

Returns:

public abstract List<CertificateReference> certificates()

Gets the certificates property: 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:

public abstract OffsetDateTime creationTime()

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

Returns:

public abstract Integer currentDedicatedNodes()

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

Returns:

public abstract Integer currentLowPriorityNodes()

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

Returns:

public abstract NodeCommunicationMode currentNodeCommunicationMode()

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

Returns:

public abstract DeploymentConfiguration deploymentConfiguration()

Gets the deploymentConfiguration property: Deployment configuration properties.

Returns:

public abstract Pool disableAutoScale()

Disables automatic scaling for a pool.

Returns:

public abstract Response<Pool> disableAutoScaleWithResponse(Context context)

Disables automatic scaling for a pool.

Parameters:

Returns:

public abstract String displayName()

Gets the displayName property: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Returns:

public abstract String etag()

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

Returns:

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

public abstract BatchPoolIdentity identity()

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

Returns:

public abstract PoolInner innerModel()

Gets the inner com.azure.resourcemanager.batch.fluent.models.PoolInner object.

Returns:

public abstract InterNodeCommunicationState interNodeCommunication()

Gets the interNodeCommunication property: 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:

public abstract OffsetDateTime lastModified()

Gets the lastModified property: 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:

public abstract List<MetadataItem> metadata()

Gets the metadata property: The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Returns:

public abstract List<MountConfiguration> mountConfiguration()

Gets the mountConfiguration property: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

Returns:

public abstract String name()

Gets the name property: The name of the resource.

Returns:

public abstract NetworkConfiguration networkConfiguration()

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

Returns:

public abstract PoolProvisioningState provisioningState()

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

Returns:

public abstract OffsetDateTime provisioningStateTransitionTime()

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

Returns:

public abstract Pool refresh()

Refreshes the resource to sync with Azure.

Returns:

public abstract Pool refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

Returns:

public abstract ResizeOperationStatus resizeOperationStatus()

Gets the resizeOperationStatus property: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

Returns:

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

public abstract Map<String,String> resourceTags()

Gets 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:

public abstract ScaleSettings scaleSettings()

Gets the scaleSettings property: 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:

public abstract StartTask startTask()

Gets the startTask property: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

Returns:

public abstract Pool stopResize()

Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

Returns:

public abstract Response<Pool> stopResizeWithResponse(Context context)

Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

Parameters:

Returns:

public abstract Map<String,String> tags()

Gets the tags property: The tags of the resource.

Returns:

public abstract NodeCommunicationMode targetNodeCommunicationMode()

Gets the targetNodeCommunicationMode property: If omitted, the default value is Default.

Returns:

public abstract TaskSchedulingPolicy taskSchedulingPolicy()

Gets the taskSchedulingPolicy property: If not specified, the default is spread.

Returns:

public abstract Integer taskSlotsPerNode()

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

public abstract String type()

Gets the type property: The type of the resource.

Returns:

public abstract Pool.Update update()

Begins update for the Pool resource.

Returns:

public abstract UpgradePolicy upgradePolicy()

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

Returns:

public abstract List<UserAccount> userAccounts()

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

Returns:

public abstract String vmSize()

Gets the vmSize property: For information about available VM sizes, 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: