Pool.DefinitionStages.WithAttach<ParentT> Interface

Type Parameters

ParentT

the stage of the parent Batch account definition to return to after attaching this definition

public interface WithAttach extends Attachable.InDefinition

The stage of a Batch pool definition that allows the creation of a pool.

Method Summary

Modifier and Type Method and Description
DefinitionStages.WithAttach<ParentT> withApplicationLicenses(List<String> applicationLicenses)

Specifies the list of application licenses.

DefinitionStages.WithAttach<ParentT> withApplicationPackages(List<ApplicationPackageReference> applicationPackages)

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

DefinitionStages.WithAttach<ParentT> withCertificates(List<CertificateReference> certificates)

Specifies the certificates for compute nodes.

DefinitionStages.WithAttach<ParentT> withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

Specifies the creation of nodes using CloudServiceConfiguration/VirtualMachineConfiguration.

DefinitionStages.WithAttach<ParentT> withDisplayName(String displayName)

Specifies the display name for the pool.

DefinitionStages.WithAttach<ParentT> withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication)

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

DefinitionStages.WithAttach<ParentT> withMaxTasksPerNode(Integer maxTasksPerNode)

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

DefinitionStages.WithAttach<ParentT> withMetadata(List<MetadataItem> metadata)

Specifies the metadata for the use of user code.

DefinitionStages.WithAttach<ParentT> withMountConfiguration(List<MountConfiguration> mountConfigurations)

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

DefinitionStages.WithAttach<ParentT> withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Specifies the network configuration for the pool.

DefinitionStages.WithAttach<ParentT> withScaleSettings(ScaleSettings scaleSettings)

Specifies the scale settings for the pool.

DefinitionStages.WithAttach<ParentT> withStartTask(StartTask startTask)

Specifies the start task for the pool.

DefinitionStages.WithAttach<ParentT> withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Specifies the task scheduling policy.

DefinitionStages.WithAttach<ParentT> 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.

DefinitionStages.WithAttach<ParentT> withUserAccounts(List<UserAccount> userAccounts)

Specifies the user accounts value.

DefinitionStages.WithAttach<ParentT> withVmSize(String vmSize)

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

Inherited Members

Method Details

withApplicationLicenses

public DefinitionStages.WithAttach withApplicationLicenses(List applicationLicenses)

Specifies the list of application licenses.

Parameters:

applicationLicenses - applicationLicenses value

Returns:

the next stage of the definition

withApplicationPackages

public DefinitionStages.WithAttach 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 definition

withCertificates

public DefinitionStages.WithAttach withCertificates(List certificates)

Specifies the certificates for compute nodes.

Parameters:

certificates - certificates value

Returns:

the next stage of the definition

withDeploymentConfiguration

public DefinitionStages.WithAttach withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

Specifies the creation of nodes using CloudServiceConfiguration/VirtualMachineConfiguration.

Parameters:

deploymentConfiguration - deploymentConfiguration value

Returns:

the next stage of the definition

withDisplayName

public DefinitionStages.WithAttach withDisplayName(String displayName)

Specifies the display name for the pool.

Parameters:

displayName - displayName value

Returns:

the next stage of the definition

withInterNodeCommunication

public DefinitionStages.WithAttach 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 definition

withMaxTasksPerNode

public DefinitionStages.WithAttach withMaxTasksPerNode(Integer maxTasksPerNode)

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

Parameters:

maxTasksPerNode - maxTasksPerNode value

Returns:

the next stage of the definition

withMetadata

public DefinitionStages.WithAttach withMetadata(List metadata)

Specifies the metadata for the use of user code.

Parameters:

metadata - metadata value

Returns:

the next stage of the definition

withMountConfiguration

public DefinitionStages.WithAttach 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 definition

withNetworkConfiguration

public DefinitionStages.WithAttach withNetworkConfiguration(NetworkConfiguration networkConfiguration)

Specifies the network configuration for the pool.

Parameters:

networkConfiguration - network configuration value

Returns:

the next stage of the definition

withScaleSettings

public DefinitionStages.WithAttach withScaleSettings(ScaleSettings scaleSettings)

Specifies the scale settings for the pool.

Parameters:

scaleSettings - scale settings value

Returns:

the next stage of the definition

withStartTask

public DefinitionStages.WithAttach withStartTask(StartTask startTask)

Specifies the start task for the pool.

Parameters:

startTask - start task value

Returns:

the next stage of the definition

withTaskSchedulingPolicy

public DefinitionStages.WithAttach withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)

Specifies the task scheduling policy.

Parameters:

taskSchedulingPolicy - taskSchedulingPolicy value

Returns:

the next stage of the definition

withTaskSlotsPerNode

public DefinitionStages.WithAttach 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 definition

withUserAccounts

public DefinitionStages.WithAttach withUserAccounts(List userAccounts)

Specifies the user accounts value.

Parameters:

userAccounts - userAccounts value

Returns:

the next stage of the definition

withVmSize

public DefinitionStages.WithAttach withVmSize(String vmSize)

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

Parameters:

vmSize - vmSize value

Returns:

the next stage of the definition

Applies to