PoolInner Class

Package:

com.microsoft.azure.management.batch.implementation

• java.lang.Object
• • ProxyResource
  • • com.microsoft.azure.management.batch.implementation.PoolInner

public class PoolInner

Contains information about a pool.

Method Summary

Modifier and Type	Method and Description
AllocationState	allocationState() Get possible values include: 'Steady', 'Resizing', 'Stopping'.
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. If a license is requested which is not supported, pool creation will fail.
List<ApplicationPackageReference>	applicationPackages() Get 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.
AutoScaleRun	autoScaleRun() Get this property is set only if the pool automatically scales, i.e. autoScaleSettings are used.
List<CertificateReference>	certificates() Get 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.
DateTime	creationTime() Get the creationTime value.
Integer	currentDedicatedNodes() Get the currentDedicatedNodes value.
Integer	currentLowPriorityNodes() Get the currentLowPriorityNodes value.
DeploymentConfiguration	deploymentConfiguration() Get using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).
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 the ETag of the resource, used for concurrency statements.
BatchPoolIdentity	identity() Get the type of identity used for the Batch Pool.
InterNodeCommunicationState	interNodeCommunication() Get 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'. Possible values include: 'Enabled', 'Disabled'.
DateTime	lastModified() Get 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.
List<MetadataItem>	metadata() Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
List<MountConfiguration>	mountConfiguration() Get this supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
NetworkConfiguration	networkConfiguration() Get the networkConfiguration value.
PoolProvisioningState	provisioningState() Get possible values include: 'Succeeded', 'Deleting'.
DateTime	provisioningStateTransitionTime() Get the provisioningStateTransitionTime value.
ResizeOperationStatus	resizeOperationStatus() Get the resizeOperationStatus value.
ScaleSettings	scaleSettings() Get the scaleSettings value.
StartTask	startTask() Get in an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
TaskSchedulingPolicy	taskSchedulingPolicy() Get if not specified, the default is spread.
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.
List<UserAccount>	userAccounts() Get the userAccounts value.
String	vmSize() Get 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).
PoolInner	withApplicationLicenses(List<String> 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.
PoolInner	withApplicationPackages(List<ApplicationPackageReference> applicationPackages) Set 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.
PoolInner	withCertificates(List<CertificateReference> certificates) Set 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.
PoolInner	withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration) Set using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).
PoolInner	withDisplayName(String displayName) Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
PoolInner	withIdentity(BatchPoolIdentity identity) Set the type of identity used for the Batch Pool.
PoolInner	withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication) Set 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'. Possible values include: 'Enabled', 'Disabled'.
PoolInner	withMetadata(List<MetadataItem> metadata) Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
PoolInner	withMountConfiguration(List<MountConfiguration> mountConfiguration) Set this supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
PoolInner	withNetworkConfiguration(NetworkConfiguration networkConfiguration) Set the networkConfiguration value.
PoolInner	withScaleSettings(ScaleSettings scaleSettings) Set the scaleSettings value.
PoolInner	withStartTask(StartTask startTask) Set in an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
PoolInner	withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy) Set if not specified, the default is spread.
PoolInner	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.
PoolInner	withUserAccounts(List<UserAccount> userAccounts) Set the userAccounts value.
PoolInner	withVmSize(String vmSize) Set 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).

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

applicationPackages

public List applicationPackages()

Get 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 this property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

Returns:

the autoScaleRun value

certificates

public List certificates()

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

Returns:

the certificates 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 the currentLowPriorityNodes value.

Returns:

the currentLowPriorityNodes value

deploymentConfiguration

public DeploymentConfiguration deploymentConfiguration()

Get 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 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 of the resource, used for concurrency statements.

Returns:

the etag value

identity

public BatchPoolIdentity identity()

Get the type of identity used for the Batch Pool.

Returns:

the identity value

interNodeCommunication

public InterNodeCommunicationState interNodeCommunication()

Get 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'. Possible values include: 'Enabled', 'Disabled'.

Returns:

the interNodeCommunication value

lastModified

public DateTime lastModified()

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

provisioningState

public PoolProvisioningState provisioningState()

Get possible values include: 'Succeeded', 'Deleting'.

Returns:

the provisioningState value

provisioningStateTransitionTime

public DateTime provisioningStateTransitionTime()

Get the provisioningStateTransitionTime value.

Returns:

the provisioningStateTransitionTime value

resizeOperationStatus

public ResizeOperationStatus resizeOperationStatus()

Get the resizeOperationStatus value.

Returns:

the resizeOperationStatus value

scaleSettings

public ScaleSettings scaleSettings()

Get the scaleSettings value.

Returns:

the scaleSettings value

startTask

public StartTask startTask()

Get 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

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

userAccounts

public List userAccounts()

Get the userAccounts value.

Returns:

the userAccounts value

vmSize

public String vmSize()

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

Parameters:

certificates - the certificates value to set

Returns:

the PoolInner object itself.

withDeploymentConfiguration

public PoolInner withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

Set 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 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 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 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'. Possible values include: 'Enabled', 'Disabled'.

Parameters:

interNodeCommunication - the interNodeCommunication value to set

Returns:

the PoolInner object itself.

withMetadata

public PoolInner withMetadata(List metadata)

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

Parameters:

networkConfiguration - the networkConfiguration value to set

Returns:

the PoolInner object itself.

withScaleSettings

public PoolInner withScaleSettings(ScaleSettings scaleSettings)

Set the scaleSettings value.

Parameters:

scaleSettings - the scaleSettings value to set

Returns:

the PoolInner object itself.

withStartTask

public PoolInner withStartTask(StartTask startTask)

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

withTaskSchedulingPolicy

public PoolInner withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

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

withUserAccounts

public PoolInner withUserAccounts(List userAccounts)

Set the userAccounts value.

Parameters:

userAccounts - the userAccounts value to set

Returns:

the PoolInner object itself.

withVmSize

public PoolInner withVmSize(String vmSize)

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