Virtual Machines - Instance View

Usługa:

Compute

Wersja interfejsu API:

2025-11-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-11-01

Parametry identyfikatora 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 Azure zakończyła się pomyślnie.
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

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

Zakresy

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ładowe żądanie

HTTP

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

Java

/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * 2025-11-01/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get instance view of a virtual machine placed on a dedicated host group through automatic placement.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement(
        com.azure.resourcemanager.compute.ComputeManager manager) {
        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: 2025-11-01/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/v8"
)

// Generated from example definition: 2025-11-01/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 = armcompute.VirtualMachinesClientInstanceViewResponse{
	// 	VirtualMachineInstanceView: &armcompute.VirtualMachineInstanceView{
	// 		ComputerName: to.Ptr("myVM"),
	// 		OSName: to.Ptr("Windows Server 2016 Datacenter"),
	// 		OSVersion: to.Ptr("Microsoft Windows NT 10.0.14393.0"),
	// 		VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 			VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					DisplayStatus: to.Ptr("Ready"),
	// 					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+00:00"); return t}()),
	// 				},
	// 			},
	// 		},
	// 		Disks: []*armcompute.DiskInstanceView{
	// 			{
	// 				Name: to.Ptr("myOsDisk"),
	// 				Statuses: []*armcompute.InstanceViewStatus{
	// 					{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-04-01T21:29:47.477089+00:00"); return t}()),
	// 					},
	// 				},
	// 			},
	// 		},
	// 		HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypeV1),
	// 		AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/succeeded"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-04-01T21:30:12.8051917+00:00"); return t}()),
	// 			},
	// 			{
	// 				Code: to.Ptr("PowerState/running"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				DisplayStatus: to.Ptr("VM running"),
	// 			},
	// 		},
	// 	},
	// }
}

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");

/**
 * 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: 2025-11-01/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.instanceView("myResourceGroup", "myVM");
  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/Compute/stable/2025-11-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 stanu:

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ładowe żądanie

HTTP

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

Java

/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-11-01/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
     */
    /**
     * Sample code: Get Virtual Machine Instance View.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void getVirtualMachineInstanceView(com.azure.resourcemanager.compute.ComputeManager manager) {
        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: 2025-11-01/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/v8"
)

// Generated from example definition: 2025-11-01/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 = armcompute.VirtualMachinesClientInstanceViewResponse{
	// 	VirtualMachineInstanceView: &armcompute.VirtualMachineInstanceView{
	// 		PlatformUpdateDomain: to.Ptr[int32](1),
	// 		PlatformFaultDomain: to.Ptr[int32](1),
	// 		ComputerName: to.Ptr("myVM"),
	// 		OSName: to.Ptr("Windows Server 2016 Datacenter"),
	// 		OSVersion: to.Ptr("Microsoft Windows NT 10.0.14393.0"),
	// 		VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 			VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					DisplayStatus: to.Ptr("Ready"),
	// 					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+00:00"); return t}()),
	// 				},
	// 			},
	// 			ExtensionHandlers: []*armcompute.VirtualMachineExtensionHandlerInstanceView{
	// 				{
	// 					Type: to.Ptr("Microsoft.Azure.Security.IaaSAntimalware"),
	// 					TypeHandlerVersion: to.Ptr("1.5.5.9"),
	// 					Status: &armcompute.InstanceViewStatus{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Ready"),
	// 					},
	// 				},
	// 			},
	// 		},
	// 		Disks: []*armcompute.DiskInstanceView{
	// 			{
	// 				Name: to.Ptr("myOsDisk"),
	// 				Statuses: []*armcompute.InstanceViewStatus{
	// 					{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T21:29:47.477089+00:00"); return t}()),
	// 					},
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("myDataDisk0"),
	// 				Statuses: []*armcompute.InstanceViewStatus{
	// 					{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T21:29:47.461517+00:00"); return t}()),
	// 					},
	// 				},
	// 			},
	// 		},
	// 		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"),
	// 		},
	// 		Extensions: []*armcompute.VirtualMachineExtensionInstanceView{
	// 			{
	// 				Name: to.Ptr("IaaSAntiMalware-ext0"),
	// 				Type: to.Ptr("Microsoft.Azure.Security.IaaSAntimalware"),
	// 				TypeHandlerVersion: to.Ptr("1.5.5.9"),
	// 				Statuses: []*armcompute.InstanceViewStatus{
	// 					{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 						Message: to.Ptr("Microsoft Antimalware enabled"),
	// 					},
	// 				},
	// 			},
	// 		},
	// 		HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypeV1),
	// 		PatchStatus: &armcompute.VirtualMachinePatchStatus{
	// 			AvailablePatchSummary: &armcompute.AvailablePatchSummary{
	// 				Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 				AssessmentActivityID: to.Ptr("68f8b292-dfc2-4646-9781-33cc88631968"),
	// 				RebootPending: to.Ptr(true),
	// 				CriticalAndSecurityPatchCount: to.Ptr[int32](1),
	// 				OtherPatchCount: to.Ptr[int32](2),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.2556154Z"); return t}()),
	// 				LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.2556154Z"); return t}()),
	// 			},
	// 			LastPatchInstallationSummary: &armcompute.LastPatchInstallationSummary{
	// 				Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 				InstallationActivityID: to.Ptr("68f8b292-dfc2-4646-9981-33cc88631968"),
	// 				MaintenanceWindowExceeded: to.Ptr(false),
	// 				NotSelectedPatchCount: to.Ptr[int32](1),
	// 				ExcludedPatchCount: to.Ptr[int32](1),
	// 				PendingPatchCount: to.Ptr[int32](1),
	// 				InstalledPatchCount: to.Ptr[int32](1),
	// 				FailedPatchCount: to.Ptr[int32](1),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.2556154Z"); return t}()),
	// 				LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.2556154Z"); return t}()),
	// 			},
	// 			ConfigurationStatuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("PatchModeConfigurationState/Ready"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					DisplayStatus: to.Ptr("Status_PatchModeConfigurationState_Ready"),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.2556154Z"); return t}()),
	// 				},
	// 				{
	// 					Code: to.Ptr("AssessmentModeConfigurationState/Pending"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					DisplayStatus: to.Ptr("Status_AssessmentModeConfigurationState_Pending"),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.2556154Z"); return t}()),
	// 				},
	// 			},
	// 		},
	// 		IsVMInStandbyPool: to.Ptr(false),
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/succeeded"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T21:30:12.8051917+00:00"); return t}()),
	// 			},
	// 			{
	// 				Code: to.Ptr("PowerState/running"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				DisplayStatus: to.Ptr("VM running"),
	// 			},
	// 		},
	// 	},
	// }
}

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");

/**
 * 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: 2025-11-01/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
 */
async function getVirtualMachineInstanceView() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.instanceView("myResourceGroup", "myVM");
  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/Compute/stable/2025-11-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 stanu:

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 interfejsu API.
ApiErrorBase	Baza błędów interfejsu 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 dysku
DiskInstanceView	Widok wystąpienia dysku.
HyperVGenerationType	Określa typ funkcji HyperVGeneration skojarzony z zasobem
InnerError	Szczegóły błędu wewnętrznego.
InstanceViewStatus	Stan widoku wystąpienia.
KeyVaultKeyReference	Opisuje odniesienie do Key Vault Key
KeyVaultSecretReference	Opisuje odniesienie do Key Vault Secret
LastPatchInstallationSummary	Opisuje właściwości ostatniego zainstalowanego podsumowania poprawki.
MaintenanceOperationResultCodeTypes	Kod wyniku ostatniej operacji konserwacji.
MaintenanceRedeployStatus	Stan operacji konserwacji.
PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress", dopóki operacja nie zostanie ukończona. W tym momencie stanie się to "Unknown", "Failed", "Succeeded" lub "CompletedWithWarnings".
StatusLevelTypes	Kod poziomu.
StorageAlignmentStatus	Określa status wyrównania pamięci dyskowej.
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

Objekt

Błąd interfejsu API.

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

ApiErrorBase

Objekt

Baza błędów interfejsu API.

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

AvailablePatchSummary

Objekt

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. Służy do korelowania między dziennikami CRP i rozszerzeniami.
criticalAndSecurityPatchCount	integer (int32)	Liczba krytycznych lub wykrytych poprawek zabezpieczeń, które zostały wykryte jako dostępne i nie zostały jeszcze zainstalowane.
error	ApiError	Błędy, które wystąpiły podczas wykonywania operacji. Tablica szczegółów zawiera listę.
lastModifiedTime	string (date-time)	Sygnatura czasowa UTC rozpoczęcia operacji.
otherPatchCount	integer (int32)	Liczba wszystkich dostępnych poprawek z wyłączeniem krytycznych i zabezpieczeń.
rebootPending	boolean	Ogólny stan ponownego uruchomienia maszyny wirtualnej. Będzie to prawdą, gdy częściowo zainstalowane poprawki wymagają ponownego uruchomienia do ukończenia instalacji, ale nie wystąpił jeszcze ponowny rozruch.
startTime	string (date-time)	Sygnatura czasowa UTC rozpoczęcia operacji.
status	PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress", dopóki operacja nie zostanie ukończona. W tym momencie stanie się to "Unknown", "Failed", "Succeeded" lub "CompletedWithWarnings".

BootDiagnosticsInstanceView

Objekt

Widok wystąpienia diagnostyki rozruchu maszyny wirtualnej.

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

CloudError

Objekt

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

Nazwa	Typ	Opis
error	ApiError	Błąd interfejsu API.

DiskEncryptionSettings

Objekt

Opisuje ustawienia szyfrowania dysku

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

DiskInstanceView

Objekt

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.
storageAlignmentStatus	StorageAlignmentStatus	Określa status wyrównania pamięci dyskowej.

HyperVGenerationType

Wyliczenie

Określa typ funkcji HyperVGeneration skojarzony z zasobem

Wartość	Opis
V1
V2

InnerError

Objekt

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

Objekt

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

Objekt

Opisuje odniesienie do Key Vault Key

Nazwa	Typ	Opis
keyUrl	string	URL odnosi się do klucza szyfrującego w Key Vault.
sourceVault	SubResource	Względny adres URL Key Vault zawierającego klucz.

KeyVaultSecretReference

Objekt

Opisuje odniesienie do Key Vault Secret

Nazwa	Typ	Opis
secretUrl	string	URL odnosi się do sekretu w Key Vault.
sourceVault	SubResource	Względny adres URL Key Vault zawierający sekret.

LastPatchInstallationSummary

Objekt

Opisuje właściwości ostatniego zainstalowanego podsumowania poprawki.

Nazwa	Typ	Opis
error	ApiError	Błędy, które wystąpiły podczas wykonywania operacji. Tablica szczegółów zawiera listę.
excludedPatchCount	integer (int32)	Liczba wszystkich dostępnych poprawek, ale wykluczonych jawnie przez dopasowanie listy wykluczeń określonej przez klienta.
failedPatchCount	integer (int32)	Liczba poprawek, które nie powiodły się podczas instalacji.
installationActivityId	string	Identyfikator działania operacji, która wygenerowała ten wynik. Służy do korelowania między dziennikami CRP i rozszerzeniami.
installedPatchCount	integer (int32)	Liczba poprawek, które zostały pomyślnie zainstalowane.
lastModifiedTime	string (date-time)	Sygnatura czasowa UTC rozpoczęcia operacji.
maintenanceWindowExceeded	boolean	Opisuje, czy operacja zakończyła się z upływem czasu przed ukończeniem wszystkich zamierzonych akcji
notSelectedPatchCount	integer (int32)	Liczba wszystkich dostępnych poprawek, ale nie zostanie zainstalowana, ponieważ nie pasuje do wpisu klasyfikacji ani listy dołączania.
pendingPatchCount	integer (int32)	Liczba wszystkich dostępnych poprawek, które mają zostać zainstalowane w trakcie operacji instalacji poprawek.
startTime	string (date-time)	Sygnatura czasowa UTC rozpoczęcia operacji.
status	PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress", dopóki operacja nie zostanie ukończona. W tym momencie stanie się to "Unknown", "Failed", "Succeeded" lub "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

Wyliczenie

Kod wyniku ostatniej operacji konserwacji.

Wartość	Opis
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Objekt

Stan operacji konserwacji.

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

PatchOperationStatus

Wyliczenie

Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress", dopóki operacja nie zostanie ukończona. W tym momencie stanie się to "Unknown", "Failed", "Succeeded" lub "CompletedWithWarnings".

Wartość	Opis
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

StatusLevelTypes

Wyliczenie

Kod poziomu.

Wartość	Opis
Info
Warning
Error

StorageAlignmentStatus

Wyliczenie

Określa status wyrównania pamięci dyskowej.

Wartość	Opis
Unaligned	Dysk nie posiada mapowania domeny błędów pamięci pamięci do obliczania domeny błędów. Pojedyncza awaria domeny Storage Fault może dotknąć wszystkie maszyny wirtualne, które odwołują się do tego profilu dysku.
Aligned	Dysk ma mapowanie domeny błędów pamięci masowej, aby obliczyć domenę błędów. Awaria domeny błędów pamięci jest ograniczona do maszyn wirtualnych w jednej Domenie Błędów Obliczeniowych.

SubResource

Objekt

Nazwa	Typ	Opis
id	string	Identyfikator zasobu

VirtualMachineAgentInstanceView

Objekt

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

Objekt

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

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

VirtualMachineExtensionInstanceView

Objekt

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

Objekt

Stan kondycji maszyny wirtualnej.

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

VirtualMachineInstanceView

Objekt

Widok wystąpienia maszyny wirtualnej.

Nazwa	Typ	Opis
assignedHost	string	Identyfikator zasobu dedykowanego hosta, na którym maszyna wirtualna jest przydzielana za pośrednictwem automatycznego umieszczania, gdy maszyna wirtualna jest skojarzona z dedykowaną grupą hostów z włączoną automatyczną umieszczaniem. 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. Azure pozwala też zobaczyć zrzut ekranu maszyny wirtualnej z hipernadzorcy.
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 funkcji HyperVGeneration skojarzony z zasobem
isVMInStandbyPool	boolean	[Funkcja w wersji zapoznawczej] Określa, czy maszyna wirtualna znajduje się obecnie w puli rezerwowej, czy poza nie.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Stan Operacja 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

Objekt

Stan operacji poprawek maszyny wirtualnej.

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