AmlComputeStatus Class

  • Reference

Represents detailed status information about an AmlCompute target.

Use the get_status method of the AmlCompute class to return status information.

Initialize a AmlComputeStatus object.

Inheritance
builtins.object
AmlComputeStatus

Constructor

AmlComputeStatus(allocation_state, allocation_state_transition_time, creation_time, current_node_count, errors, modified_time, node_state_counts, provisioning_state, provisioning_state_transition_time, scale_settings, target_node_count, vm_priority, vm_size)

Parameters

allocation_state
str
Required

A string description of the current allocation state.

allocation_state_transition_time
datetime
Required

The time of the most recent allocation state change.

creation_time
datetime
Required

The cluster creation time.

current_node_count
int
Required

The current number of nodes used by the cluster.

errors
list
Required

A list of error details, if any.

modified_time
datetime
Required

The cluster modification time.

node_state_counts
AmlComputeNodeStateCounts
Required

An object containing counts of the various current node states in the cluster.

provisioning_state
str
Required

The current provisioning state of the cluster.

provisioning_state_transition_time
datetime
Required

The time of the most recent provisioning state change.

scale_settings
ScaleSettings
Required

An object containing the specified scale settings for the cluster.

target_node_count
int
Required

The target number of nodes for by the cluster.

vm_priority
str
Required

The VM priority. Can be "dedicated" (default) or "lowpriority". Low Priority VMs use Azure's excess capacity are cheapter but run the risk of being pre-empted.

vm_size
str
Required

The size of the agent VMs. More details can be found here: https://aka.ms/azureml-vm-details. Note that not all sizes are available in all regions, as detailed in the previous link.

allocation_state
str
Required

A string description of the current allocation state.

allocation_state_transition_time
datetime
Required

The time of the most recent allocation state change.

creation_time
datetime
Required

The cluster creation time.

current_node_count
int
Required

The current number of nodes used by the cluster.

errors
list
Required

A list of error details, if any.

modified_time
datetime
Required

The cluster modification time.

node_state_counts
AmlComputeNodeStateCounts
Required

An object containing counts of the various current node states in the cluster.

provisioning_state
str
Required

The current provisioning state of the cluster.

provisioning_state_transition_time
datetime
Required

The time of the most recent provisioning state change.

scale_settings
ScaleSettings
Required

An object containing the specified scale settings for the cluster.

target_node_count
int
Required

The target number of nodes for by the cluster.

vm_priority
str
Required

The VM priority. Can be "dedicated" (default) or "lowpriority". Low Priority VMs use Azure's excess capacity are cheapter but run the risk of being pre-empted.

vm_size
str
Required

The size of the agent VMs. More details can be found here: https://aka.ms/azureml-vm-details. Note that not all sizes are available in all regions, as detailed in the previous link.

Methods

deserialize

Convert a JSON object into an AmlComputeStatus object.
serialize

Convert this AmlComputeStatus object into a JSON serialized dictionary.

deserialize

Convert a JSON object into an AmlComputeStatus object.

static deserialize(object_dict)

Parameters

object_dict
dict
Required

A JSON object to convert to an AmlComputeStatus object.

Returns

The AmlComputeStatus representation of the provided JSON object.

Return type

AmlComputeStatus

Exceptions

ComputeTargetException

serialize

Convert this AmlComputeStatus object into a JSON serialized dictionary.

serialize()

Returns

The JSON representation of this AmlComputeStatus object.

Return type

dict

Exceptions

ComputeTargetException