Share via

VirtualMachineScaleSetVMInstanceView interface

  • Reference
Package:
@azure/arm-compute

The instance view of a virtual machine scale set VM.

Properties

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.
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.
computerName

Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

Max-length (Windows): 15 characters

Max-length (Linux): 64 characters.

For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
disks

The disks information.
extensions

The extensions information.
hyperVGeneration

The hypervisor generation of the Virtual Machine [V1, V2]
maintenanceRedeployStatus

The Maintenance Operation status on the virtual machine.
osName

The Operating System running on the hybrid machine.
osVersion

The version of Operating System running on the hybrid machine.
placementGroupId

The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
platformFaultDomain

The Fault Domain count.
platformUpdateDomain

The Update Domain count.
rdpThumbPrint

The Remote desktop certificate thumbprint.
statuses

The resource status information.
vmAgent

The VM Agent running on the virtual machine.
vmHealth

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

BootDiagnosticsInstanceView

computerName

Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

Max-length (Windows): 15 characters

Max-length (Linux): 64 characters.

For naming conventions and restrictions see Azure infrastructure services implementation guidelines.

computerName?: string

Property Value

string

disks

The disks information.

disks?: DiskInstanceView[]

Property Value

DiskInstanceView[]

extensions

The extensions information.

extensions?: VirtualMachineExtensionInstanceView[]

Property Value

VirtualMachineExtensionInstanceView[]

hyperVGeneration

The hypervisor generation of the Virtual Machine [V1, V2]

hyperVGeneration?: string

Property Value

string

maintenanceRedeployStatus

The Maintenance Operation status on the virtual machine.

maintenanceRedeployStatus?: MaintenanceRedeployStatus

Property Value

MaintenanceRedeployStatus

osName

The Operating System running on the hybrid machine.

osName?: string

Property Value

string

osVersion

The version of Operating System running on the hybrid machine.

osVersion?: string

Property Value

string

placementGroupId

The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.

placementGroupId?: string

Property Value

string

platformFaultDomain

The Fault Domain count.

platformFaultDomain?: number

Property Value

number

platformUpdateDomain

The Update Domain count.

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

InstanceViewStatus[]

vmAgent

The VM Agent running on the virtual machine.

vmAgent?: VirtualMachineAgentInstanceView

Property Value

VirtualMachineAgentInstanceView

vmHealth

The health status for the VM. NOTE: This property will not be serialized. It can only be populated by the server.

vmHealth?: VirtualMachineHealthStatus

Property Value

VirtualMachineHealthStatus