ComputeInstanceStatus Class

Represents detailed status information about a ComputeInstance object.

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

Initialize a ComputeInstanceStatus object.

Inheritance

builtins.object

ComputeInstanceStatus

Constructor

ComputeInstanceStatus(creation_time, created_by_user_name, created_by_user_id, created_by_user_org, errors, modified_time, state, vm_size)

Parameters

Name	Description
creation_time Required	datetime The instance creation time.
created_by_user_name Required	str Information on the user who created this ComputeInstance compute.
created_by_user_id Required	str Uniquely identifies a user within an organization.
created_by_user_org Required	str Uniquely identifies user Azure Active Directory organization.
errors Required	list A list of error details, if any exist.
modified_time Required	datetime The instance modification time.
state Required	str The current state of this ComputeInstance object.
vm_size Required	str The size of 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.
creation_time Required	datetime The instance creation time.
created_by_user_name Required	str Information on the user who created this ComputeInstance compute.
created_by_user_id Required	str Uniquely identifies a user within an organization.
created_by_user_org Required	str Uniquely identifies user Azure Active Directory organization.
errors Required	list A list of error details, if any exist.
modified_time Required	datetime The instance modification time.
state Required	str The current state of this ComputeInstance object.
vm_size Required	str The size of 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.

Remarks

Initialize a ComputeInstanceStatus object

Methods

deserialize	Convert a JSON object into a ComputeInstanceStatus object.
serialize	Convert this ComputeInstanceStatus object into a JSON serialized dictionary.

deserialize

Convert a JSON object into a ComputeInstanceStatus object.

static deserialize(object_dict)

Parameters

Name	Description
object_dict Required	dict A JSON object to convert to a ComputeInstanceStatus object.

Returns

Type	Description
ComputeInstanceStatus	The ComputeInstanceStatus representation of the provided JSON object.

Exceptions

Type	Description
ComputeTargetException

serialize

Convert this ComputeInstanceStatus object into a JSON serialized dictionary.

serialize()

Returns

Type	Description
dict	The JSON representation of this ComputeInstanceStatus object.

Exceptions

Type	Description
ComputeTargetException