Virtual Machines - Instance View

Usługa:: Compute

Wersja API:: 2025-04-01

Pobiera informacje o stanie maszyny wirtualnej w czasie wykonywania.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
vmName	path	True	string	Nazwa maszyny wirtualnej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VirtualMachineInstanceView	Operacja platformy Azure została zakończona pomyślnie.
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

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

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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.

Przykładowa prośba

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


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

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

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/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/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

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

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

Przykładowa odpowiedź

Kod statusu:: 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.

Przykładowa prośba

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


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

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

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/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/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

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

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

Przykładowa odpowiedź

Kod statusu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
ApiError	Błąd API.
ApiErrorBase	Baza błędów API.
AvailablePatchSummary	Opisuje właściwości widoku wystąpienia maszyny wirtualnej dla dostępnego podsumowania poprawek.
BootDiagnosticsInstanceView	Widok wystąpienia diagnostyki rozruchu maszyny wirtualnej.
CloudError	Odpowiedź na błąd z usługi obliczeniowej.
DiskEncryptionSettings	Opisuje ustawienia szyfrowania dla dysku
DiskInstanceView	Widok wystąpienia dysku.
HyperVGenerationType	Określa typ HyperVGeneration skojarzony z zasobem
InnerError	Szczegóły błędu wewnętrznego.
InstanceViewStatus	Stan widoku wystąpienia.
KeyVaultKeyReference	Opisuje odwołanie do klucza Key Vault
KeyVaultSecretReference	Opisuje odwołanie do wpisu tajnego usługi Key Vault
LastPatchInstallationSummary	Opisuje właściwości ostatnio zainstalowanego podsumowania poprawek.
MaintenanceOperationResultCodeTypes	Kod wyniku ostatniej operacji konserwacyjnej.
MaintenanceRedeployStatus	Stan operacji konserwacji.
PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje w toku do momentu zakończenia operacji. W tym momencie zmieni się na "Nieznany", "Niepowodzenie", "Powodzenie" lub "CompletedWithWarnings".
StatusLevelTypes	Kod poziomu.
SubResource
VirtualMachineAgentInstanceView	Widok wystąpienia agenta maszyny wirtualnej uruchomionego na maszynie wirtualnej.
VirtualMachineExtensionHandlerInstanceView	Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.
VirtualMachineExtensionInstanceView	Widok wystąpienia rozszerzenia maszyny wirtualnej.
VirtualMachineHealthStatus	Stan kondycji maszyny wirtualnej.
VirtualMachineInstanceView	Widok wystąpienia maszyny wirtualnej.
VirtualMachinePatchStatus	Stan operacji poprawek maszyny wirtualnej.

ApiError

Sprzeciwiać się

Błąd API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Wewnętrzny błąd interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Sprzeciwiać się

Baza błędów API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

AvailablePatchSummary

Sprzeciwiać się

Opisuje właściwości widoku wystąpienia maszyny wirtualnej dla dostępnego podsumowania poprawek.

Nazwa	Typ	Opis
assessmentActivityId	string	Identyfikator działania operacji, która wygenerowała ten wynik. Jest on używany do korelowania dzienników CRP i rozszerzeń.
criticalAndSecurityPatchCount	integer (int32)	Liczba poprawek krytycznych lub poprawek zabezpieczeń, które zostały wykryte jako dostępne i jeszcze nie zainstalowane.
error	ApiError	Błędy, które wystąpiły podczas wykonywania operacji. Tablica details zawiera ich listę.
lastModifiedTime	string (date-time)	Sygnatura czasowa UTC w momencie rozpoczęcia operacji.
otherPatchCount	integer (int32)	Liczba wszystkich dostępnych poprawek z wyłączeniem poprawek krytycznych i zabezpieczeń.
rebootPending	boolean	Ogólny stan ponownego uruchomienia maszyny wirtualnej. Będzie to prawdą, gdy częściowo zainstalowane poprawki wymagają ponownego uruchomienia w celu ukończenia instalacji, ale ponowne uruchomienie jeszcze nie nastąpiło.
startTime	string (date-time)	Sygnatura czasowa UTC w momencie rozpoczęcia operacji.
status	PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje w toku do momentu zakończenia operacji. W tym momencie zmieni się na "Nieznany", "Niepowodzenie", "Powodzenie" lub "CompletedWithWarnings".

BootDiagnosticsInstanceView

Sprzeciwiać się

Widok wystąpienia diagnostyki rozruchu maszyny wirtualnej.

Nazwa	Typ	Opis
consoleScreenshotBlobUri	string	Identyfikator URI obiektu blob zrzutu ekranu konsoli. Nuta: Nie zostanie to ustawione, jeśli diagnostyka rozruchu jest obecnie włączona z magazynem zarządzanym.
serialConsoleLogBlobUri	string	Identyfikator URI obiektu blob dziennika konsoli szeregowej. Nuta: Nie zostanie to ustawione, jeśli diagnostyka rozruchu jest obecnie włączona z magazynem zarządzanym.
status	InstanceViewStatus	Informacje o stanie diagnostyki rozruchu dla maszyny wirtualnej. Nuta: Zostanie on ustawiony tylko wtedy, gdy wystąpią błędy podczas włączania diagnostyki rozruchu.

CloudError

Sprzeciwiać się

Odpowiedź na błąd z usługi obliczeniowej.

Nazwa	Typ	Opis
error	ApiError	Błąd API.

DiskEncryptionSettings

Sprzeciwiać się

Opisuje ustawienia szyfrowania dla dysku

Nazwa	Typ	Opis
diskEncryptionKey	KeyVaultSecretReference	Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym usługi Key Vault.
enabled	boolean	Określa, czy szyfrowanie dysków powinno być włączone na maszynie wirtualnej.
keyEncryptionKey	KeyVaultKeyReference	Określa lokalizację klucza szyfrowania klucza w usłudze Key Vault.

DiskInstanceView

Sprzeciwiać się

Widok wystąpienia dysku.

Nazwa	Typ	Opis
encryptionSettings	DiskEncryptionSettings[]	Określa ustawienia szyfrowania dysku systemu operacyjnego. Minimalna wersja interfejsu API: 2015-06-15
name	string	Nazwa dysku.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.

HyperVGenerationType

Wyliczenie

Określa typ HyperVGeneration skojarzony z zasobem

Wartość	Opis
V1
V2

InnerError

Sprzeciwiać się

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

InstanceViewStatus

Sprzeciwiać się

Stan widoku wystąpienia.

Nazwa	Typ	Opis
code	string	Kod stanu.
displayStatus	string	Krótka etykieta lokalizowalna dla stanu.
level	StatusLevelTypes	Kod poziomu.
message	string	Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach.
time	string (date-time)	Czas stanu.

KeyVaultKeyReference

Sprzeciwiać się

Opisuje odwołanie do klucza Key Vault

Nazwa	Typ	Opis
keyUrl	string	Adres URL odwołujący się do klucza szyfrowania klucza w usłudze Key Vault.
sourceVault	SubResource	Względny adres URL usługi Key Vault zawierający klucz.

KeyVaultSecretReference

Sprzeciwiać się

Opisuje odwołanie do wpisu tajnego usługi Key Vault

Nazwa	Typ	Opis
secretUrl	string	Adres URL odwołujący się do wpisu tajnego w usłudze Key Vault.
sourceVault	SubResource	Względny adres URL usługi Key Vault zawierający wpis tajny.

LastPatchInstallationSummary

Sprzeciwiać się

Opisuje właściwości ostatnio zainstalowanego podsumowania poprawek.

Nazwa	Typ	Opis
error	ApiError	Błędy, które wystąpiły podczas wykonywania operacji. Tablica details zawiera ich listę.
excludedPatchCount	integer (int32)	Liczba wszystkich dostępnych poprawek, ale jawnie wykluczonych przez dopasowanie listy wykluczeń określonej przez klienta.
failedPatchCount	integer (int32)	Liczba poprawek, których instalacja nie powiodła się.
installationActivityId	string	Identyfikator działania operacji, która wygenerowała ten wynik. Jest on używany do korelowania dzienników CRP i rozszerzeń.
installedPatchCount	integer (int32)	Liczba poprawek, które zostały pomyślnie zainstalowane.
lastModifiedTime	string (date-time)	Sygnatura czasowa UTC w momencie rozpoczęcia operacji.
maintenanceWindowExceeded	boolean	Opisuje, czy operacja upłynęła w czasie, zanim została wykonana wszystkie zamierzone akcje
notSelectedPatchCount	integer (int32)	Liczba wszystkich dostępnych poprawek, które nie zostaną zainstalowane, ponieważ nie są zgodne z klasyfikacją lub wpisem na liście włączeń.
pendingPatchCount	integer (int32)	Liczba wszystkich dostępnych poprawek, które mają zostać zainstalowane w trakcie operacji instalacji poprawki.
startTime	string (date-time)	Sygnatura czasowa UTC w momencie rozpoczęcia operacji.
status	PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje w toku do momentu zakończenia operacji. W tym momencie zmieni się na "Nieznany", "Niepowodzenie", "Powodzenie" lub "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

Wyliczenie

Kod wyniku ostatniej operacji konserwacyjnej.

Wartość	Opis
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Sprzeciwiać się

Stan operacji konserwacji.

Nazwa	Typ	Opis
isCustomerInitiatedMaintenanceAllowed	boolean	To prawda, jeśli klient może wykonywać konserwację.
lastOperationMessage	string	Komunikat zwrócony dla ostatniej operacji konserwacyjnej.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Kod wyniku ostatniej operacji konserwacyjnej.
maintenanceWindowEndTime	string (date-time)	Czas zakończenia okna obsługi.
maintenanceWindowStartTime	string (date-time)	Godzina rozpoczęcia okna obsługi.
preMaintenanceWindowEndTime	string (date-time)	Czas zakończenia okna przed konserwacją.
preMaintenanceWindowStartTime	string (date-time)	Czas rozpoczęcia okna przed konserwacją.

PatchOperationStatus

Wyliczenie

Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje w toku do momentu zakończenia operacji. W tym momencie zmieni się na "Nieznany", "Niepowodzenie", "Powodzenie" lub "CompletedWithWarnings".

Wartość	Opis
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

StatusLevelTypes

Wyliczenie

Kod poziomu.

Wartość	Opis
Info
Warning
Error

SubResource

Sprzeciwiać się

Nazwa	Typ	Opis
id	string	Identyfikator zasobu

VirtualMachineAgentInstanceView

Sprzeciwiać się

Widok wystąpienia agenta maszyny wirtualnej uruchomionego na maszynie wirtualnej.

Nazwa	Typ	Opis
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.
vmAgentVersion	string	Pełna wersja agenta maszyny wirtualnej.

VirtualMachineExtensionHandlerInstanceView

Sprzeciwiać się

Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.

Nazwa	Typ	Opis
status	InstanceViewStatus	Stan procedury obsługi rozszerzenia.
type	string	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".
typeHandlerVersion	string	Określa wersję programu obsługi skryptów.

VirtualMachineExtensionInstanceView

Sprzeciwiać się

Widok wystąpienia rozszerzenia maszyny wirtualnej.

Nazwa	Typ	Opis
name	string	Nazwa rozszerzenia maszyny wirtualnej.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.
substatuses	InstanceViewStatus[]	Informacje o stanie zasobu.
type	string	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".
typeHandlerVersion	string	Określa wersję programu obsługi skryptów.

VirtualMachineHealthStatus

Sprzeciwiać się

Stan kondycji maszyny wirtualnej.

Nazwa	Typ	Opis
status	InstanceViewStatus	Informacje o stanie kondycji maszyny wirtualnej.

VirtualMachineInstanceView

Sprzeciwiać się

Widok wystąpienia maszyny wirtualnej.

Nazwa	Typ	Opis
assignedHost	string	Identyfikator zasobu dedykowanego hosta, na którym maszyna wirtualna jest przydzielana za pomocą automatycznego umieszczania, gdy maszyna wirtualna jest skojarzona z dedykowaną grupą hostów, która ma włączone automatyczne umieszczanie. Minimalna wersja interfejsu API: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostyka rozruchu to funkcja debugowania, która umożliwia wyświetlenie danych wyjściowych konsoli i zrzutu ekranu w celu zdiagnozowania stanu maszyny wirtualnej. Możesz łatwo wyświetlić dane wyjściowe dziennika konsoli. Platforma Azure umożliwia również wyświetlanie zrzutu ekranu maszyny wirtualnej z funkcji hypervisor.
computerName	string	Nazwa komputera przypisana do maszyny wirtualnej.
disks	DiskInstanceView[]	Informacje o dysku maszyny wirtualnej.
extensions	VirtualMachineExtensionInstanceView[]	Informacje o rozszerzeniach.
hyperVGeneration	HyperVGenerationType	Określa typ HyperVGeneration skojarzony z zasobem
isVMInStandbyPool	boolean	[Funkcja w wersji zapoznawczej] Określa, czy maszyna wirtualna znajduje się obecnie w puli rezerwowej, czy poza nią.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Stan operacji konserwacji na maszynie wirtualnej.
osName	string	System operacyjny uruchomiony na maszynie wirtualnej.
osVersion	string	Wersja systemu operacyjnego uruchomiona na maszynie wirtualnej.
patchStatus	VirtualMachinePatchStatus	[Funkcja w wersji zapoznawczej] Stan operacji poprawek maszyny wirtualnej.
platformFaultDomain	integer (int32)	Określa domenę błędów maszyny wirtualnej.
platformUpdateDomain	integer (int32)	Określa domenę aktualizacji maszyny wirtualnej.
rdpThumbPrint	string	Odcisk palca certyfikatu pulpitu zdalnego.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.
vmAgent	VirtualMachineAgentInstanceView	Agent maszyny wirtualnej uruchomiony na maszynie wirtualnej.
vmHealth	VirtualMachineHealthStatus	Stan kondycji maszyny wirtualnej.

VirtualMachinePatchStatus

Sprzeciwiać się

Stan operacji poprawek maszyny wirtualnej.

Nazwa	Typ	Opis
availablePatchSummary	AvailablePatchSummary	Dostępne podsumowanie poprawek najnowszej operacji oceny dla maszyny wirtualnej.
configurationStatuses	InstanceViewStatus[]	Stan włączenia określonego patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Podsumowanie instalacji ostatniej operacji instalacji maszyny wirtualnej.

Udostępnij przez

Virtual Machines - Instance View

Parametry URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresów

Przykłady

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

Przykładowa prośba

Przykładowa odpowiedź

Get Virtual Machine Instance View.

Przykładowa prośba

Przykładowa odpowiedź

Definicje

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus