Virtual Machines - Instance View

Tjänst:: Compute

API-version:: 2025-04-01

Hämtar information om körningstillståndet för en virtuell dator.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
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.
vmName	path	True	string	Namnet på den virtuella datorn.
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	VirtualMachineInstanceView	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 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.

Exempelbegäran

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/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/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://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 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

Exempelsvar

Statuskod:: 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.

Exempelbegäran

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/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/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://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 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

Exempelsvar

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

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	bas för API-fel.
AvailablePatchSummary	Beskriver egenskaperna för en virtuell datorinstansvy för tillgänglig korrigeringssammanfattning.
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.
HyperVGenerationType	Anger den HyperVGeneration-typ som är associerad med en resurs
InnerError	Inre felinformation.
InstanceViewStatus	Status för instansvy.
KeyVaultKeyReference	Beskriver en referens till 密钥保管库 nyckel
KeyVaultSecretReference	Beskriver en referens till Key Vault Secret
LastPatchInstallationSummary	Beskriver egenskaperna för den senast installerade korrigeringssammanfattningen.
MaintenanceOperationResultCodeTypes	Resultatkoden för den senaste underhållsåtgärden.
MaintenanceRedeployStatus	Status för underhållsdrift.
PatchOperationStatus	Den övergripande lyckade eller misslyckade statusen för åtgärden. Den förblir "Pågår" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckades", "Lyckades" eller "CompletedWithWarnings".
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.
VirtualMachineInstanceView	Instansvyn för en virtuell dator.
VirtualMachinePatchStatus	Status för korrigeringsåtgärder för virtuella datorer.

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.

AvailablePatchSummary

Objekt

Beskriver egenskaperna för en virtuell datorinstansvy för tillgänglig korrigeringssammanfattning.

Name	Typ	Description
assessmentActivityId	string	Aktivitets-ID:t för den åtgärd som skapade det här resultatet. Den används för att korrelera mellan CRP- och tilläggsloggar.
criticalAndSecurityPatchCount	integer (int32)	Antalet kritiska korrigeringar eller säkerhetskorrigeringar som har identifierats som tillgängliga och ännu inte installerade.
error	ApiError	De fel som påträffades under körningen av åtgärden. Detaljmatrisen innehåller en lista över dem.
lastModifiedTime	string (date-time)	UTC-tidsstämpeln när åtgärden påbörjades.
otherPatchCount	integer (int32)	Antalet tillgängliga korrigeringsfiler exklusive kritiska korrigeringar och säkerhetskorrigeringar.
rebootPending	boolean	Den övergripande omstartsstatusen för den virtuella datorn. Det kommer att vara sant när delvis installerade patchar kräver en omstart för att slutföra installationen men omstarten ännu inte har inträffat.
startTime	string (date-time)	UTC-tidsstämpeln när åtgärden påbörjades.
status	PatchOperationStatus	Den övergripande lyckade eller misslyckade statusen för åtgärden. Den förblir "Pågår" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckades", "Lyckades" eller "CompletedWithWarnings".

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.

HyperVGenerationType

Uppräkning

Anger den HyperVGeneration-typ som är associerad med en resurs

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.

LastPatchInstallationSummary

Objekt

Beskriver egenskaperna för den senast installerade korrigeringssammanfattningen.

Name	Typ	Description
error	ApiError	De fel som påträffades under körningen av åtgärden. Detaljmatrisen innehåller en lista över dem.
excludedPatchCount	integer (int32)	Antalet tillgängliga korrigeringsfiler som uttryckligen utesluts av en kundspecificerad matchning av undantagslistan.
failedPatchCount	integer (int32)	Antalet korrigeringar som inte kunde installeras.
installationActivityId	string	Aktivitets-ID:t för den åtgärd som skapade det här resultatet. Den används för att korrelera mellan CRP- och tilläggsloggar.
installedPatchCount	integer (int32)	Antalet korrigeringar som har installerats.
lastModifiedTime	string (date-time)	UTC-tidsstämpeln när åtgärden påbörjades.
maintenanceWindowExceeded	boolean	Beskriver om åtgärden fick slut på tid innan den slutförde alla avsedda åtgärder
notSelectedPatchCount	integer (int32)	Antalet tillgängliga korrigeringar som inte kommer att installeras eftersom det inte matchar en klassificerings- eller inkluderingslista.
pendingPatchCount	integer (int32)	Antalet tillgängliga korrigeringsfiler som förväntas installeras under installationen av korrigeringsfilen.
startTime	string (date-time)	UTC-tidsstämpeln när åtgärden påbörjades.
status	PatchOperationStatus	Den övergripande lyckade eller misslyckade statusen för åtgärden. Den förblir "Pågår" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckades", "Lyckades" eller "CompletedWithWarnings".

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.

PatchOperationStatus

Uppräkning

Den övergripande lyckade eller misslyckade statusen för åtgärden. Den förblir "Pågår" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckades", "Lyckades" eller "CompletedWithWarnings".

Värde	Description
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

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.

VirtualMachineInstanceView

Objekt

Instansvyn för en virtuell dator.

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	Datornamnet som tilldelats den virtuella datorn.
disks	DiskInstanceView[]	Diskinformation för den virtuella datorn.
extensions	VirtualMachineExtensionInstanceView[]	Information om tilläggen.
hyperVGeneration	HyperVGenerationType	Anger den HyperVGeneration-typ som är associerad med en resurs
isVMInStandbyPool	boolean	[Förhandsgranskningsfunktion] Anger om den virtuella datorn för närvarande är i eller utanför väntelägespoolen.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Status för underhållsåtgärd på den virtuella datorn.
osName	string	Operativsystemet som körs på den virtuella datorn.
osVersion	string	Den version av operativsystemet som körs på den virtuella datorn.
patchStatus	VirtualMachinePatchStatus	[Förhandsgranskningsfunktion] Status för korrigeringsåtgärder för virtuella datorer.
platformFaultDomain	integer (int32)	Anger feldomänen för den virtuella datorn.
platformUpdateDomain	integer (int32)	Anger uppdateringsdomänen för den virtuella datorn.
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.

VirtualMachinePatchStatus

Objekt

Status för korrigeringsåtgärder för virtuella datorer.

Name	Typ	Description
availablePatchSummary	AvailablePatchSummary	Den tillgängliga korrigeringssammanfattningen av den senaste utvärderingsåtgärden för den virtuella datorn.
configurationStatuses	InstanceViewStatus[]	Aktiveringsstatus för den angivna patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Installationssammanfattningen av den senaste installationsåtgärden för den virtuella datorn.

Dela via

Virtual Machines - Instance View

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

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

Exempelbegäran

Exempelsvar

Get Virtual Machine Instance View.

Exempelbegäran

Exempelsvar

Definitioner

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus