Pool.UpdateStages.WithAttach Interface

public interface WithAttach

The stage of a Batch pool update allowing the creation of configurations.

Method Summary

Modifier and Type Method and Description
Pool.Update withApplicationLicenses(List<String> applicationLicenses)

Specifies the list of application licenses.

Pool.Update withApplicationPackages(List<ApplicationPackageReference> applicationPackages)

Specifies the application package references affect all new compute nodes joining the pool.

Pool.Update withCertificates(List<CertificateReference> certificates)

Specifies the certificates for compute nodes.

Pool.Update withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

Specifies the creation of nodes using CloudServiceConfiguration/VirtualMachineConfiguration.

Pool.Update withDisplayName(String displayName)

Specifies the display name for the pool.

Pool.Update withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication)

Specifies the restrictions on which nodes can be assigned to the pool.

Pool.Update withMaxTasksPerNode(Integer maxTasksPerNode)

Specifies the maximum value of tasks to run on each node.

Pool.Update withMetadata(List<MetadataItem> metadata)

Specifies the metadata for the use of user code.

Pool.Update withMountConfiguration(List<MountConfiguration> mountConfigurations)

Specifies the file system configuration for the pool to mount on each node.

Pool.Update withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Specifies the network configuration for the pool.

Pool.Update withScaleSettings(ScaleSettings scaleSettings)

Specifies the scale settings for the pool.

Pool.Update withStartTask(StartTask startTask)

Specifies the start task for the pool.

Pool.Update withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Specifies the task scheduling policy.

Pool.Update withTaskSlotsPerNode(Integer taskSlotsPerNode)

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

Pool.Update withUserAccounts(List<UserAccount> userAccounts)

Specifies the user accounts value.

Pool.Update withVmSize(String vmSize)

Specifies the available sizes of virtual machine for Cloud Services pools.

Method Details

withApplicationLicenses

public Update withApplicationLicenses(List applicationLicenses)

Specifies the list of application licenses.

Parameters:

applicationLicenses - applicationLicenses value

Returns:

the next stage of the update

withApplicationPackages

public Update withApplicationPackages(List applicationPackages)

Specifies the application package references affect all new compute nodes joining the pool.

Parameters:

applicationPackages - applicationPackages value

Returns:

the next stage of the update

withCertificates

public Update withCertificates(List certificates)

Specifies the certificates for compute nodes.

Parameters:

certificates - certificates value

Returns:

the next stage of the update

withDeploymentConfiguration

public Update withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

Specifies the creation of nodes using CloudServiceConfiguration/VirtualMachineConfiguration.

Parameters:

deploymentConfiguration - deploymentConfiguration value

Returns:

the next stage of the update

withDisplayName

public Update withDisplayName(String displayName)

Specifies the display name for the pool.

Parameters:

displayName - displayName value

Returns:

the next stage of the update

withInterNodeCommunication

public Update withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication)

Specifies the restrictions on which nodes can be assigned to the pool.

Parameters:

interNodeCommunication - interNodeCommunication value

Returns:

the next stage of the update

withMaxTasksPerNode

public Update withMaxTasksPerNode(Integer maxTasksPerNode)

Specifies the maximum value of tasks to run on each node.

Parameters:

maxTasksPerNode - maxTasksPerNode value

Returns:

the next stage of the update

withMetadata

public Update withMetadata(List metadata)

Specifies the metadata for the use of user code.

Parameters:

metadata - metadata value

Returns:

the next stage of the update

withMountConfiguration

public Update withMountConfiguration(List mountConfigurations)

Specifies the file system configuration for the pool to mount on each node.

Parameters:

mountConfigurations - mount configuration value

Returns:

the next stage of the update

withNetworkConfiguration

public Update withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Specifies the network configuration for the pool.

Parameters:

networkConfiguration - network configuration value

Returns:

the next stage of the update

withScaleSettings

public Update withScaleSettings(ScaleSettings scaleSettings)

Specifies the scale settings for the pool.

Parameters:

scaleSettings - scale settings value

Returns:

the next stage of the update

withStartTask

public Update withStartTask(StartTask startTask)

Specifies the start task for the pool.

Parameters:

startTask - start task value

Returns:

the next stage of the update

withTaskSchedulingPolicy

public Update withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Specifies the task scheduling policy.

Parameters:

taskSchedulingPolicy - taskSchedulingPolicy value

Returns:

the next stage of the update

withTaskSlotsPerNode

public Update withTaskSlotsPerNode(Integer taskSlotsPerNode)

Specifies 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 number of task slots

Returns:

the next stage of the update

withUserAccounts

public Update withUserAccounts(List userAccounts)

Specifies the user accounts value.

Parameters:

userAccounts - userAccounts value

Returns:

the next stage of the update

withVmSize

public Update withVmSize(String vmSize)

Specifies the available sizes of virtual machine for Cloud Services pools.

Parameters:

vmSize - vmSize value

Returns:

the next stage of the update

Applies to