Cluster Class

Information about a Cluster.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.batchai.models._models_py3.ProxyResource

Cluster

Constructor

Cluster(*, vm_size: Optional[str] = None, vm_priority: Optional[Union[str, azure.mgmt.batchai.models._batch_ai_enums.VmPriority]] = None, scale_settings: Optional[azure.mgmt.batchai.models._models_py3.ScaleSettings] = None, virtual_machine_configuration: Optional[azure.mgmt.batchai.models._models_py3.VirtualMachineConfiguration] = None, node_setup: Optional[azure.mgmt.batchai.models._models_py3.NodeSetup] = None, user_account_settings: Optional[azure.mgmt.batchai.models._models_py3.UserAccountSettings] = None, subnet: Optional[azure.mgmt.batchai.models._models_py3.ResourceId] = None, **kwargs)

Parameters

vm_size

str

Required

The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size.

vm_priority

str or <xref:batch_ai.models.VmPriority>

Required

VM priority of cluster nodes. Possible values include: "dedicated", "lowpriority".

scale_settings

<xref:batch_ai.models.ScaleSettings>

Required

Scale settings of the cluster.

virtual_machine_configuration

<xref:batch_ai.models.VirtualMachineConfiguration>

Required

Virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration.

node_setup

<xref:batch_ai.models.NodeSetup>

Required

Setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster.

user_account_settings

<xref:batch_ai.models.UserAccountSettings>

Required

Administrator user account settings which can be used to SSH to compute nodes.

subnet

<xref:batch_ai.models.ResourceId>

Required

Virtual network subnet resource ID the cluster nodes belong to.

Variables

id

str

The ID of the resource.

name

str

The name of the resource.

type

str

The type of the resource.

creation_time

datetime

The time when the cluster was created.

provisioning_state

str or <xref:batch_ai.models.ProvisioningState>

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

datetime

Time when the provisioning state was changed.

allocation_state

str or <xref:batch_ai.models.AllocationState>

Allocation state of the cluster. Possible values are: steady - 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 - 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

datetime

The time at which the cluster entered its current allocation state.

errors

list[<xref:batch_ai.models.BatchAIError>]

Collection of errors encountered by various compute nodes during node setup.

current_node_count

int

The number of compute nodes currently assigned to the cluster.

node_state_counts

<xref:batch_ai.models.NodeStateCounts>

Counts of various node states on the cluster.