Developer Documentation

VMSummary

The VM.Summary structure contains commonly used information about a virtual machine.


Properties

Required Property Name Type Description
optional cpu_count integer

Number of CPU cores. This field will be unset if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

optional memory_size_MiB integer

Memory size in mebibytes. This field will be unset if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

required name string

Name of the Virtual machine.

required power_state PowerState Enum

Power state of the virtual machine.

required vm string

Identifier of the virtual machine. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine.

Feedback

Was this page helpful?