Virtual Machine Scale Set VMs - Get Instance View

Tjänst:: Compute

API-version:: 2025-04-01

Hämtar status för en virtuell dator från en VM-skalningsuppsättning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
instanceId	path	True	string	Instans-ID för den virtuella datorn.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
vmScaleSetName	path	True	string	Namnet på VM-skalningsuppsättningen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	VirtualMachineScaleSetVMInstanceView	Azure-åtgärden har slutförts.
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelbegäran

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


/**
 * Samples for VirtualMachineScaleSetVMs GetInstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through
     * automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement(
            com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs().getInstanceViewWithResponse(
            "myResourceGroup", "myVirtualMachineScaleSet", "0", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_instance_view_auto_placed_on_dedicated_host_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_scale_set_vms.get_instance_view(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachineScaleSetVMsClient_GetInstanceView() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineScaleSetVMsClient().GetInstanceView(ctx, "myResourceGroup", "myVirtualMachineScaleSet", "0", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineScaleSetVMInstanceView = armcompute.VirtualMachineScaleSetVMInstanceView{
	// 	AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 	Disks: []*armcompute.DiskInstanceView{
	// 		{
	// 			Name: to.Ptr("myOSDisk"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-04-01T04:58:58.088Z"); return t}()),
	// 			}},
	// 	}},
	// 	PlatformFaultDomain: to.Ptr[int32](0),
	// 	PlatformUpdateDomain: to.Ptr[int32](0),
	// 	Statuses: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ProvisioningState/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T04:59:58.185Z"); return t}()),
	// 		},
	// 		{
	// 			Code: to.Ptr("PowerState/running"),
	// 			DisplayStatus: to.Ptr("VM running"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 	}},
	// 	VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/Unavailable"),
	// 				DisplayStatus: to.Ptr("Not Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesWarning),
	// 				Message: to.Ptr("VM status blob is found but not yet populated."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-04-01T05:00:32.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("Unknown"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the status of a virtual machine from a VM scale set.
 *
 * @summary Gets the status of a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.getInstanceView(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_GetInstanceView" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmInstanceView result = await virtualMachineScaleSetVm.GetInstanceViewAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

Statuskod:: 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": "2025-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": "2025-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
    }
  ]
}

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	bas för API-fel.
BootDiagnosticsInstanceView	Instansvyn för startdiagnostik för en virtuell dator.
CloudError	Ett felsvar från beräkningstjänsten.
DiskEncryptionSettings	Beskriver en krypteringsinställning för en disk
DiskInstanceView	Instansvyn av disken.
HyperVGeneration	Hypervisor-genereringen av den virtuella datorn [V1, V2]
InnerError	Inre felinformation.
InstanceViewStatus	Status för instansvy.
KeyVaultKeyReference	Beskriver en referens till 密钥保管库 nyckel
KeyVaultSecretReference	Beskriver en referens till Key Vault Secret
MaintenanceOperationResultCodeTypes	Resultatkoden för den senaste underhållsåtgärden.
MaintenanceRedeployStatus	Status för underhållsdrift.
StatusLevelTypes	Nivåkoden.
SubResource
VirtualMachineAgentInstanceView	Instansvyn för VM-agenten som körs på den virtuella datorn.
VirtualMachineExtensionHandlerInstanceView	Instansvyn för en tilläggshanterare för virtuella datorer.
VirtualMachineExtensionInstanceView	Instansvyn för ett tillägg för en virtuell dator.
VirtualMachineHealthStatus	Hälsostatusen för den virtuella datorn.
VirtualMachineScaleSetVMInstanceView	Instansvyn för en virtuell dator i skalningsuppsättningen.

ApiError

Objekt

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Information om API-fel
innererror	InnerError	Det inre API-felet
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Objekt

bas för API-fel.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

BootDiagnosticsInstanceView

Objekt

Instansvyn för startdiagnostik för en virtuell dator.

Name	Typ	Description
consoleScreenshotBlobUri	string	URI:n för konsolens skärmbildsblob. Not: Detta kommer inte att anges om startdiagnostik för närvarande är aktiverat med hanterad lagring.
serialConsoleLogBlobUri	string	URI:n för loggbloben i seriekonsolen. Not: Detta kommer inte att anges om startdiagnostik för närvarande är aktiverat med hanterad lagring.
status	InstanceViewStatus	Statusinformation för startdiagnostik för den virtuella datorn. Not: Den kommer bara att ställas in om det finns fel som påträffas vid aktivering av startdiagnostik.

CloudError

Objekt

Ett felsvar från beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

DiskEncryptionSettings

Objekt

Beskriver en krypteringsinställning för en disk

Name	Typ	Description
diskEncryptionKey	KeyVaultSecretReference	Anger platsen för diskkrypteringsnyckeln, som är en Nyckelvalvshemlighet.
enabled	boolean	Anger om diskkryptering ska aktiveras på den virtuella datorn.
keyEncryptionKey	KeyVaultKeyReference	Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

DiskInstanceView

Objekt

Instansvyn av disken.

Name	Typ	Description
encryptionSettings	DiskEncryptionSettings[]	Anger krypteringsinställningarna för OS-disken. Lägsta API-version: 2015-06-15
name	string	Disknamnet.
statuses	InstanceViewStatus[]	Information om resursstatus.

HyperVGeneration

Uppräkning

Hypervisor-genereringen av den virtuella datorn [V1, V2]

Värde	Description
V1
V2

InnerError

Objekt

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Typen av undantag.

InstanceViewStatus

Objekt

Status för instansvy.

Name	Typ	Description
code	string	Statuskoden.
displayStatus	string	Den korta localizable-etiketten för statusen.
level	StatusLevelTypes	Nivåkoden.
message	string	Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.
time	string (date-time)	Tidpunkten för statusen.

KeyVaultKeyReference

Objekt

Beskriver en referens till 密钥保管库 nyckel

Name	Typ	Description
keyUrl	string	URL:en som refererar till en nyckelkrypteringsnyckel i Key Vault.
sourceVault	SubResource	Den relativa URL:en för nyckelvalvet som innehåller nyckeln.

KeyVaultSecretReference

Objekt

Beskriver en referens till Key Vault Secret

Name	Typ	Description
secretUrl	string	URL:en som refererar till en hemlighet i ett Nyckelvalv.
sourceVault	SubResource	Den relativa URL:en för nyckelvalvet som innehåller hemligheten.

MaintenanceOperationResultCodeTypes

Uppräkning

Resultatkoden för den senaste underhållsåtgärden.

Värde	Description
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Objekt

Status för underhållsdrift.

Name	Typ	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Sant, om kunden har tillåtelse att utföra underhåll.
lastOperationMessage	string	Meddelande returnerat för den senaste underhållsåtgärden.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Resultatkoden för den senaste underhållsåtgärden.
maintenanceWindowEndTime	string (date-time)	Sluttid för underhållsfönstret.
maintenanceWindowStartTime	string (date-time)	Starttid för underhållsfönstret.
preMaintenanceWindowEndTime	string (date-time)	Sluttid för förunderhållsfönstret.
preMaintenanceWindowStartTime	string (date-time)	Starttid för förunderhållsfönstret.

StatusLevelTypes

Uppräkning

Nivåkoden.

Värde	Description
Info
Warning
Error

SubResource

Objekt

Name	Typ	Description
id	string	Resurs-ID

VirtualMachineAgentInstanceView

Objekt

Instansvyn för VM-agenten som körs på den virtuella datorn.

Name	Typ	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Instansvyn för hanteraren av tillägget för den virtuella datorn.
statuses	InstanceViewStatus[]	Information om resursstatus.
vmAgentVersion	string	Den fullständiga versionen av VM-agenten.

VirtualMachineExtensionHandlerInstanceView

Objekt

Instansvyn för en tilläggshanterare för virtuella datorer.

Name	Typ	Description
status	InstanceViewStatus	Status för tilläggshanteraren.
type	string	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".
typeHandlerVersion	string	Anger versionen av skripthanteraren.

VirtualMachineExtensionInstanceView

Objekt

Instansvyn för ett tillägg för en virtuell dator.

Name	Typ	Description
name	string	Namnet på det virtuella datortillägget.
statuses	InstanceViewStatus[]	Information om resursstatus.
substatuses	InstanceViewStatus[]	Information om resursstatus.
type	string	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".
typeHandlerVersion	string	Anger versionen av skripthanteraren.

VirtualMachineHealthStatus

Objekt

Hälsostatusen för den virtuella datorn.

Name	Typ	Description
status	InstanceViewStatus	Information om hälsostatus för den virtuella datorn.

VirtualMachineScaleSetVMInstanceView

Objekt

Instansvyn för en virtuell dator i skalningsuppsättningen.

Name	Typ	Description
assignedHost	string	Resurs-ID för den dedikerade värden, där den virtuella datorn allokeras genom automatisk placering, när den virtuella datorn är associerad med en dedikerad värdgrupp som har automatisk placering aktiverad. Lägsta API-version: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.
computerName	string	Anger värdoperativsystemets namn på den virtuella datorn. Det går inte att uppdatera det här namnet när den virtuella datorn har skapats. maxlängd (Windows): 15 tecken Maxlängd (Linux): 64 tecken. Namngivningskonventioner och begränsningar finns i riktlinjer för implementering av Azure-infrastrukturtjänster.
disks	DiskInstanceView[]	Diskarna information.
extensions	VirtualMachineExtensionInstanceView[]	Information om tilläggen.
hyperVGeneration	HyperVGeneration	Hypervisor-genereringen av den virtuella datorn [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Status för underhållsåtgärd på den virtuella datorn.
osName	string	Operativsystemet som körs på hybriddatorn.
osVersion	string	Den version av operativsystemet som körs på hybriddatorn.
placementGroupId	string	Placeringsgruppen där den virtuella datorn körs. Om den virtuella datorn frigörs kommer den inte att ha någon placementGroupId.
platformFaultDomain	integer (int32)	Antalet feldomäner.
platformUpdateDomain	integer (int32)	Antalet uppdateringsdomäner.
rdpThumbPrint	string	Tumavtryck för fjärrskrivbordscertifikatet.
statuses	InstanceViewStatus[]	Information om resursstatus.
vmAgent	VirtualMachineAgentInstanceView	VM-agenten som körs på den virtuella datorn.
vmHealth	VirtualMachineHealthStatus	Hälsostatusen för den virtuella datorn.