com.microsoft.azure.management.batchai

Interface BatchAICluster.DefinitionStages.WithScaleSettings

All Known Subinterfaces:

BatchAICluster.Definition

Enclosing interface:

BatchAICluster.DefinitionStages

public static interface BatchAICluster.DefinitionStages.WithScaleSettings

Specifies scale settings for the cluster.

Method Summary

Modifier and Type	Method and Description
BatchAICluster.DefinitionStages.WithCreate	withAutoScale(int minimumNodeCount, int maximumNodeCount) If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.
BatchAICluster.DefinitionStages.WithCreate	withAutoScale(int minimumNodeCount, int maximumNodeCount, int initialNodeCount) If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.
BatchAICluster.DefinitionStages.WithCreate	withManualScale(int targetNodeCount) Specifies that cluster should be scaled by manual settings.
BatchAICluster.DefinitionStages.WithCreate	withManualScale(int targetNodeCount, DeallocationOption deallocationOption) Specifies that cluster should be scaled by manual settings.

Method Detail

withAutoScale

BatchAICluster.DefinitionStages.WithCreate withAutoScale(int minimumNodeCount,
                                                         int maximumNodeCount)

If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.

Parameters:

minimumNodeCount - the minimum number of compute nodes the cluster can have

maximumNodeCount - the maximum number of compute nodes the cluster can have

Returns:

the next stage of the definition

withAutoScale

BatchAICluster.DefinitionStages.WithCreate withAutoScale(int minimumNodeCount,
                                                         int maximumNodeCount,
                                                         int initialNodeCount)

If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.

Parameters:

minimumNodeCount - the minimum number of compute nodes the cluster can have

maximumNodeCount - the maximum number of compute nodes the cluster can have

initialNodeCount - the number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation.

Returns:

the next stage of the definition

withManualScale

BatchAICluster.DefinitionStages.WithCreate withManualScale(int targetNodeCount)

Specifies that cluster should be scaled by manual settings.

Parameters:

targetNodeCount - the desired number of compute nodes in the Cluster

Returns:

the next stage of the definition

withManualScale

BatchAICluster.DefinitionStages.WithCreate withManualScale(int targetNodeCount,
                                                           DeallocationOption deallocationOption)

Specifies that cluster should be scaled by manual settings.

Parameters:

targetNodeCount - the desired number of compute nodes in the Cluster

deallocationOption - determines what to do with the job(s) running on compute node if the cluster size is decreasing. The default value is requeue.

Returns:

the next stage of the definition