Package com.microsoft.azure.management.batchai

Interface BatchAICluster

All Superinterfaces:
HasId, HasInner<com.microsoft.azure.management.batchai.implementation.ClusterInner>, HasManager<com.microsoft.azure.management.batchai.implementation.BatchAIManager>, HasName, Indexable, Refreshable<BatchAICluster>, Updatable<BatchAICluster.Update>
@Beta(V1_6_0) public interface BatchAICluster extends HasInner<com.microsoft.azure.management.batchai.implementation.ClusterInner>, Indexable, HasId, HasName, HasManager<com.microsoft.azure.management.batchai.implementation.BatchAIManager>, Refreshable<BatchAICluster>, Updatable<BatchAICluster.Update>
Entry point for Batch AI cluster management API in Azure.

  • Method Details

    • listRemoteLoginInformation

      com.microsoft.azure.PagedList<RemoteLoginInformation> listRemoteLoginInformation()
      Get the IP address, port of all the compute nodes in the Cluster.
      Returns:
      list of remote login details

    • listRemoteLoginInformationAsync

      rx.Observable<RemoteLoginInformation> listRemoteLoginInformationAsync()
      Get the IP address, port of all the compute nodes in the Cluster.
      Returns:
      an observable that emits remote login information

    • vmSize

      String vmSize()
      All virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
      Returns:
      the size of the virtual machines in the cluster

    • vmPriority

      VmPriority vmPriority()
      The default value is dedicated. The node can get preempted while the task is running if lowpriority is choosen. This is best suited if the workload is checkpointing and can be restarted.
      Returns:
      virtual machine priority status

    • scaleSettings

      ScaleSettings scaleSettings()
      Returns:
      desired scale for the Cluster

    • virtualMachineConfiguration

      VirtualMachineConfiguration virtualMachineConfiguration()
      Returns:
      settings for OS image and mounted data volumes

    • nodeSetup

      NodeSetup nodeSetup()
      Returns:
      setup to be done on all compute nodes in the Cluster

    • adminUserName

      String adminUserName()
      Returns:
      administrator account name for compute nodes.

    • subnet

      ResourceId subnet()
      Returns:
      the identifier of the subnet

    • creationTime

      org.joda.time.DateTime creationTime()
      Returns:
      the creation time of the cluster

    • provisioningState

      ProvisioningState provisioningState()
      Returns:
      the provisioning state of the cluster

    • provisioningStateTransitionTime

      org.joda.time.DateTime provisioningStateTransitionTime()
      Returns:
      the provisioning state transition time of the cluster

    • allocationState

      AllocationState allocationState()
      Indicates whether the cluster is resizing.
      Returns:
      cluster allocation state

    • allocationStateTransitionTime

      org.joda.time.DateTime allocationStateTransitionTime()
      Returns:
      the time at which the cluster entered its current allocation state

    • errors

      List<BatchAIError> errors()
      Returns:
      all the errors encountered by various compute nodes during node setup

    • currentNodeCount

      int currentNodeCount()
      Returns:
      the number of compute nodes currently assigned to the cluster

    • nodeStateCounts

      NodeStateCounts nodeStateCounts()
      Returns:
      counts of various node states on the cluster

    • workspace

      BatchAIWorkspace workspace()
      Returns:
      workspace this cluster belongs to