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=2024-03-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

VirtualMachineScaleSetInstanceView

OK

Other Status Codes

CloudError

Error response describing why the operation failed.

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

VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen
VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen

VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaa/instanceView?api-version=2024-03-01

Sample Response

{
  "virtualMachine": {
    "statusesSummary": [
      {
        "code": "aa",
        "count": 21
      }
    ]
  },
  "extensions": [
    {
      "name": "aaaaaaaaaaa",
      "statusesSummary": [
        {
          "code": "aa",
          "count": 21
        }
      ]
    }
  ],
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": "aaaaaaaaaaaaaaaaaaaaaaa",
      "time": "2021-11-30T12:58:26.526Z"
    }
  ],
  "orchestrationServices": [
    {
      "serviceName": "AutomaticRepairs",
      "serviceState": "NotRunning"
    }
  ]
}

VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaa/instanceView?api-version=2024-03-01

Sample Response

{}

Definitions

Name Description
ApiError

Api error.

ApiErrorBase

Api error base.

CloudError

An error response from the Compute service.

InnerError

Inner error details.

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.

ApiError

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

Api error base.

Name Type Description
code

string

The error code.

message

string

The error message.

target

string

The target of the particular error.

CloudError

An error response from the Compute service.

Name Type Description
error

ApiError

Api error.

InnerError

Inner error details.

Name Type Description
errordetail

string

The internal error message or exception dump.

exceptiontype

string

The exception type.

InstanceViewStatus

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.

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

OrchestrationServiceNames

The name of the service.

serviceState

OrchestrationServiceState

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

VirtualMachineScaleSetVMExtensionsSummary[]

The extensions information.

orchestrationServices

OrchestrationServiceSummary[]

The orchestration services information.

statuses

InstanceViewStatus[]

The resource status information.

virtualMachine

VirtualMachineScaleSetInstanceViewStatusesSummary

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

VirtualMachineStatusCodeCount[]

The extensions information.

VirtualMachineScaleSetVMExtensionsSummary

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

Name Type Description
name

string

The extension name.

statusesSummary

VirtualMachineStatusCodeCount[]

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.