Virtual Machines - Instance View

Service:

Compute

API-versie:

2025-04-01

Haalt informatie op over de runtime-status van een virtuele machine.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
vmName	path	True	string	De naam van de virtuele machine.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	VirtualMachineInstanceView	Azure-bewerking is voltooid.
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Get Virtual Machine Instance View.

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

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get instance view of a virtual machine placed on a dedicated host group through automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .instanceViewWithResponse("myResourceGroup", "myVM", 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

Python

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_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_machines.instance_view(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_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

Go

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/ccea12be6cd5e64743499d46f7a9c8b60df52db1/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachinesClient_InstanceView_getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
	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.NewVirtualMachinesClient().InstanceView(ctx, "myResourceGroup", "myVM", 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.VirtualMachineInstanceView = armcompute.VirtualMachineInstanceView{
	// 	AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 	ComputerName: to.Ptr("myVM"),
	// 	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-01T21:29:47.477Z"); return t}()),
	// 			}},
	// 	}},
	// 	HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypeV1),
	// 	OSName: to.Ptr("Windows Server 2016 Datacenter"),
	// 	OSVersion: to.Ptr("Microsoft Windows NT 10.0.14393.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, "2025-04-01T21:30:12.805Z"); 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/succeeded"),
	// 				DisplayStatus: to.Ptr("Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Message: to.Ptr("GuestAgent is running and accepting new configurations."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-04-01T23:11:22.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Retrieves information about the run-time state of a virtual machine.
 *
 * @summary Retrieves information about the run-time state of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.instanceView(resourceGroupName, vmName);
  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

dotnet

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachines_InstanceView" 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://learn.microsoft.com/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 VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineInstanceView result = await virtualMachine.InstanceViewAsync();

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

Voorbeeldrespons

Statuscode:

200

{
  "computerName": "myVM",
  "osName": "Windows Server 2016 Datacenter",
  "osVersion": "Microsoft Windows NT 10.0.14393.0",
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.949",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and accepting new configurations.",
        "time": "2025-04-01T23:11:22+00:00"
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2025-04-01T21:29:47.477089+00:00"
        }
      ]
    }
  ],
  "hyperVGeneration": "V1",
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2025-04-01T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Get Virtual Machine Instance View.

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_InstanceView.json
     */
    /**
     * Sample code: Get Virtual Machine Instance View.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualMachineInstanceView(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .instanceViewWithResponse("myResourceGroup", "myVM", 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

Python

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_get_instance_view.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_machines.instance_view(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.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

Go

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/ccea12be6cd5e64743499d46f7a9c8b60df52db1/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
func ExampleVirtualMachinesClient_InstanceView_getVirtualMachineInstanceView() {
	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.NewVirtualMachinesClient().InstanceView(ctx, "myResourceGroup", "myVM", 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.VirtualMachineInstanceView = armcompute.VirtualMachineInstanceView{
	// 	BootDiagnostics: &armcompute.BootDiagnosticsInstanceView{
	// 		ConsoleScreenshotBlobURI: to.Ptr("https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp"),
	// 		SerialConsoleLogBlobURI: to.Ptr("https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log"),
	// 	},
	// 	ComputerName: to.Ptr("myVM"),
	// 	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, "2019-10-14T21:29:47.477Z"); return t}()),
	// 			}},
	// 		},
	// 		{
	// 			Name: to.Ptr("myDataDisk0"),
	// 			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, "2019-10-14T21:29:47.461Z"); return t}()),
	// 			}},
	// 	}},
	// 	HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypeV1),
	// 	IsVMInStandbyPool: to.Ptr(false),
	// 	OSName: to.Ptr("Windows Server 2016 Datacenter"),
	// 	OSVersion: to.Ptr("Microsoft Windows NT 10.0.14393.0"),
	// 	PatchStatus: &armcompute.VirtualMachinePatchStatus{
	// 		AvailablePatchSummary: &armcompute.AvailablePatchSummary{
	// 			AssessmentActivityID: to.Ptr("68f8b292-dfc2-4646-9781-33cc88631968"),
	// 			CriticalAndSecurityPatchCount: to.Ptr[int32](1),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			OtherPatchCount: to.Ptr[int32](2),
	// 			RebootPending: to.Ptr(true),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 		},
	// 		ConfigurationStatuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("PatchModeConfigurationState/Ready"),
	// 				DisplayStatus: to.Ptr("Status_PatchModeConfigurationState_Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			},
	// 			{
	// 				Code: to.Ptr("AssessmentModeConfigurationState/Pending"),
	// 				DisplayStatus: to.Ptr("Status_AssessmentModeConfigurationState_Pending"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 		}},
	// 		LastPatchInstallationSummary: &armcompute.LastPatchInstallationSummary{
	// 			ExcludedPatchCount: to.Ptr[int32](1),
	// 			FailedPatchCount: to.Ptr[int32](1),
	// 			InstallationActivityID: to.Ptr("68f8b292-dfc2-4646-9981-33cc88631968"),
	// 			InstalledPatchCount: to.Ptr[int32](1),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			MaintenanceWindowExceeded: to.Ptr(false),
	// 			NotSelectedPatchCount: to.Ptr[int32](1),
	// 			PendingPatchCount: to.Ptr[int32](1),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 		},
	// 	},
	// 	PlatformFaultDomain: to.Ptr[int32](1),
	// 	PlatformUpdateDomain: to.Ptr[int32](1),
	// 	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, "2019-10-14T21:30:12.805Z"); return t}()),
	// 		},
	// 		{
	// 			Code: to.Ptr("PowerState/running"),
	// 			DisplayStatus: to.Ptr("VM running"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 	}},
	// 	VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 		ExtensionHandlers: []*armcompute.VirtualMachineExtensionHandlerInstanceView{
	// 			{
	// 				Type: to.Ptr("Microsoft.Azure.Security.IaaSAntimalware"),
	// 				Status: &armcompute.InstanceViewStatus{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Ready"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.5.5.9"),
	// 		}},
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/succeeded"),
	// 				DisplayStatus: to.Ptr("Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Message: to.Ptr("GuestAgent is running and accepting new configurations."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T23:11:22.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 	},
	// 	Extensions: []*armcompute.VirtualMachineExtensionInstanceView{
	// 		{
	// 			Name: to.Ptr("IaaSAntiMalware-ext0"),
	// 			Type: to.Ptr("Microsoft.Azure.Security.IaaSAntimalware"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Message: to.Ptr("Microsoft Antimalware enabled"),
	// 			}},
	// 			TypeHandlerVersion: to.Ptr("1.5.5.9"),
	// 	}},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Retrieves information about the run-time state of a virtual machine.
 *
 * @summary Retrieves information about the run-time state of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
 */
async function getVirtualMachineInstanceView() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.instanceView(resourceGroupName, vmName);
  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

dotnet

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
// this example is just showing the usage of "VirtualMachines_InstanceView" 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://learn.microsoft.com/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 VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineInstanceView result = await virtualMachine.InstanceViewAsync();

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

Voorbeeldrespons

Statuscode:

200

{
  "platformUpdateDomain": 1,
  "platformFaultDomain": 1,
  "computerName": "myVM",
  "osName": "Windows Server 2016 Datacenter",
  "osVersion": "Microsoft Windows NT 10.0.14393.0",
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.949",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and accepting new configurations.",
        "time": "2019-10-14T23:11:22+00:00"
      }
    ],
    "extensionHandlers": [
      {
        "type": "Microsoft.Azure.Security.IaaSAntimalware",
        "typeHandlerVersion": "1.5.5.9",
        "status": {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Ready"
        }
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2019-10-14T21:29:47.477089+00:00"
        }
      ]
    },
    {
      "name": "myDataDisk0",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2019-10-14T21:29:47.461517+00:00"
        }
      ]
    }
  ],
  "bootDiagnostics": {
    "consoleScreenshotBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp",
    "serialConsoleLogBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log"
  },
  "extensions": [
    {
      "name": "IaaSAntiMalware-ext0",
      "type": "Microsoft.Azure.Security.IaaSAntimalware",
      "typeHandlerVersion": "1.5.5.9",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": "Microsoft Antimalware enabled"
        }
      ]
    }
  ],
  "hyperVGeneration": "V1",
  "patchStatus": {
    "availablePatchSummary": {
      "status": "Succeeded",
      "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
      "rebootPending": true,
      "criticalAndSecurityPatchCount": 1,
      "otherPatchCount": 2,
      "startTime": "2020-04-24T21:02:04.2556154Z",
      "lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
      "error": null
    },
    "lastPatchInstallationSummary": {
      "status": "Succeeded",
      "installationActivityId": "68f8b292-dfc2-4646-9981-33cc88631968",
      "maintenanceWindowExceeded": false,
      "notSelectedPatchCount": 1,
      "excludedPatchCount": 1,
      "pendingPatchCount": 1,
      "installedPatchCount": 1,
      "failedPatchCount": 1,
      "startTime": "2020-04-24T21:02:04.2556154Z",
      "lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
      "error": null
    },
    "configurationStatuses": [
      {
        "code": "PatchModeConfigurationState/Ready",
        "level": "Info",
        "displayStatus": "Status_PatchModeConfigurationState_Ready",
        "time": "2020-04-24T21:02:04.2556154Z"
      },
      {
        "code": "AssessmentModeConfigurationState/Pending",
        "level": "Info",
        "displayStatus": "Status_AssessmentModeConfigurationState_Pending",
        "time": "2020-04-24T21:02:04.2556154Z"
      }
    ]
  },
  "isVMInStandbyPool": false,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2019-10-14T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Definities

Name	Description
ApiError	Api-fout.
ApiErrorBase	Api-foutbasis.
AvailablePatchSummary	Beschrijft de eigenschappen van de weergave van een exemplaar van een virtuele machine voor het beschikbare patchoverzicht.
BootDiagnosticsInstanceView	De exemplaarweergave van een diagnostische diagnose bij het opstarten van een virtuele machine.
CloudError	Een foutreactie van de Compute-service.
DiskEncryptionSettings	Beschrijft een versleutelingsinstelling voor een schijf
DiskInstanceView	De instantieweergave van de schijf.
HyperVGenerationType	Hiermee geeft u het HyperVGeneration-type op dat aan een resource is gekoppeld
InnerError	Interne foutdetails.
InstanceViewStatus	Status van exemplaarweergave.
KeyVaultKeyReference	Beschrijft een verwijzing naar Key Vault Key
KeyVaultSecretReference	Beschrijft een verwijzing naar Key Vault-geheim
LastPatchInstallationSummary	Beschrijft de eigenschappen van het overzicht van de laatst geïnstalleerde patch.
MaintenanceOperationResultCodeTypes	De resultaatcode van de laatste onderhoudsbewerking.
MaintenanceRedeployStatus	Status van de onderhoudsoperatie.
PatchOperationStatus	De algehele succes- of mislukkingsstatus van de operatie. Het blijft "InProgress" totdat de bewerking is voltooid. Op dat moment wordt het "Onbekend", "Mislukt", "Geslaagd" of "VoltooidMetWaarschuwingen".
StatusLevelTypes	De niveaucode.
SubResource
VirtualMachineAgentInstanceView	De instantieweergave van de VM-agent die op de virtuele machine wordt uitgevoerd.
VirtualMachineExtensionHandlerInstanceView	De instantieweergave van een voorzetter voor extensies van een virtuele machine.
VirtualMachineExtensionInstanceView	De instantieweergave van een extensie voor een virtuele machine.
VirtualMachineHealthStatus	De gezondheidsstatus van de VM.
VirtualMachineInstanceView	De instantieweergave van een virtuele machine.
VirtualMachinePatchStatus	De status van patchbewerkingen van virtuele machines.

ApiError

Object

Api-fout.

Name	Type	Description
code	string	De foutcode.
details	ApiErrorBase[]	Details van de Api-fout
innererror	InnerError	De innerlijke fout van de Api
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

ApiErrorBase

Object

Api-foutbasis.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

AvailablePatchSummary

Object

Beschrijft de eigenschappen van de weergave van een exemplaar van een virtuele machine voor het beschikbare patchoverzicht.

Name	Type	Description
assessmentActivityId	string	De activiteit-id van de bewerking die dit resultaat heeft opgeleverd. Het wordt gebruikt om te correleren tussen CRP- en extensielogboeken.
criticalAndSecurityPatchCount	integer (int32)	Het aantal kritieke patches of beveiligingspatches dat is gedetecteerd als beschikbaar en nog niet is geïnstalleerd.
error	ApiError	De fouten die zijn opgetreden tijdens de uitvoering van de bewerking. De detailarray bevat de lijst ervan.
lastModifiedTime	string (date-time)	Het UTC-tijdstempel wanneer de bewerking begon.
otherPatchCount	integer (int32)	Het aantal van alle beschikbare patches, met uitzondering van kritieke patches en beveiliging.
rebootPending	boolean	De algehele herstartstatus van de VM. Dit zal het geval zijn wanneer gedeeltelijk geïnstalleerde patches opnieuw moeten worden opgestart om de installatie te voltooien, maar de herstart nog niet heeft plaatsgevonden.
startTime	string (date-time)	Het UTC-tijdstempel wanneer de bewerking begon.
status	PatchOperationStatus	De algehele succes- of mislukkingsstatus van de operatie. Het blijft "InProgress" totdat de bewerking is voltooid. Op dat moment wordt het "Onbekend", "Mislukt", "Geslaagd" of "VoltooidMetWaarschuwingen".

BootDiagnosticsInstanceView

Object

De exemplaarweergave van een diagnostische diagnose bij het opstarten van een virtuele machine.

Name	Type	Description
consoleScreenshotBlobUri	string	De URI van de console-screenshot-blob. Notitie: Dit wordt niet ingesteld als diagnostische opstartdiagnostiek momenteel is ingeschakeld voor beheerde opslag.
serialConsoleLogBlobUri	string	De seriële consolelog-blob Uri. Notitie: Dit wordt niet ingesteld als diagnostische opstartdiagnostiek momenteel is ingeschakeld voor beheerde opslag.
status	InstanceViewStatus	De statusinformatie van de opstartdiagnose voor de VM. Notitie: Het wordt alleen ingesteld als er fouten optreden bij het inschakelen van opstartdiagnose.

CloudError

Object

Een foutreactie van de Compute-service.

Name	Type	Description
error	ApiError	Api-fout.

DiskEncryptionSettings

Object

Beschrijft een versleutelingsinstelling voor een schijf

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Hiermee geeft u de locatie van de schijfversleutelingssleutel, een Sleutelkluisgeheim.
enabled	boolean	Hiermee geeft u op of schijfversleuteling moet worden ingeschakeld op de virtuele machine.
keyEncryptionKey	KeyVaultKeyReference	Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.

DiskInstanceView

Object

De instantieweergave van de schijf.

Name	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf. Minimale API-versie: 2015-06-15
name	string	De naam van de schijf.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.

HyperVGenerationType

Opsomming

Hiermee geeft u het HyperVGeneration-type op dat aan een resource is gekoppeld

Waarde	Description
V1
V2

InnerError

Object

Interne foutdetails.

Name	Type	Description
errordetail	string	De interne foutmelding of uitzonderingsdump.
exceptiontype	string	Het uitzonderingstype.

InstanceViewStatus

Object

Status van exemplaarweergave.

Name	Type	Description
code	string	De statuscode.
displayStatus	string	Het korte lokaliseerbare label voor de status.
level	StatusLevelTypes	De niveaucode.
message	string	Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten.
time	string (date-time)	Het tijdstip van de status.

KeyVaultKeyReference

Object

Beschrijft een verwijzing naar Key Vault Key

Name	Type	Description
keyUrl	string	De URL die verwijst naar een sleutelversleutelingssleutel in Key Vault.
sourceVault	SubResource	De relatieve URL van de sleutelkluis die de sleutel bevat.

KeyVaultSecretReference

Object

Beschrijft een verwijzing naar Key Vault-geheim

Name	Type	Description
secretUrl	string	De URL die verwijst naar een geheim in een Sleutelkluis.
sourceVault	SubResource	De relatieve URL van de sleutelkluis die het geheim bevat.

LastPatchInstallationSummary

Object

Beschrijft de eigenschappen van het overzicht van de laatst geïnstalleerde patch.

Name	Type	Description
error	ApiError	De fouten die zijn opgetreden tijdens de uitvoering van de bewerking. De detailarray bevat de lijst ervan.
excludedPatchCount	integer (int32)	Het aantal beschikbare patches dat overeenkomt met het aantal patches dat expliciet is uitgesloten door een door de klant opgegeven uitsluitingslijst.
failedPatchCount	integer (int32)	Het aantal patches waarvan de installatie is mislukt.
installationActivityId	string	De activiteit-id van de bewerking die dit resultaat heeft opgeleverd. Het wordt gebruikt om te correleren tussen CRP- en extensielogboeken.
installedPatchCount	integer (int32)	Het aantal patches dat met succes is geïnstalleerd.
lastModifiedTime	string (date-time)	Het UTC-tijdstempel wanneer de bewerking begon.
maintenanceWindowExceeded	boolean	Beschrijft of de bewerking te lang was voordat alle beoogde acties waren voltooid
notSelectedPatchCount	integer (int32)	Het aantal van alle beschikbare patches, maar die niet zullen worden geïnstalleerd omdat het niet overeenkwam met een vermelding in een classificatie- of opnamelijst.
pendingPatchCount	integer (int32)	Het aantal beschikbare patches dat naar verwachting zal worden geïnstalleerd in de loop van de patchinstallatie.
startTime	string (date-time)	Het UTC-tijdstempel wanneer de bewerking begon.
status	PatchOperationStatus	De algehele succes- of mislukkingsstatus van de operatie. Het blijft "InProgress" totdat de bewerking is voltooid. Op dat moment wordt het "Onbekend", "Mislukt", "Geslaagd" of "VoltooidMetWaarschuwingen".

MaintenanceOperationResultCodeTypes

Opsomming

De resultaatcode van de laatste onderhoudsbewerking.

Waarde	Description
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Object

Status van de onderhoudsoperatie.

Name	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Waar, als de klant toestemming heeft om onderhoud uit te voeren.
lastOperationMessage	string	Bericht geretourneerd voor de laatste onderhoudsoperatie.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	De resultaatcode van de laatste onderhoudsbewerking.
maintenanceWindowEndTime	string (date-time)	Eindtijd voor het onderhoudsvenster.
maintenanceWindowStartTime	string (date-time)	Begintijd voor het onderhoudsvenster.
preMaintenanceWindowEndTime	string (date-time)	Eindtijd voor het vooronderhoudsvenster.
preMaintenanceWindowStartTime	string (date-time)	Starttijd voor het vooronderhoudsvenster.

PatchOperationStatus

Opsomming

De algehele succes- of mislukkingsstatus van de operatie. Het blijft "InProgress" totdat de bewerking is voltooid. Op dat moment wordt het "Onbekend", "Mislukt", "Geslaagd" of "VoltooidMetWaarschuwingen".

Waarde	Description
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

StatusLevelTypes

Opsomming

De niveaucode.

Waarde	Description
Info
Warning
Error

SubResource

Object

Name	Type	Description
id	string	Resource-id

VirtualMachineAgentInstanceView

Object

De instantieweergave van de VM-agent die op de virtuele machine wordt uitgevoerd.

Name	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	De weergave van de voorzetter van de extensie van de virtuele machine.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
vmAgentVersion	string	De volledige versie van VM Agent.

VirtualMachineExtensionHandlerInstanceView

Object

De instantieweergave van een voorzetter voor extensies van een virtuele machine.

Name	Type	Description
status	InstanceViewStatus	De status van de extensie-handler.
type	string	Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension.
typeHandlerVersion	string	Hiermee geeft u de versie van de scripthandler.

VirtualMachineExtensionInstanceView

Object

De instantieweergave van een extensie voor een virtuele machine.

Name	Type	Description
name	string	De naam van de extensie van de virtuele machine.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
substatuses	InstanceViewStatus[]	De informatie over de resourcestatus.
type	string	Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension.
typeHandlerVersion	string	Hiermee geeft u de versie van de scripthandler.

VirtualMachineHealthStatus

Object

De gezondheidsstatus van de VM.

Name	Type	Description
status	InstanceViewStatus	De statusinformatie voor de VM.

VirtualMachineInstanceView

Object

De instantieweergave van een virtuele machine.

Name	Type	Description
assignedHost	string	Resource-id van de toegewezen host, waarop de virtuele machine wordt toegewezen via automatische plaatsing, wanneer de virtuele machine is gekoppeld aan een toegewezen hostgroep waarvoor automatische plaatsing is ingeschakeld. Minimale API-versie: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor.
computerName	string	De computernaam die aan de virtuele machine is toegewezen.
disks	DiskInstanceView[]	De schijfgegevens van de virtuele machine.
extensions	VirtualMachineExtensionInstanceView[]	De extensies informatie.
hyperVGeneration	HyperVGenerationType	Hiermee geeft u het HyperVGeneration-type op dat aan een resource is gekoppeld
isVMInStandbyPool	boolean	[Voorbeeldfunctie] Hiermee geeft u aan of de VM zich momenteel in of uit de stand-bypool bevindt.
maintenanceRedeployStatus	MaintenanceRedeployStatus	De status van de onderhoudsbewerking op de virtuele machine.
osName	string	Het besturingssysteem dat op de virtuele machine wordt uitgevoerd.
osVersion	string	De versie van het besturingssysteem die op de virtuele machine wordt uitgevoerd.
patchStatus	VirtualMachinePatchStatus	[Voorbeeldfunctie] De status van patchbewerkingen van virtuele machines.
platformFaultDomain	integer (int32)	Hiermee geeft u het foutdomein van de virtuele machine.
platformUpdateDomain	integer (int32)	Hiermee geeft u het updatedomein van de virtuele machine op.
rdpThumbPrint	string	De vingerafdruk van het Remote Desktop-certificaat.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
vmAgent	VirtualMachineAgentInstanceView	De VM-agent die op de virtuele machine wordt uitgevoerd.
vmHealth	VirtualMachineHealthStatus	De status van de VM.

VirtualMachinePatchStatus

Object

De status van patchbewerkingen van virtuele machines.

Name	Type	Description
availablePatchSummary	AvailablePatchSummary	Het overzicht van de beschikbare patch van de meest recente evaluatiebewerking voor de virtuele machine.
configurationStatuses	InstanceViewStatus[]	De activeringsstatus van de opgegeven patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Het installatieoverzicht van de meest recente installatiebewerking voor de virtuele machine.