Share via

VirtualMachineInstanceView Class

  • Reference

The instance view of a virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

VirtualMachineInstanceView(*, platform_update_domain: int | None = None, platform_fault_domain: int | None = None, computer_name: str | None = None, os_name: str | None = None, os_version: str | None = None, hyper_v_generation: str | _models.HyperVGenerationType | None = None, rdp_thumb_print: str | None = None, vm_agent: _models.VirtualMachineAgentInstanceView | None = None, maintenance_redeploy_status: _models.MaintenanceRedeployStatus | None = None, disks: List[_models.DiskInstanceView] | None = None, extensions: List[_models.VirtualMachineExtensionInstanceView] | None = None, boot_diagnostics: _models.BootDiagnosticsInstanceView | None = None, statuses: List[_models.InstanceViewStatus] | None = None, patch_status: _models.VirtualMachinePatchStatus | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
platform_update_domain
int

Specifies the update domain of the virtual machine.

Default value: None
platform_fault_domain
int

Specifies the fault domain of the virtual machine.

Default value: None
computer_name
str

The computer name assigned to the virtual machine.

Default value: None
os_name
str

The Operating System running on the virtual machine.

Default value: None
os_version
str

The version of Operating System running on the virtual machine.

Default value: None
hyper_v_generation
str or HyperVGenerationType

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

Default value: None
rdp_thumb_print
str

The Remote desktop certificate thumbprint.

Default value: None
vm_agent
VirtualMachineAgentInstanceView

The VM Agent running on the virtual machine.

Default value: None
maintenance_redeploy_status
MaintenanceRedeployStatus

The Maintenance Operation status on the virtual machine.

Default value: None
disks
list[DiskInstanceView]

The virtual machine disk information.

Default value: None
extensions
list[VirtualMachineExtensionInstanceView]

The extensions information.

Default value: None
boot_diagnostics
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.

Default value: None
statuses
list[InstanceViewStatus]

The resource status information.

Default value: None
patch_status
VirtualMachinePatchStatus

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

Default value: None

Variables

Name Description
platform_update_domain
int

Specifies the update domain of the virtual machine.
platform_fault_domain
int

Specifies the fault domain of the virtual machine.
computer_name
str

The computer name assigned to the virtual machine.
os_name
str

The Operating System running on the virtual machine.
os_version
str

The version of Operating System running on the virtual machine.
hyper_v_generation
str or HyperVGenerationType

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

The Remote desktop certificate thumbprint.
vm_agent
VirtualMachineAgentInstanceView

The VM Agent running on the virtual machine.
maintenance_redeploy_status
MaintenanceRedeployStatus

The Maintenance Operation status on the virtual machine.
disks
list[DiskInstanceView]

The virtual machine disk information.
extensions
list[VirtualMachineExtensionInstanceView]

The extensions information.
vm_health
VirtualMachineHealthStatus

The application health status for the VM, provided through Application Health Extension.
boot_diagnostics
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.
assigned_host
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[InstanceViewStatus]

The resource status information.
patch_status
VirtualMachinePatchStatus

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

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