Virtual Machine Scale Set VMs - Get Instance View

Service:

Compute

API Version:

2019-07-01

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

HTTP

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

URI Parameters

Name	In	Required	Type	Description
instanceId	path	True	string	The instance ID of the virtual machine.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vmScaleSetName	path	True	string	The name of the VM scale set.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	VirtualMachineScaleSetVMInstanceView	OK

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

Definitions

Name	Description
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.
DiskEncryptionSettings	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15
DiskInstanceView	The disks information.
InstanceViewStatus	Instance view status.
KeyVaultKeyReference	Specifies the location of the key encryption key in Key Vault.
KeyVaultSecretReference	Specifies the location of the disk encryption key, which is a Key Vault Secret.
MaintenanceOperationResultCodeTypes	The Last Maintenance Operation Result Code.
MaintenanceRedeployStatus	The Maintenance Operation status on the virtual machine.
StatusLevelTypes	The level code.
SubResource	The relative URL of the Key Vault containing the secret.
VirtualMachineAgentInstanceView	The VM Agent running on the virtual machine.
VirtualMachineExtensionHandlerInstanceView	The virtual machine extension handler instance view.
VirtualMachineExtensionInstanceView	The extensions information.
VirtualMachineHealthStatus	The health status for the VM.
VirtualMachineScaleSetVMInstanceView	The instance view of a virtual machine scale set VM.

BootDiagnosticsInstanceView

Object

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.

Name	Type	Description
consoleScreenshotBlobUri	string	The console screenshot blob URI.
serialConsoleLogBlobUri	string	The Linux serial console log blob Uri.
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.

DiskEncryptionSettings

Object

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

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 disks information.

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.

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	The time of the status.

KeyVaultKeyReference

Object

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

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

Specifies the location of the disk encryption key, which is a 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
MaintenanceAborted
MaintenanceCompleted
None
RetryLater

MaintenanceRedeployStatus

Object

The Maintenance Operation status on the virtual machine.

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

Enumeration

The level code.

Value	Description
Error
Info
Warning

SubResource

Object

The relative URL of the Key Vault containing the secret.

Name	Type	Description
id	string	Resource Id

VirtualMachineAgentInstanceView

Object

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 virtual machine extension handler instance view.

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 version of the script handler.

VirtualMachineExtensionInstanceView

Object

The extensions information.

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 version of the script handler.

VirtualMachineHealthStatus

Object

The health status for 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
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.
disks	DiskInstanceView[]	The disks information.
extensions	VirtualMachineExtensionInstanceView[]	The extensions information.
maintenanceRedeployStatus	MaintenanceRedeployStatus	The Maintenance Operation status on the virtual 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	The Fault Domain count.
platformUpdateDomain	integer	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.