VirtualMachineInstanceView interface
The instance view of a virtual machine.
Properties
assigned |
Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. |
boot |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. |
computer |
The computer name assigned to the virtual machine. |
disks | The virtual machine disk information. |
extensions | The extensions information. |
hyper |
Specifies the HyperVGeneration Type associated with a resource |
maintenance |
The Maintenance Operation status on the virtual machine. |
os |
The Operating System running on the virtual machine. |
os |
The version of Operating System running on the virtual machine. |
patch |
The status of virtual machine patch operations. |
platform |
Specifies the fault domain of the virtual machine. |
platform |
Specifies the update domain of the virtual machine. |
rdp |
The Remote desktop certificate thumbprint. |
statuses | The resource status information. |
vm |
The VM Agent running on the virtual machine. |
vm |
The health status for the VM. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
assignedHost
Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.
Minimum api-version: 2020-06-01.
NOTE: This property will not be serialized. It can only be populated by the server.
assignedHost?: string
Property Value
string
bootDiagnostics
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
You can easily view the output of your console log.
Azure also enables you to see a screenshot of the VM from the hypervisor.
bootDiagnostics?: BootDiagnosticsInstanceView
Property Value
computerName
The computer name assigned to the virtual machine.
computerName?: string
Property Value
string
disks
extensions
The extensions information.
extensions?: VirtualMachineExtensionInstanceView[]
Property Value
hyperVGeneration
Specifies the HyperVGeneration Type associated with a resource
hyperVGeneration?: string
Property Value
string
maintenanceRedeployStatus
The Maintenance Operation status on the virtual machine.
maintenanceRedeployStatus?: MaintenanceRedeployStatus
Property Value
osName
The Operating System running on the virtual machine.
osName?: string
Property Value
string
osVersion
The version of Operating System running on the virtual machine.
osVersion?: string
Property Value
string
patchStatus
The status of virtual machine patch operations.
patchStatus?: VirtualMachinePatchStatus
Property Value
platformFaultDomain
Specifies the fault domain of the virtual machine.
platformFaultDomain?: number
Property Value
number
platformUpdateDomain
Specifies the update domain of the virtual machine.
platformUpdateDomain?: number
Property Value
number
rdpThumbPrint
The Remote desktop certificate thumbprint.
rdpThumbPrint?: string
Property Value
string
statuses
The resource status information.
statuses?: InstanceViewStatus[]
Property Value
vmAgent
The VM Agent running on the virtual machine.
vmAgent?: VirtualMachineAgentInstanceView
Property Value
vmHealth
The health status for the VM. NOTE: This property will not be serialized. It can only be populated by the server.
vmHealth?: VirtualMachineHealthStatus