PoolAddParameter Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. PoolAddParameter
- com.
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<Application |
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<Certificate |
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. |
|
Cloud |
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<Metadata |
metadata()
Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code. |
|
Network |
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). |
|
Start |
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. |
|
Task |
taskSchedulingPolicy()
Get the taskSchedulingPolicy value. |
|
List<User |
userAccounts()
Get the userAccounts value. |
|
Virtual |
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). |
|
Pool |
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. |
|
Pool |
withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)
Set the applicationPackageReferences value. |
|
Pool |
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). |
|
Pool |
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/). |
|
Pool |
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. |
|
Pool |
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'. |
|
Pool |
withDisplayName(String displayName)
Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. |
|
Pool |
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. |
|
Pool |
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. |
|
Pool |
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). |
|
Pool |
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). |
|
Pool |
withMetadata(List<MetadataItem> metadata)
Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code. |
|
Pool |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Set the networkConfiguration value. |
|
Pool |
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). |
|
Pool |
withStartTask(StartTask startTask)
Set the task runs when the node is added to the pool or when the node is restarted. |
|
Pool |
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. |
|
Pool |
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. |
|
Pool |
withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)
Set the taskSchedulingPolicy value. |
|
Pool |
withUserAccounts(List<UserAccount> userAccounts)
Set the userAccounts value. |
|
Pool |
withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)
Set this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. |
|
Pool |
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
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:
applicationPackageReferences
public List
Get the applicationPackageReferences value.
Returns:
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:
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:
certificateReferences
public List
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:
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:
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:
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:
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:
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:
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:
metadata
public List
Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Returns:
networkConfiguration
public NetworkConfiguration networkConfiguration()
Get the networkConfiguration value.
Returns:
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:
startTask
public StartTask startTask()
Get the task runs when the node is added to the pool or when the node is restarted.
Returns:
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:
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:
taskSchedulingPolicy
public TaskSchedulingPolicy taskSchedulingPolicy()
Get the taskSchedulingPolicy value.
Returns:
userAccounts
public List
Get the userAccounts value.
Returns:
virtualMachineConfiguration
public VirtualMachineConfiguration virtualMachineConfiguration()
Get this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
Returns:
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:
withApplicationLicenses
public PoolAddParameter withApplicationLicenses(List
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:
Returns:
withApplicationPackageReferences
public PoolAddParameter withApplicationPackageReferences(List
Set the applicationPackageReferences value.
Parameters:
Returns:
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:
Returns:
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:
Returns:
withCertificateReferences
public PoolAddParameter withCertificateReferences(List
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
withMetadata
public PoolAddParameter withMetadata(List
Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Parameters:
Returns:
withNetworkConfiguration
public PoolAddParameter withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Set the networkConfiguration value.
Parameters:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
withTaskSchedulingPolicy
public PoolAddParameter withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)
Set the taskSchedulingPolicy value.
Parameters:
Returns:
withUserAccounts
public PoolAddParameter withUserAccounts(List
Set the userAccounts value.
Parameters:
Returns:
withVirtualMachineConfiguration
public PoolAddParameter withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)
Set this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
Parameters:
Returns:
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:
Returns:
