VirtualMachineInstanceView Class

The instance view of a virtual machine.

Constructor

VirtualMachineInstanceView()

Variables

Name Description
platformUpdateDomain
int

Specifies the update domain of the virtual machine.

platformFaultDomain
int

Specifies the fault domain of the virtual machine.

computerName
str

The computer name assigned to the virtual machine.

osName
str

The Operating System running on the virtual machine.

osVersion
str

The version of Operating System running on the virtual machine.

hyperVGeneration
Union[str, <xref:"HyperVGenerationType">]

Specifies the HyperVGeneration Type associated with a resource. Known values are: "V1" and "V2".

rdpThumbPrint
str

The Remote desktop certificate thumbprint.

vmAgent
<xref:<xref:"VirtualMachineAgentInstanceView">>

The VM Agent running on the virtual machine.

maintenanceRedeployStatus
<xref:<xref:"MaintenanceRedeployStatus">>

The Maintenance Operation status on the virtual machine.

disks
list[<xref:"DiskInstanceView">]

The virtual machine disk information.

extensions
list[<xref:"VirtualMachineExtensionInstanceView">]

The extensions information.

vmHealth
<xref:<xref:"VirtualMachineHealthStatus">>

The health status for the VM.

bootDiagnostics
<xref:<xref:"BootDiagnosticsInstanceView">>

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.

assignedHost
str

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.

statuses
list[<xref:"InstanceViewStatus">]

The resource status information.

patchStatus
<xref:<xref:"VirtualMachinePatchStatus">>

[Preview Feature] The status of virtual machine patch operations.

isVMInStandbyPool

[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool.

interconnectInstanceView
<xref:<xref:"InterconnectInstanceView">>

The Interconnect runtime view of the Virtual Machine. Minimum api-version: 2026-03-01.

capacityReservationType
Union[str, <xref:"CapacityReservationType">]

Specifies which type of capacity reservation the virtual machine will consume capacity from if eligible or whether it is explicitly opted out from being associated and consuming capacity from any reserved capacity available in the subscription. Minimum api-version: 2026-04-01. Known values are: "NotEligible", "Targeted", "Open", "Disabled", and "Block".

Attributes

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.

assignedHost: str

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

capacityReservationType

Specifies which type of capacity reservation the virtual machine will consume capacity from if eligible or whether it is explicitly opted out from being associated and consuming capacity from any reserved capacity available in the subscription. Minimum api-version: 2026-04-01. Known values are: "NotEligible", "Targeted", "Open", "Disabled", and "Block".

capacityReservationType: str | CapacityReservationType

computerName

The computer name assigned to the virtual machine.

computerName: str

disks

The virtual machine disk information.

disks: list['DiskInstanceView']

extensions

The extensions information.

extensions: list['VirtualMachineExtensionInstanceView']

hyperVGeneration

"V1" and "V2".

hyperVGeneration: str | HyperVGenerationType

interconnectInstanceView

2026-03-01.

interconnectInstanceView: InterconnectInstanceView

isVMInStandbyPool

[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool.

isVMInStandbyPool: bool

maintenanceRedeployStatus

The Maintenance Operation status on the virtual machine.

maintenanceRedeployStatus: MaintenanceRedeployStatus

osName

The Operating System running on the virtual machine.

osName: str

osVersion

The version of Operating System running on the virtual machine.

osVersion: str

patchStatus

[Preview Feature] The status of virtual machine patch operations.

patchStatus: VirtualMachinePatchStatus

platformFaultDomain

Specifies the fault domain of the virtual machine.

platformFaultDomain: int

platformUpdateDomain

Specifies the update domain of the virtual machine.

platformUpdateDomain: int

rdpThumbPrint

The Remote desktop certificate thumbprint.

rdpThumbPrint: str

statuses

The resource status information.

statuses: list['InstanceViewStatus']

vmAgent

The VM Agent running on the virtual machine.

vmAgent: VirtualMachineAgentInstanceView

vmHealth

The health status for the VM.

vmHealth: VirtualMachineHealthStatus