Virtual Machine Scale Set VMs - Get Instance View

Service:

Compute

API Version:

2026-04-01

Gets the status of a virtual machine from a VM scale set.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView?api-version=2026-04-01

URI Parameters

Name	In	Required	Type	Description
instanceId	path	True	string	The instance ID of the virtual machine.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
vmScaleSetName	path	True	string	The name of the VM scale set.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	VirtualMachineScaleSetVMInstanceView	Azure operation completed successfully.
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.

Get instance view of a virtual machine from a VM scale set that is eligible for and consuming an open capacity reservation.

Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet/virtualMachines/0/instanceView?api-version=2026-04-01

Sample response

Status code:

200

{
  "platformUpdateDomain": 0,
  "platformFaultDomain": 0,
  "rdpThumbPrint": null,
  "vmAgent": {
    "vmAgentVersion": "Unknown",
    "statuses": [
      {
        "code": "ProvisioningState/Unavailable",
        "level": "Warning",
        "displayStatus": "Not Ready",
        "message": "VM status blob is found but not yet populated.",
        "time": "2026-04-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2026-04-01T04:58:58.0882815+00:00"
        }
      ]
    }
  ],
  "extensions": null,
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "bootDiagnostics": null,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": null,
      "time": "2020-06-05T04:59:58.1852966+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running",
      "message": null,
      "time": null
    }
  ]
}

Get instance view of a virtual machine from a VM scale set that is eligible for and consuming an open capacity reservation.

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet/virtualMachines/0/instanceView?api-version=2026-04-01

Sample response

Status code:

200

{
  "platformUpdateDomain": 0,
  "platformFaultDomain": 0,
  "rdpThumbPrint": null,
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.1010",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and processing the extensions.",
        "time": "2026-04-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2026-04-01T04:58:58.0882815+00:00"
        }
      ]
    }
  ],
  "extensions": null,
  "bootDiagnostics": null,
  "capacityReservationType": "Open",
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": null,
      "time": "2026-04-01T04:59:58.1852966+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running",
      "message": null,
      "time": null
    }
  ]
}

Definitions

Name	Description
ApiError	Api error.
ApiErrorBase	Api error base.
BootDiagnosticsInstanceView	The instance view of a virtual machine boot diagnostics.
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.
CloudError	An error response from the Compute service.
DiskEncryptionSettings	Describes a Encryption Settings for a Disk
DiskInstanceView	The instance view of the disk.
HyperVGeneration	The hypervisor generation of the Virtual Machine [V1, V2]
InnerError	Inner error details.
InstanceViewStatus	Instance view status.
InterconnectInstanceView	The Interconnect Block instance view details for a Virtual Machine or Scale Set VM instance.
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.
StorageAlignmentStatus	Specifies the storage alignment status for the disk.
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.
VirtualMachineHealthStatus	The health status of the VM.
VirtualMachineScaleSetVMInstanceView	The instance view of a virtual machine scale set VM.

ApiError

Object

Api error.

Name	Type	Description
code	string	The error code.
details	ApiErrorBase[]	The Api error details
innererror	InnerError	The Api inner error
message	string	The error message.
target	string	The target of the particular error.

ApiErrorBase

Object

Api error base.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the particular error.

BootDiagnosticsInstanceView

Object

The instance view of a virtual machine boot diagnostics.

Name	Type	Description
consoleScreenshotBlobUri	string	The console screenshot blob URI. Note: This will not be set if boot diagnostics is currently enabled with managed storage.
serialConsoleLogBlobUri	string	The serial console log blob Uri. Note: This will not be set if boot diagnostics is currently enabled with managed storage.
status	InstanceViewStatus	The boot diagnostics status information for the VM. Note: It will be set only if there are errors encountered in enabling boot diagnostics.

CapacityReservationType

Enumeration

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.

Value	Description
NotEligible	The virtual machine is not eligible to be implicitly associated with an open capacity reservation and is not explicitly associated with any capacity reservation group, so it will consume capacity from the publicly available capacity.
Targeted	The virtual machine will consume capacity from a specific matching capacity reservation when associated with a capacity reservation group resource of type targeted, but can fall back to consume capacity from the publicly available capacity if there is no capacity available in the targeted reservation.
Open	The virtual machine if eligible will implicitly associate and consume any available capacity from a matching open capacity reservation created or shared in the subscription. Note: The VM should not be explicitly associated with the open capacity reservation group resource containing the matching reservation.
Disabled	The virtual machine has capacity reservation assignment disabled and will not be allowed to implicitly or explicitly associate with any type of capacity reservation.
Block	The virtual machine consumes capacity from a specific matching capacity reservation when associated with a capacity reservation group resource of type block, and will hit capacity failures if there is no available capacity in the block reservation.

CloudError

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

DiskEncryptionSettings

Object

Describes a Encryption Settings for a Disk

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	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	KeyVaultKeyReference	Specifies the location of the key encryption key in Key Vault.

DiskInstanceView

Object

The instance view of the disk.

Name	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15
name	string	The disk name.
statuses	InstanceViewStatus[]	The resource status information.
storageAlignmentStatus	StorageAlignmentStatus	Specifies the storage alignment status for the disk.

HyperVGeneration

Enumeration

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

Value	Description
V1
V2

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

InstanceViewStatus

Object

Instance view status.

Name	Type	Description
code	string	The status code.
displayStatus	string	The short localizable label for the status.
level	StatusLevelTypes	The level code.
message	string	The detailed status message, including for alerts and error messages.
time	string (date-time)	The time of the status.

InterconnectInstanceView

Object

The Interconnect Block instance view details for a Virtual Machine or Scale Set VM instance.

Name	Type	Description
interconnectSubgroupId	string	The ID (GUID) of the Interconnect subgroup in which the Virtual Machine was placed.

KeyVaultKeyReference

Object

Describes a reference to Key Vault Key

Name	Type	Description
keyUrl	string	The URL referencing a key encryption key in Key Vault.
sourceVault	SubResource	The relative URL of the Key Vault containing the key.

KeyVaultSecretReference

Object

Describes a reference to Key Vault Secret

Name	Type	Description
secretUrl	string	The URL referencing a secret in a Key Vault.
sourceVault	SubResource	The relative URL of the Key Vault containing the secret.

MaintenanceOperationResultCodeTypes

Enumeration

The Last Maintenance Operation Result Code.

Value	Description
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Object

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	MaintenanceOperationResultCodeTypes	The Last Maintenance Operation Result Code.
maintenanceWindowEndTime	string (date-time)	End Time for the Maintenance Window.
maintenanceWindowStartTime	string (date-time)	Start Time for the Maintenance Window.
preMaintenanceWindowEndTime	string (date-time)	End Time for the Pre Maintenance Window.
preMaintenanceWindowStartTime	string (date-time)	Start Time for the Pre Maintenance Window.

StatusLevelTypes

Enumeration

The level code.

Value	Description
Info
Warning
Error

StorageAlignmentStatus

Enumeration

Specifies the storage alignment status for the disk.

Value	Description
Unaligned	Disk does not have Storage Fault Domain to Compute Fault Domain mapping. A single Storage Fault Domain failure may impact all VMs that reference this disk profile.
Aligned	Disk has Storage Fault Domain to Compute Fault Domain mapping. Storage Fault Domain failure is contained to VMs in a single Compute Fault Domain.

SubResource

Object

Name	Type	Description
id	string	Resource Id

VirtualMachineAgentInstanceView

Object

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

Name	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	The virtual machine extension handler instance view.
statuses	InstanceViewStatus[]	The resource status information.
vmAgentVersion	string	The VM Agent full version.

VirtualMachineExtensionHandlerInstanceView

Object

The instance view of a virtual machine extension handler.

Name	Type	Description
status	InstanceViewStatus	The extension handler status.
type	string	Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion	string	Specifies the Major.Minor.Patch.Hotfix version of the script handler. Azure platform will deliver the latest Patch.Hotfix version in the Major.Minor series.

VirtualMachineExtensionInstanceView

Object

The instance view of a virtual machine extension.

Name	Type	Description
name	string	The virtual machine extension name.
statuses	InstanceViewStatus[]	The resource status information.
substatuses	InstanceViewStatus[]	The resource status information.
type	string	Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion	string	Specifies the Major.Minor.Patch.Hotfix version of the script handler. Azure platform will deliver the latest Patch.Hotfix version in the Major.Minor series.

VirtualMachineHealthStatus

Object

The health status of the VM.

Name	Type	Description
status	InstanceViewStatus	The health status information for the VM.

VirtualMachineScaleSetVMInstanceView

Object

The instance view of a virtual machine scale set VM.

Name	Type	Description
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.
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.
capacityReservationType	CapacityReservationType	Specifies which type of capacity reservation the virtual machine scale set VM instance 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.
computerName	string	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	DiskInstanceView[]	The disks information.
extensions	VirtualMachineExtensionInstanceView[]	The extensions information.
hyperVGeneration	HyperVGeneration	The hypervisor generation of the Virtual Machine [V1, V2]
interconnectInstanceView	InterconnectInstanceView	The Interconnect runtime view of the Scale Set VM instance. Minimum api-version: 2026-03-01.
maintenanceRedeployStatus	MaintenanceRedeployStatus	The Maintenance Operation status on the virtual machine.
osName	string	The Operating System running on the hybrid machine.
osVersion	string	The version of Operating System running on the hybrid machine.
placementGroupId	string	The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
platformFaultDomain	integer (int32)	The Fault Domain count.
platformUpdateDomain	integer (int32)	The Update Domain count.
rdpThumbPrint	string	The Remote desktop certificate thumbprint.
statuses	InstanceViewStatus[]	The resource status information.
vmAgent	VirtualMachineAgentInstanceView	The VM Agent running on the virtual machine.
vmHealth	VirtualMachineHealthStatus	The health status for the VM.