class Azure::BatchAI::Mgmt::V2018_03_01::Models::Cluster

Contains information about a Cluster.

Attributes

allocation_state[RW]

@return [AllocationState] Indicates whether the cluster is resizing. Possible values are: steady and resizing. steady state indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing state indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster. Possible values include: 'steady', 'resizing'

allocation_state_transition_time[RW]

@return [DateTime] The time at which the cluster entered its current allocation state.

creation_time[RW]

@return [DateTime] The creation time of the cluster.

current_node_count[RW]

@return [Integer] The number of compute nodes currently assigned to the cluster.

errors[RW]

@return [Array<BatchAIError>] Contains details of various errors on the cluster including resize and node setup task. This element contains all the errors encountered by various compute nodes during node setup.

node_setup[RW]

@return [NodeSetup] Setup to be done on all compute nodes in the Cluster.

node_state_counts[RW]

@return [NodeStateCounts] Counts of various node states on the cluster.

provisioning_state[RW]

@return [ProvisioningState] Specifies the provisioning state of the cluster. Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted. Possible values include: 'creating', 'succeeded', 'failed', 'deleting'

provisioning_state_transition_time[RW]

@return [DateTime] The provisioning state transition time of the cluster.

scale_settings[RW]

@return [ScaleSettings] Desired scale for the Cluster.

subnet[RW]

@return [ResourceId] Specifies the identifier of the subnet.

user_account_settings[RW]

@return [UserAccountSettings] Settings for user account of compute nodes.

virtual_machine_configuration[RW]

@return [VirtualMachineConfiguration] Settings for OS image and mounted data volumes.

vm_priority[RW]

@return [VmPriority] dedicated or lowpriority. The default value is dedicated. The node can get preempted while the task is running if lowpriority is chosen. This is best suited if the workload is checkpointing and can be restarted. Possible values include: 'dedicated', 'lowpriority'. Default value: 'dedicated' .

vm_size[RW]

@return [String] The size of the virtual machines in the cluster. 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).

Public Class Methods

mapper() click to toggle source

Mapper for Cluster class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2018-03-01/generated/azure_mgmt_batchai/models/cluster.rb, line 96
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Cluster',
    type: {
      name: 'Composite',
      class_name: 'Cluster',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        vm_size: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmSize',
          type: {
            name: 'String'
          }
        },
        vm_priority: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmPriority',
          default_value: 'dedicated',
          type: {
            name: 'Enum',
            module: 'VmPriority'
          }
        },
        scale_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.scaleSettings',
          type: {
            name: 'Composite',
            class_name: 'ScaleSettings'
          }
        },
        virtual_machine_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.virtualMachineConfiguration',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineConfiguration'
          }
        },
        node_setup: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.nodeSetup',
          type: {
            name: 'Composite',
            class_name: 'NodeSetup'
          }
        },
        user_account_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userAccountSettings',
          type: {
            name: 'Composite',
            class_name: 'UserAccountSettings'
          }
        },
        subnet: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.subnet',
          type: {
            name: 'Composite',
            class_name: 'ResourceId'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.creationTime',
          type: {
            name: 'DateTime'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        provisioning_state_transition_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningStateTransitionTime',
          type: {
            name: 'DateTime'
          }
        },
        allocation_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allocationState',
          type: {
            name: 'Enum',
            module: 'AllocationState'
          }
        },
        allocation_state_transition_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allocationStateTransitionTime',
          type: {
            name: 'DateTime'
          }
        },
        errors: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.errors',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'BatchAIErrorElementType',
                type: {
                  name: 'Composite',
                  class_name: 'BatchAIError'
                }
            }
          }
        },
        current_node_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currentNodeCount',
          type: {
            name: 'Number'
          }
        },
        node_state_counts: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.nodeStateCounts',
          type: {
            name: 'Composite',
            class_name: 'NodeStateCounts'
          }
        }
      }
    }
  }
end