Package version:

Interface VirtualMachineInstanceView

The instance view of a virtual machine.

interface VirtualMachineInstanceView {
    assignedHost?: string;
    bootDiagnostics?: BootDiagnosticsInstanceView;
    computerName?: string;
    disks?: DiskInstanceView[];
    extensions?: VirtualMachineExtensionInstanceView[];
    hyperVGeneration?: string;
    isVMInStandbyPool?: boolean;
    maintenanceRedeployStatus?: MaintenanceRedeployStatus;
    osName?: string;
    osVersion?: string;
    patchStatus?: VirtualMachinePatchStatus;
    platformFaultDomain?: number;
    platformUpdateDomain?: number;
    rdpThumbPrint?: string;
    statuses?: InstanceViewStatus[];
    vmAgent?: VirtualMachineAgentInstanceView;
    vmHealth?: VirtualMachineHealthStatus;
}

Properties

assignedHost? bootDiagnostics? computerName? disks? extensions? hyperVGeneration? isVMInStandbyPool? maintenanceRedeployStatus? osName? osVersion? patchStatus? platformFaultDomain? platformUpdateDomain? rdpThumbPrint? statuses? vmAgent? vmHealth?

Properties

Optional ReadonlyassignedHost

assignedHost?: string

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.

OptionalbootDiagnostics

bootDiagnostics?: 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.

OptionalcomputerName

computerName?: string

The computer name assigned to the virtual machine.

Optionaldisks

disks?: DiskInstanceView[]

The virtual machine disk information.

Optionalextensions

extensions?: VirtualMachineExtensionInstanceView[]

The extensions information.

OptionalhyperVGeneration

hyperVGeneration?: string

Specifies the HyperVGeneration Type associated with a resource

Optional ReadonlyisVMInStandbyPool

isVMInStandbyPool?: boolean

[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalmaintenanceRedeployStatus

maintenanceRedeployStatus?: MaintenanceRedeployStatus

The Maintenance Operation status on the virtual machine.

OptionalosName

osName?: string

The Operating System running on the virtual machine.

OptionalosVersion

osVersion?: string

The version of Operating System running on the virtual machine.

OptionalpatchStatus

patchStatus?: VirtualMachinePatchStatus

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

OptionalplatformFaultDomain

platformFaultDomain?: number

Specifies the fault domain of the virtual machine.

OptionalplatformUpdateDomain

platformUpdateDomain?: number

Specifies the update domain of the virtual machine.

OptionalrdpThumbPrint

rdpThumbPrint?: string

The Remote desktop certificate thumbprint.

Optionalstatuses

statuses?: InstanceViewStatus[]

The resource status information.

OptionalvmAgent

vmAgent?: VirtualMachineAgentInstanceView

The VM Agent running on the virtual machine.

Optional ReadonlyvmHealth

vmHealth?: VirtualMachineHealthStatus

The application health status for the VM, provided through Application Health Extension. NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility