Virtual Machines - Instance View

Retrieves information about the run-time state of a virtual machine.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView?api-version=2018-06-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

vmName
path True
  • string

The name of the virtual machine.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

Definitions

BootDiagnosticsInstanceView

The instance view of a virtual machine boot diagnostics.

DiskEncryptionSettings

Describes a Encryption Settings for a Disk

DiskInstanceView

The instance view of the disk.

InstanceViewStatus

Instance view status.

KeyVaultKeyReference

Describes a reference to Key Vault Key

KeyVaultSecretReference

Describes a reference to Key Vault Secret

MaintenanceOperationResultCodeTypes

The Last Maintenance Operation Result Code.

MaintenanceRedeployStatus

Maintenance Operation Status.

StatusLevelTypes

The level code.

SubResource
VirtualMachineAgentInstanceView

The instance view of the VM Agent running on the virtual machine.

VirtualMachineExtensionHandlerInstanceView

The instance view of a virtual machine extension handler.

VirtualMachineExtensionInstanceView

The instance view of a virtual machine extension.

VirtualMachineInstanceView

The instance view of a virtual machine.

BootDiagnosticsInstanceView

The instance view of a virtual machine boot diagnostics.

Name Type Description
consoleScreenshotBlobUri
  • string

The console screenshot blob URI.

serialConsoleLogBlobUri
  • string

The Linux serial console log blob Uri.

status

The boot diagnostics status information for the VM.

NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.

DiskEncryptionSettings

Describes a Encryption Settings for a Disk

Name Type Description
diskEncryptionKey

Specifies the location of the disk encryption key, which is a Key Vault Secret.

enabled
  • boolean

Specifies whether disk encryption should be enabled on the virtual machine.

keyEncryptionKey

Specifies the location of the key encryption key in Key Vault.

DiskInstanceView

The instance view of the disk.

Name Type Description
encryptionSettings

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

name
  • string

The disk name.

statuses

The resource status information.

InstanceViewStatus

Instance view status.

Name Type Description
code
  • string

The status code.

displayStatus
  • string

The short localizable label for the status.

level

The level code.

message
  • string

The detailed status message, including for alerts and error messages.

time
  • string

The time of the status.

KeyVaultKeyReference

Describes a reference to Key Vault Key

Name Type Description
keyUrl
  • string

The URL referencing a key encryption key in Key Vault.

sourceVault

The relative URL of the Key Vault containing the key.

KeyVaultSecretReference

Describes a reference to Key Vault Secret

Name Type Description
secretUrl
  • string

The URL referencing a secret in a Key Vault.

sourceVault

The relative URL of the Key Vault containing the secret.

MaintenanceOperationResultCodeTypes

The Last Maintenance Operation Result Code.

Name Type Description
MaintenanceAborted
  • string
MaintenanceCompleted
  • string
None
  • string
RetryLater
  • string

MaintenanceRedeployStatus

Maintenance Operation Status.

Name Type Description
isCustomerInitiatedMaintenanceAllowed
  • boolean

True, if customer is allowed to perform Maintenance.

lastOperationMessage
  • string

Message returned for the last Maintenance Operation.

lastOperationResultCode

The Last Maintenance Operation Result Code.

maintenanceWindowEndTime
  • string

End Time for the Maintenance Window.

maintenanceWindowStartTime
  • string

Start Time for the Maintenance Window.

preMaintenanceWindowEndTime
  • string

End Time for the Pre Maintenance Window.

preMaintenanceWindowStartTime
  • string

Start Time for the Pre Maintenance Window.

StatusLevelTypes

The level code.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

SubResource

Name Type Description
id
  • string

Resource Id

VirtualMachineAgentInstanceView

The instance view of the VM Agent running on the virtual machine.

Name Type Description
extensionHandlers

The virtual machine extension handler instance view.

statuses

The resource status information.

vmAgentVersion
  • string

The VM Agent full version.

VirtualMachineExtensionHandlerInstanceView

The instance view of a virtual machine extension handler.

Name Type Description
status

The extension handler status.

type
  • string

Specifies the type of the extension; an example is "CustomScriptExtension".

typeHandlerVersion
  • string

Specifies the version of the script handler.

VirtualMachineExtensionInstanceView

The instance view of a virtual machine extension.

Name Type Description
name
  • string

The virtual machine extension name.

statuses

The resource status information.

substatuses

The resource status information.

type
  • string

Specifies the type of the extension; an example is "CustomScriptExtension".

typeHandlerVersion
  • string

Specifies the version of the script handler.

VirtualMachineInstanceView

The instance view of a virtual machine.

Name Type Description
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
  • string

The computer name assigned to the virtual machine.

disks

The virtual machine disk information.

extensions

The extensions information.

maintenanceRedeployStatus

The Maintenance Operation status on the virtual machine.

osName
  • string

The Operating System running on the virtual machine.

osVersion
  • string

The version of Operating System running on the virtual machine.

platformFaultDomain
  • integer

Specifies the fault domain of the virtual machine.

platformUpdateDomain
  • integer

Specifies the update domain of the virtual machine.

rdpThumbPrint
  • string

The Remote desktop certificate thumbprint.

statuses

The resource status information.

vmAgent

The VM Agent running on the virtual machine.