Virtual Machine Scale Sets - Get Instance View

Gets the status of a VM scale set instance.

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

URI Parameters

Name In Required Type Description
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

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

InstanceViewStatus

Instance view status.

OrchestrationServiceNames

The name of the service.

OrchestrationServiceState

The current state of the service.

OrchestrationServiceSummary

Summary for an orchestration service of a virtual machine scale set.

StatusLevelTypes

The level code.

VirtualMachineScaleSetInstanceView

The instance view of a virtual machine scale set.

VirtualMachineScaleSetInstanceViewStatusesSummary

Instance view statuses summary for virtual machines of a virtual machine scale set.

VirtualMachineScaleSetVMExtensionsSummary

Extensions summary for virtual machines of a virtual machine scale set.

VirtualMachineStatusCodeCount

The status code and count of the virtual machine scale set instance view status summary.

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.

OrchestrationServiceNames

The name of the service.

Name Type Description
AutomaticRepairs
  • string

OrchestrationServiceState

The current state of the service.

Name Type Description
NotRunning
  • string
Running
  • string
Suspended
  • string

OrchestrationServiceSummary

Summary for an orchestration service of a virtual machine scale set.

Name Type Description
serviceName

The name of the service.

serviceState

The current state of the service.

StatusLevelTypes

The level code.

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

VirtualMachineScaleSetInstanceView

The instance view of a virtual machine scale set.

Name Type Description
extensions

The extensions information.

orchestrationServices

The orchestration services information.

statuses

The resource status information.

virtualMachine

The instance view status summary for the virtual machine scale set.

VirtualMachineScaleSetInstanceViewStatusesSummary

Instance view statuses summary for virtual machines of a virtual machine scale set.

Name Type Description
statusesSummary

The extensions information.

VirtualMachineScaleSetVMExtensionsSummary

Extensions summary for virtual machines of a virtual machine scale set.

Name Type Description
name
  • string

The extension name.

statusesSummary

The extensions information.

VirtualMachineStatusCodeCount

The status code and count of the virtual machine scale set instance view status summary.

Name Type Description
code
  • string

The instance view status code.

count
  • integer

The number of instances having a particular status code.