Virtual Machines - Instance View

Dienst:

Compute

API-Version:

2024-03-01

Ruft Informationen zum Laufzeitzustand eines virtuellen Computers ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vmName	path	True	string	Der Name des virtuellen Computers.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineInstanceView	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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.

Beispielanforderung

HTTP

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

Java

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

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

    response = client.virtual_machines.instance_view(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
if __name__ == "__main__":
    main()

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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, "2024-03-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, "2024-03-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, "2024-03-01T23:11:22.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * 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/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.instanceView(resourceGroupName, vmName);
  console.log(result);
}

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

dotnet

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

Beispiel für eine Antwort

Statuscode:

200

{
  "computerName": "myVM",
  "osName": "Windows Server 2016 Datacenter",
  "osVersion": "Microsoft Windows NT 10.0.14393.0",
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.949",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and accepting new configurations.",
        "time": "2024-03-01T23:11:22+00:00"
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2024-03-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": "2024-03-01T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Get Virtual Machine Instance View.

Beispielanforderung

HTTP

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

Java

/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_InstanceView.json
     */
    /**
     * Sample code: Get Virtual Machine Instance View.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualMachineInstanceView(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .instanceViewWithResponse("myResourceGroup", "myVM", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

    response = client.virtual_machines.instance_view(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
if __name__ == "__main__":
    main()

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
func ExampleVirtualMachinesClient_InstanceView_getVirtualMachineInstanceView() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachinesClient().InstanceView(ctx, "myResourceGroup", "myVM", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineInstanceView = armcompute.VirtualMachineInstanceView{
	// 	BootDiagnostics: &armcompute.BootDiagnosticsInstanceView{
	// 		ConsoleScreenshotBlobURI: to.Ptr("https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp"),
	// 		SerialConsoleLogBlobURI: to.Ptr("https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log"),
	// 	},
	// 	ComputerName: to.Ptr("myVM"),
	// 	Disks: []*armcompute.DiskInstanceView{
	// 		{
	// 			Name: to.Ptr("myOsDisk"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T21:29:47.477Z"); return t}()),
	// 			}},
	// 		},
	// 		{
	// 			Name: to.Ptr("myDataDisk0"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T21:29:47.461Z"); return t}()),
	// 			}},
	// 	}},
	// 	HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypeV1),
	// 	IsVMInStandbyPool: to.Ptr(false),
	// 	OSName: to.Ptr("Windows Server 2016 Datacenter"),
	// 	OSVersion: to.Ptr("Microsoft Windows NT 10.0.14393.0"),
	// 	PatchStatus: &armcompute.VirtualMachinePatchStatus{
	// 		AvailablePatchSummary: &armcompute.AvailablePatchSummary{
	// 			AssessmentActivityID: to.Ptr("68f8b292-dfc2-4646-9781-33cc88631968"),
	// 			CriticalAndSecurityPatchCount: to.Ptr[int32](1),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			OtherPatchCount: to.Ptr[int32](2),
	// 			RebootPending: to.Ptr(true),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 		},
	// 		ConfigurationStatuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("PatchModeConfigurationState/Ready"),
	// 				DisplayStatus: to.Ptr("Status_PatchModeConfigurationState_Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			},
	// 			{
	// 				Code: to.Ptr("AssessmentModeConfigurationState/Pending"),
	// 				DisplayStatus: to.Ptr("Status_AssessmentModeConfigurationState_Pending"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 		}},
	// 		LastPatchInstallationSummary: &armcompute.LastPatchInstallationSummary{
	// 			ExcludedPatchCount: to.Ptr[int32](1),
	// 			FailedPatchCount: to.Ptr[int32](1),
	// 			InstallationActivityID: to.Ptr("68f8b292-dfc2-4646-9981-33cc88631968"),
	// 			InstalledPatchCount: to.Ptr[int32](1),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			MaintenanceWindowExceeded: to.Ptr(false),
	// 			NotSelectedPatchCount: to.Ptr[int32](1),
	// 			PendingPatchCount: to.Ptr[int32](1),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 		},
	// 	},
	// 	PlatformFaultDomain: to.Ptr[int32](1),
	// 	PlatformUpdateDomain: to.Ptr[int32](1),
	// 	Statuses: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ProvisioningState/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T21:30:12.805Z"); return t}()),
	// 		},
	// 		{
	// 			Code: to.Ptr("PowerState/running"),
	// 			DisplayStatus: to.Ptr("VM running"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 	}},
	// 	VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 		ExtensionHandlers: []*armcompute.VirtualMachineExtensionHandlerInstanceView{
	// 			{
	// 				Type: to.Ptr("Microsoft.Azure.Security.IaaSAntimalware"),
	// 				Status: &armcompute.InstanceViewStatus{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Ready"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.5.5.9"),
	// 		}},
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/succeeded"),
	// 				DisplayStatus: to.Ptr("Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Message: to.Ptr("GuestAgent is running and accepting new configurations."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T23:11:22.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 	},
	// 	Extensions: []*armcompute.VirtualMachineExtensionInstanceView{
	// 		{
	// 			Name: to.Ptr("IaaSAntiMalware-ext0"),
	// 			Type: to.Ptr("Microsoft.Azure.Security.IaaSAntimalware"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Message: to.Ptr("Microsoft Antimalware enabled"),
	// 			}},
	// 			TypeHandlerVersion: to.Ptr("1.5.5.9"),
	// 	}},
	// }
}

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

JavaScript

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

/**
 * 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/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
 */
async function getVirtualMachineInstanceView() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.instanceView(resourceGroupName, vmName);
  console.log(result);
}

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

dotnet

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
AvailablePatchSummary	Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.
BootDiagnosticsInstanceView	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.
CloudError	Eine Fehlerantwort des Computediensts.
DiskEncryptionSettings	Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Mindest-API-Version: 2015-06-15
DiskInstanceView	Die Datenträgerinformationen des virtuellen Computers.
HyperVGenerationType	Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist.
InnerError	Innere Fehlerdetails.
InstanceViewStatus	Instanzansichtsstatus.
KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels im Key Vault an.
KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Schlüsseltresorschlüssel handelt.
LastPatchInstallationSummary	Die Installationszusammenfassung des neuesten Installationsvorgangs für den virtuellen Computer.
MaintenanceOperationResultCodeTypes	Der letzte Ergebniscode des Wartungsvorgangs.
MaintenanceRedeployStatus	Der Wartungsvorgangsstatus auf dem virtuellen Computer.
PatchOperationStatus	Der Gesamterfolgs- oder Fehlerstatus des Vorgangs. Es bleibt "InProgress" bis zum Abschluss des Vorgangs. An diesem Punkt wird es zu "Unbekannt", "Fehlgeschlagen", "Erfolgreich" oder "CompletedWithWarnings" werden.
StatusLevelTypes	Der Ebenencode.
SubResource	Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält.
VirtualMachineAgentInstanceView	Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.
VirtualMachineExtensionHandlerInstanceView	Die Instanzansicht der Erweiterungshandler für virtuelle Computer.
VirtualMachineExtensionInstanceView	Die Erweiterungsinformationen.
VirtualMachineHealthStatus	Der Integritätsstatus für den virtuellen Computer.
VirtualMachineInstanceView	Die Instanzansicht eines virtuellen Computers.
VirtualMachinePatchStatus	[Vorschaufeature] Der Status von Patchvorgängen für virtuelle Computer.

ApiError

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die API-Fehlerdetails
innererror	InnerError	Interner API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

AvailablePatchSummary

Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.

Name	Typ	Beschreibung
assessmentActivityId	string	Die Aktivitäts-ID des Vorgangs, der dieses Ergebnis erzeugt hat. Es wird verwendet, um in CRP- und Erweiterungsprotokollen zu korrelieren.
criticalAndSecurityPatchCount	integer	Die Anzahl kritischer oder Sicherheitspatches, die als verfügbar erkannt und noch nicht installiert wurden.
error	ApiError	Die Fehler, die während der Ausführung des Vorgangs aufgetreten sind. Das Detailarray enthält die Liste dieser Elemente.
lastModifiedTime	string	Der UTC-Zeitstempel, als der Vorgang begonnen hat.
otherPatchCount	integer	Die Anzahl aller verfügbaren Patches mit Ausnahme kritischer und sicherheitsrelevanter Patches.
rebootPending	boolean	Der allgemeine Neustartstatus der VM. Es trifft zu, wenn teilweise installierte Patches einen Neustart erfordern, um die Installation abzuschließen, aber der Neustart ist noch nicht aufgetreten.
startTime	string	Der UTC-Zeitstempel, als der Vorgang begonnen hat.
status	PatchOperationStatus	Der Gesamterfolgs- oder Fehlerstatus des Vorgangs. Es bleibt "InProgress" bis zum Abschluss des Vorgangs. An diesem Punkt wird es zu "Unbekannt", "Fehlgeschlagen", "Erfolgreich" oder "CompletedWithWarnings" werden.

BootDiagnosticsInstanceView

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.

Name	Typ	Beschreibung
consoleScreenshotBlobUri	string	Der Blob-URI des Konsolenfotos. Hinweis: Dies wird nicht festgelegt, wenn die Startdiagnose derzeit mit verwaltetem Speicher aktiviert ist.
serialConsoleLogBlobUri	string	Der BLOB-Uri der seriellen Konsole. Hinweis: Dies wird nicht festgelegt, wenn die Startdiagnose derzeit mit verwaltetem Speicher aktiviert ist.
status	InstanceViewStatus	Die Statusinformationen zur Startdiagnose für den virtuellen Computer. Hinweis: Es wird nur festgelegt, wenn Fehler beim Aktivieren der Startdiagnose aufgetreten sind.

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

DiskEncryptionSettings

Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an.

Mindest-API-Version: 2015-06-15

Name	Typ	Beschreibung
diskEncryptionKey	KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Schlüsseltresorschlüssel handelt.
enabled	boolean	Gibt an, ob die Datenträgerverschlüsselung auf dem virtuellen Computer aktiviert werden soll.
keyEncryptionKey	KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels im Key Vault an.

DiskInstanceView

Die Datenträgerinformationen des virtuellen Computers.

Name	Typ	Beschreibung
encryptionSettings	DiskEncryptionSettings[]	Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Mindest-API-Version: 2015-06-15
name	string	Der Datenträgername.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.

HyperVGenerationType

Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist.

Name	Typ	Beschreibung
V1	string
V2	string

InnerError

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

InstanceViewStatus

Instanzansichtsstatus.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die kurze lokalisierbare Bezeichnung für den Status.
level	StatusLevelTypes	Der Ebenencode.
message	string	Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.
time	string	Die Uhrzeit des Status.

KeyVaultKeyReference

Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels im Key Vault an.

Name	Typ	Beschreibung
keyUrl	string	Die URL, die auf einen Schlüsselverschlüsselungsschlüssel im Key Vault verweist.
sourceVault	SubResource	Die relative URL des Schlüsseltresors, der den Schlüssel enthält.

KeyVaultSecretReference

Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Schlüsseltresorschlüssel handelt.

Name	Typ	Beschreibung
secretUrl	string	Die URL, die auf einen geheimen Schlüssel in einem Key Vault verweist.
sourceVault	SubResource	Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält.

LastPatchInstallationSummary

Die Installationszusammenfassung des neuesten Installationsvorgangs für den virtuellen Computer.

Name	Typ	Beschreibung
error	ApiError	Die Fehler, die während der Ausführung des Vorgangs aufgetreten sind. Das Detailarray enthält die Liste dieser Elemente.
excludedPatchCount	integer	Die Anzahl aller verfügbaren Patches, aber explizit von einer vom Kunden angegebenen Ausschlussliste ausgeschlossen.
failedPatchCount	integer	Die Anzahl der Patches, bei denen die Installation fehlgeschlagen ist.
installationActivityId	string	Die Aktivitäts-ID des Vorgangs, der dieses Ergebnis erzeugt hat. Es wird verwendet, um in CRP- und Erweiterungsprotokollen zu korrelieren.
installedPatchCount	integer	Die Anzahl der Patches, die erfolgreich installiert wurden.
lastModifiedTime	string	Der UTC-Zeitstempel, als der Vorgang begonnen hat.
maintenanceWindowExceeded	boolean	Beschreibt, ob der Vorgang nicht mehr genügend Zeit hat, bevor er alle beabsichtigten Aktionen abgeschlossen hat.
notSelectedPatchCount	integer	Die Anzahl aller verfügbaren Patches, aber nicht installiert werden, da sie nicht mit einem Eintrag für Klassifizierungen oder Einschlusslisten übereinstimmte.
pendingPatchCount	integer	Die Anzahl aller verfügbaren Patches, die im Verlauf des Patchinstallationsvorgangs installiert werden sollen.
startTime	string	Der UTC-Zeitstempel, als der Vorgang begonnen hat.
status	PatchOperationStatus	Der Gesamterfolgs- oder Fehlerstatus des Vorgangs. Es bleibt "InProgress" bis zum Abschluss des Vorgangs. An diesem Punkt wird es zu "Unbekannt", "Fehlgeschlagen", "Erfolgreich" oder "CompletedWithWarnings" werden.

MaintenanceOperationResultCodeTypes

Der letzte Ergebniscode des Wartungsvorgangs.

Name	Typ	Beschreibung
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Der Wartungsvorgangsstatus auf dem virtuellen Computer.

Name	Typ	Beschreibung
isCustomerInitiatedMaintenanceAllowed	boolean	True, wenn der Kunde Wartungsvorgänge durchführen darf.
lastOperationMessage	string	Die Nachricht, die für den letzten Wartungsvorgang zurückgegeben wurde.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Der letzte Ergebniscode des Wartungsvorgangs.
maintenanceWindowEndTime	string	Endzeit für das Wartungsfenster.
maintenanceWindowStartTime	string	Startzeit für das Wartungsfenster.
preMaintenanceWindowEndTime	string	Endzeit für das Fenster vor der Wartung.
preMaintenanceWindowStartTime	string	Startzeit für das Fenster vor der Wartung.

PatchOperationStatus

Der Gesamterfolgs- oder Fehlerstatus des Vorgangs. Es bleibt "InProgress" bis zum Abschluss des Vorgangs. An diesem Punkt wird es zu "Unbekannt", "Fehlgeschlagen", "Erfolgreich" oder "CompletedWithWarnings" werden.

Name	Typ	Beschreibung
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

StatusLevelTypes

Der Ebenencode.

Name	Typ	Beschreibung
Error	string
Info	string
Warning	string

SubResource

Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält.

Name	Typ	Beschreibung
id	string	Ressourcen-ID

VirtualMachineAgentInstanceView

Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.

Name	Typ	Beschreibung
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Die Instanzansicht der Erweiterungshandler für virtuelle Computer.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
vmAgentVersion	string	Die Vollversion des VM-Agents.

VirtualMachineExtensionHandlerInstanceView

Die Instanzansicht der Erweiterungshandler für virtuelle Computer.

Name	Typ	Beschreibung
status	InstanceViewStatus	Der Erweiterungshandlerstatus.
type	string	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".
typeHandlerVersion	string	Gibt die Version des Skripthandlers an.

VirtualMachineExtensionInstanceView

Die Erweiterungsinformationen.

Name	Typ	Beschreibung
name	string	Der Erweiterungsname des virtuellen Computers.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
substatuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
type	string	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".
typeHandlerVersion	string	Gibt die Version des Skripthandlers an.

VirtualMachineHealthStatus

Der Integritätsstatus für den virtuellen Computer.

Name	Typ	Beschreibung
status	InstanceViewStatus	Die Integritätsstatusinformationen für den virtuellen Computer.

VirtualMachineInstanceView

Die Instanzansicht eines virtuellen Computers.

Name	Typ	Beschreibung
assignedHost	string	Ressourcen-ID des dedizierten Hosts, auf dem der virtuelle Computer über die automatische Platzierung zugewiesen wird, wenn der virtuelle Computer einer dedizierten Hostgruppe zugeordnet ist, für die die automatische Platzierung aktiviert ist. Mindest-API-Version: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.
computerName	string	Der Computername, der dem virtuellen Computer zugewiesen ist.
disks	DiskInstanceView[]	Die Datenträgerinformationen des virtuellen Computers.
extensions	VirtualMachineExtensionInstanceView[]	Die Erweiterungsinformationen.
hyperVGeneration	HyperVGenerationType	Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist.
isVMInStandbyPool	boolean	[Vorschaufeature] Gibt an, ob sich der virtuelle Computer derzeit im Standbypool befindet oder nicht.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Der Wartungsvorgangsstatus auf dem virtuellen Computer.
osName	string	Das Betriebssystem, das auf dem virtuellen Computer ausgeführt wird.
osVersion	string	Die Version des Betriebssystems, das auf dem virtuellen Computer ausgeführt wird.
patchStatus	VirtualMachinePatchStatus	[Vorschaufeature] Der Status von Patchvorgängen für virtuelle Computer.
platformFaultDomain	integer	Gibt die Fehlerdomäne des virtuellen Computers an.
platformUpdateDomain	integer	Gibt die Updatedomäne des virtuellen Computers an.
rdpThumbPrint	string	Fingerabdruck des Remotedesktopzertifikats.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
vmAgent	VirtualMachineAgentInstanceView	Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.
vmHealth	VirtualMachineHealthStatus	Der Integritätsstatus für den virtuellen Computer.

VirtualMachinePatchStatus

[Vorschaufeature] Der Status von Patchvorgängen für virtuelle Computer.

Name	Typ	Beschreibung
availablePatchSummary	AvailablePatchSummary	Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.
configurationStatuses	InstanceViewStatus[]	Der Aktivierungsstatus des angegebenen patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Die Installationszusammenfassung des neuesten Installationsvorgangs für den virtuellen Computer.