PoolAddParameter Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.PoolAddParameter

public class PoolAddParameter

A pool in the Azure Batch service to add.

Method Summary

Modifier and Type Method and Description
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> applicationPackageReferences()

Get the applicationPackageReferences value.
Period autoScaleEvaluationInterval()

Get the default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
String autoScaleFormula()

Get this property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale compute nodes in an Azure Batch pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
List<CertificateReference> certificateReferences()

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.
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'.
String displayName()

Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
Boolean enableAutoScale()

Get if false, at least one of targetDedicateNodes 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.
Boolean enableInterNodeCommunication()

Get enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.
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 pool IDs within an account that differ only by case).
Integer maxTasksPerNode()

Get the default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting).
List<MetadataItem> metadata()

Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
NetworkConfiguration networkConfiguration()

Get the networkConfiguration value.
Period resizeTimeout()

Get this timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
StartTask startTask()

Get the task runs when the node is added to the pool or when the node is restarted.
Integer targetDedicatedNodes()

Get this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
Integer targetLowPriorityNodes()

Get this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
TaskSchedulingPolicy taskSchedulingPolicy()

Get the taskSchedulingPolicy 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 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, A1V2 and A2V2. 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).
PoolAddParameter 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.
PoolAddParameter withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)

Set the applicationPackageReferences value.
PoolAddParameter withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)

Set the default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
PoolAddParameter withAutoScaleFormula(String autoScaleFormula)

Set this property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale compute nodes in an Azure Batch pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
PoolAddParameter withCertificateReferences(List<CertificateReference> certificateReferences)

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.
PoolAddParameter 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'.
PoolAddParameter withDisplayName(String displayName)

Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
PoolAddParameter withEnableAutoScale(Boolean enableAutoScale)

Set if false, at least one of targetDedicateNodes 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.
PoolAddParameter withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)

Set enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.
PoolAddParameter 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 pool IDs within an account that differ only by case).
PoolAddParameter withMaxTasksPerNode(Integer maxTasksPerNode)

Set the default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting).
PoolAddParameter withMetadata(List<MetadataItem> metadata)

Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
PoolAddParameter withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Set the networkConfiguration value.
PoolAddParameter withResizeTimeout(Period resizeTimeout)

Set this timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
PoolAddParameter withStartTask(StartTask startTask)

Set the task runs when the node is added to the pool or when the node is restarted.
PoolAddParameter withTargetDedicatedNodes(Integer targetDedicatedNodes)

Set this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
PoolAddParameter withTargetLowPriorityNodes(Integer targetLowPriorityNodes)

Set this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
PoolAddParameter withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Set the taskSchedulingPolicy value.
PoolAddParameter withUserAccounts(List<UserAccount> userAccounts)

Set the userAccounts value.
PoolAddParameter withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)

Set this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
PoolAddParameter 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, A1V2 and A2V2. 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

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 the applicationPackageReferences value.

Returns:

the applicationPackageReferences value

autoScaleEvaluationInterval

public Period autoScaleEvaluationInterval()

Get the default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Returns:

the autoScaleEvaluationInterval value

autoScaleFormula

public String autoScaleFormula()

Get this property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale compute nodes in an Azure Batch pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

Returns:

the autoScaleFormula value

certificateReferences

public List certificateReferences()

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

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

enableAutoScale

public Boolean enableAutoScale()

Get if false, at least one of targetDedicateNodes 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 enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.

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 pool IDs within an account that differ only by case).

Returns:

the id value

maxTasksPerNode

public Integer maxTasksPerNode()

Get the default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting).

Returns:

the maxTasksPerNode 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

networkConfiguration

public NetworkConfiguration networkConfiguration()

Get the networkConfiguration value.

Returns:

the networkConfiguration value

resizeTimeout

public Period resizeTimeout()

Get this timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Returns:

the resizeTimeout value

startTask

public StartTask startTask()

Get the task runs when the node is added to the pool or when the node is restarted.

Returns:

the startTask value

targetDedicatedNodes

public Integer targetDedicatedNodes()

Get this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

Returns:

the targetDedicatedNodes value

targetLowPriorityNodes

public Integer targetLowPriorityNodes()

Get this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

Returns:

the targetLowPriorityNodes value

taskSchedulingPolicy

public TaskSchedulingPolicy taskSchedulingPolicy()

Get the taskSchedulingPolicy value.

Returns:

the taskSchedulingPolicy 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 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, A1V2 and A2V2. 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 PoolAddParameter 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 PoolAddParameter object itself.

withApplicationPackageReferences

public PoolAddParameter withApplicationPackageReferences(List applicationPackageReferences)

Set the applicationPackageReferences value.

Parameters:

applicationPackageReferences - the applicationPackageReferences value to set

Returns:

the PoolAddParameter object itself.

withAutoScaleEvaluationInterval

public PoolAddParameter withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)

Set the default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Parameters:

autoScaleEvaluationInterval - the autoScaleEvaluationInterval value to set

Returns:

the PoolAddParameter object itself.

withAutoScaleFormula

public PoolAddParameter withAutoScaleFormula(String autoScaleFormula)

Set this property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale compute nodes in an Azure Batch pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

Parameters:

autoScaleFormula - the autoScaleFormula value to set

Returns:

the PoolAddParameter object itself.

withCertificateReferences

public PoolAddParameter withCertificateReferences(List certificateReferences)

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:

certificateReferences - the certificateReferences value to set

Returns:

the PoolAddParameter object itself.

withCloudServiceConfiguration

public PoolAddParameter 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 PoolAddParameter object itself.

withDisplayName

public PoolAddParameter 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 PoolAddParameter object itself.

withEnableAutoScale

public PoolAddParameter withEnableAutoScale(Boolean enableAutoScale)

Set if false, at least one of targetDedicateNodes 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 PoolAddParameter object itself.

withEnableInterNodeCommunication

public PoolAddParameter withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)

Set enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.

Parameters:

enableInterNodeCommunication - the enableInterNodeCommunication value to set

Returns:

the PoolAddParameter object itself.

withId

public PoolAddParameter 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 pool IDs within an account that differ only by case).

Parameters:

id - the id value to set

Returns:

the PoolAddParameter object itself.

withMaxTasksPerNode

public PoolAddParameter withMaxTasksPerNode(Integer maxTasksPerNode)

Set the default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting).

Parameters:

maxTasksPerNode - the maxTasksPerNode value to set

Returns:

the PoolAddParameter object itself.

withMetadata

public PoolAddParameter 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 PoolAddParameter object itself.

withNetworkConfiguration

public PoolAddParameter withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Set the networkConfiguration value.

Parameters:

networkConfiguration - the networkConfiguration value to set

Returns:

the PoolAddParameter object itself.

withResizeTimeout

public PoolAddParameter withResizeTimeout(Period resizeTimeout)

Set this timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Parameters:

resizeTimeout - the resizeTimeout value to set

Returns:

the PoolAddParameter object itself.

withStartTask

public PoolAddParameter withStartTask(StartTask startTask)

Set the task runs when the node is added to the pool or when the node is restarted.

Parameters:

startTask - the startTask value to set

Returns:

the PoolAddParameter object itself.

withTargetDedicatedNodes

public PoolAddParameter withTargetDedicatedNodes(Integer targetDedicatedNodes)

Set this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

Parameters:

targetDedicatedNodes - the targetDedicatedNodes value to set

Returns:

the PoolAddParameter object itself.

withTargetLowPriorityNodes

public PoolAddParameter withTargetLowPriorityNodes(Integer targetLowPriorityNodes)

Set this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

Parameters:

targetLowPriorityNodes - the targetLowPriorityNodes value to set

Returns:

the PoolAddParameter object itself.

withTaskSchedulingPolicy

public PoolAddParameter withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Set the taskSchedulingPolicy value.

Parameters:

taskSchedulingPolicy - the taskSchedulingPolicy value to set

Returns:

the PoolAddParameter object itself.

withUserAccounts

public PoolAddParameter withUserAccounts(List userAccounts)

Set the userAccounts value.

Parameters:

userAccounts - the userAccounts value to set

Returns:

the PoolAddParameter object itself.

withVirtualMachineConfiguration

public PoolAddParameter 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 PoolAddParameter object itself.

withVmSize

public PoolAddParameter 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, A1V2 and A2V2. 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 PoolAddParameter object itself.

Applies to