Virtual Machines - Instance View

Referencia

Szolgáltatás:: Compute

API-verzió:: 2024-07-01

Egy virtuális gép futásidejű állapotával kapcsolatos információkat kér le.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
vmName	path	True	string	A virtuális gép neve.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	VirtualMachineInstanceView	OKÉ
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

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.

Mintakérelem

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


/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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/2024-07-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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-07-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-07-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-07-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/2024-07-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/2024-07-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

Mintaválasz

Állapotkód:: 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-07-01T23:11:22+00:00"
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2024-07-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-07-01T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Get Virtual Machine Instance View.

Mintakérelem

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


/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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/2024-07-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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/2024-07-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/2024-07-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

Mintaválasz

Állapotkód:: 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"
    }
  ]
}

Definíciók

Name	Description
ApiError	Api-hiba.
ApiErrorBase	Api-hibabázis.
AvailablePatchSummary	A virtuális gép legújabb értékelési műveletének elérhető javítás-összefoglalása.
BootDiagnosticsInstanceView	A rendszerindítási diagnosztika egy hibakeresési funkció, amely lehetővé teszi a konzol kimenetének és képernyőképének megtekintését a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.
CloudError	Hibaválasz a Compute szolgáltatástól.
DiskEncryptionSettings	Megadja az operációsrendszer-lemez titkosítási beállításait. Minimális API-verzió: 2015-06-15
DiskInstanceView	A virtuális gép lemezadatai.
HyperVGenerationType	Az erőforráshoz társított HyperVGeneration-típust adja meg
InnerError	Belső hiba részletei.
InstanceViewStatus	Példánynézet állapota.
KeyVaultKeyReference	Megadja a kulcstitkosítási kulcs helyét a Key Vaultban.
KeyVaultSecretReference	Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault-titkos kulcs.
LastPatchInstallationSummary	A virtuális gép legújabb telepítési műveletének telepítési összefoglalása.
MaintenanceOperationResultCodeTypes	Az utolsó karbantartási művelet eredménykódja.
MaintenanceRedeployStatus	A karbantartási művelet állapota a virtuális gépen.
PatchOperationStatus	A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig az "InProgress" marad. Ekkor "Ismeretlen", "Sikertelen", "Sikeres" vagy "CompletedWithWarnings" lesz.
StatusLevelTypes	A szintkód.
SubResource	A titkos kulcsot tartalmazó Key Vault relatív URL-címe.
VirtualMachineAgentInstanceView	A virtuális gépen futó virtuálisgép-ügynök.
VirtualMachineExtensionHandlerInstanceView	A virtuálisgép-bővítménykezelő példánynézete.
VirtualMachineExtensionInstanceView	A bővítmények adatai.
VirtualMachineHealthStatus	A virtuális gép állapotának állapota.
VirtualMachineInstanceView	Egy virtuális gép példánynézete.
VirtualMachinePatchStatus	[Előzetes verziójú funkció] A virtuális gépek javításműveleteinek állapota.

ApiError

Objektum

Api-hiba.

Name	Típus	Description
code	string	A hibakód.
details	ApiErrorBase[]	Az API-hiba részletei
innererror	InnerError	Az Api belső hibája
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

ApiErrorBase

Objektum

Api-hibabázis.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

AvailablePatchSummary

Objektum

A virtuális gép legújabb értékelési műveletének elérhető javítás-összefoglalása.

Name	Típus	Description
assessmentActivityId	string	Az eredményt eredményező művelet tevékenységazonosítója. A CRP és a bővítménynaplók közötti korrelációra szolgál.
criticalAndSecurityPatchCount	integer (int32)	Az elérhetőként észlelt és még nem telepített kritikus vagy biztonsági javítások száma.
error	ApiError	A művelet végrehajtása során észlelt hibák. A részletek tömbje tartalmazza azokat.
lastModifiedTime	string (date-time)	A művelet kezdetének UTC időbélyege.
otherPatchCount	integer (int32)	Az összes elérhető javítás száma, kivéve a kritikus és a biztonsági elemet.
rebootPending	boolean	A virtuális gép általános újraindítási állapota. Ez akkor lesz igaz, ha a részben telepített javítások újraindítást igényelnek a telepítés befejezéséhez, de az újraindítás még nem történt meg.
startTime	string (date-time)	A művelet kezdetének UTC időbélyege.
status	PatchOperationStatus	A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig az "InProgress" marad. Ekkor "Ismeretlen", "Sikertelen", "Sikeres" vagy "CompletedWithWarnings" lesz.

BootDiagnosticsInstanceView

Objektum

A rendszerindítási diagnosztika egy hibakeresési funkció, amely lehetővé teszi a konzol kimenetének és képernyőképének megtekintését a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.

Name	Típus	Description
consoleScreenshotBlobUri	string	A konzol képernyőképe blob URI-ja. Megjegyzés: Ez nem beállítva, ha a rendszerindítási diagnosztika jelenleg engedélyezve van a felügyelt tárterületen.
serialConsoleLogBlobUri	string	A soros konzol naplójának blob URI-ja. Megjegyzés: Ez nem beállítva, ha a rendszerindítási diagnosztika jelenleg engedélyezve van a felügyelt tárterületen.
status	InstanceViewStatus	A virtuális gép rendszerindítási diagnosztikai állapotadatai. Megjegyzés: Csak akkor lesz beállítva, ha hiba történt a rendszerindítási diagnosztika engedélyezésében.

CloudError

Objektum

Hibaválasz a Compute szolgáltatástól.

Name	Típus	Description
error	ApiError	Api-hiba.

DiskEncryptionSettings

Objektum

Megadja az operációsrendszer-lemez titkosítási beállításait.

Minimális API-verzió: 2015-06-15

Name	Típus	Description
diskEncryptionKey	KeyVaultSecretReference	Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault-titkos kulcs.
enabled	boolean	Megadja, hogy engedélyezni kell-e a lemeztitkosítást a virtuális gépen.
keyEncryptionKey	KeyVaultKeyReference	Megadja a kulcstitkosítási kulcs helyét a Key Vaultban.

DiskInstanceView

Objektum

A virtuális gép lemezadatai.

Name	Típus	Description
encryptionSettings	DiskEncryptionSettings[]	Megadja az operációsrendszer-lemez titkosítási beállításait. Minimális API-verzió: 2015-06-15
name	string	A lemez neve.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.

HyperVGenerationType

Enumerálás

Az erőforráshoz társított HyperVGeneration-típust adja meg

Érték	Description
V1
V2

InnerError

Objektum

Belső hiba részletei.

Name	Típus	Description
errordetail	string	A belső hibaüzenet vagy kivételkép.
exceptiontype	string	A kivétel típusa.

InstanceViewStatus

Objektum

Példánynézet állapota.

Name	Típus	Description
code	string	Az állapotkód.
displayStatus	string	Az állapot rövid honosítható címkéje.
level	StatusLevelTypes	A szintkód.
message	string	A részletes állapotüzenet, beleértve a riasztásokat és a hibaüzeneteket is.
time	string (date-time)	Az állapot időpontja.

KeyVaultKeyReference

Objektum

Megadja a kulcstitkosítási kulcs helyét a Key Vaultban.

Name	Típus	Description
keyUrl	string	A Key Vault kulcstitkosítási kulcsára hivatkozó URL-cím.
sourceVault	SubResource	A kulcsot tartalmazó Key Vault relatív URL-címe.

KeyVaultSecretReference

Objektum

Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault-titkos kulcs.

Name	Típus	Description
secretUrl	string	Az URL-cím, amely egy titkos kulcsra hivatkozik egy Key Vaultban.
sourceVault	SubResource	A titkos kulcsot tartalmazó Key Vault relatív URL-címe.

LastPatchInstallationSummary

Objektum

A virtuális gép legújabb telepítési műveletének telepítési összefoglalása.

Name	Típus	Description
error	ApiError	A művelet végrehajtása során észlelt hibák. A részletek tömbje tartalmazza azokat.
excludedPatchCount	integer (int32)	Az ügyfél által megadott kizárási lista által explicit módon kizárt összes elérhető javítás száma.
failedPatchCount	integer (int32)	A sikertelen telepítést okozó javítások száma.
installationActivityId	string	Az eredményt eredményező művelet tevékenységazonosítója. A CRP és a bővítménynaplók közötti korrelációra szolgál.
installedPatchCount	integer (int32)	A sikeresen telepített javítások száma.
lastModifiedTime	string (date-time)	A művelet kezdetének UTC időbélyege.
maintenanceWindowExceeded	boolean	Azt ismerteti, hogy a művelet túllépte-e az időkorlátot az összes tervezett művelet végrehajtása előtt.
notSelectedPatchCount	integer (int32)	Az összes elérhető javítás száma, de nem lesz telepítve, mert nem egyezik a besorolási vagy a belefoglalási lista bejegyzésével.
pendingPatchCount	integer (int32)	A javítástelepítési művelet során várhatóan telepíteni kívánt összes elérhető javítás száma.
startTime	string (date-time)	A művelet kezdetének UTC időbélyege.
status	PatchOperationStatus	A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig az "InProgress" marad. Ekkor "Ismeretlen", "Sikertelen", "Sikeres" vagy "CompletedWithWarnings" lesz.

MaintenanceOperationResultCodeTypes

Enumerálás

Az utolsó karbantartási művelet eredménykódja.

Érték	Description
MaintenanceAborted
MaintenanceCompleted
None
RetryLater

MaintenanceRedeployStatus

Objektum

A karbantartási művelet állapota a virtuális gépen.

Name	Típus	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Igaz, ha az ügyfél elvégezhet karbantartást.
lastOperationMessage	string	Az utolsó karbantartási művelethez visszaadott üzenet.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Az utolsó karbantartási művelet eredménykódja.
maintenanceWindowEndTime	string (date-time)	A karbantartási időszak befejezési ideje.
maintenanceWindowStartTime	string (date-time)	A karbantartási időszak kezdési ideje.
preMaintenanceWindowEndTime	string (date-time)	A karbantartás előtti időszak befejezési ideje.
preMaintenanceWindowStartTime	string (date-time)	A karbantartás előtti időszak kezdési ideje.

PatchOperationStatus

Enumerálás

A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig az "InProgress" marad. Ekkor "Ismeretlen", "Sikertelen", "Sikeres" vagy "CompletedWithWarnings" lesz.

Érték	Description
CompletedWithWarnings
Failed
InProgress
Succeeded
Unknown

StatusLevelTypes

Enumerálás

A szintkód.

Érték	Description
Error
Info
Warning

SubResource

Objektum

A titkos kulcsot tartalmazó Key Vault relatív URL-címe.

Name	Típus	Description
id	string	Erőforrás-azonosító

VirtualMachineAgentInstanceView

Objektum

A virtuális gépen futó virtuálisgép-ügynök.

Name	Típus	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	A virtuálisgép-bővítménykezelő példánynézete.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.
vmAgentVersion	string	A virtuálisgép-ügynök teljes verziója.

VirtualMachineExtensionHandlerInstanceView

Objektum

A virtuálisgép-bővítménykezelő példánynézete.

Name	Típus	Description
status	InstanceViewStatus	A bővítménykezelő állapota.
type	string	Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension".
typeHandlerVersion	string	A szkriptkezelő verzióját adja meg.

VirtualMachineExtensionInstanceView

Objektum

A bővítmények adatai.

Name	Típus	Description
name	string	A virtuális gép bővítményének neve.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.
substatuses	InstanceViewStatus[]	Az erőforrás állapotadatai.
type	string	Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension".
typeHandlerVersion	string	A szkriptkezelő verzióját adja meg.

VirtualMachineHealthStatus

Objektum

A virtuális gép állapotának állapota.

Name	Típus	Description
status	InstanceViewStatus	A virtuális gép állapotadatai.

VirtualMachineInstanceView

Objektum

Egy virtuális gép példánynézete.

Name	Típus	Description
assignedHost	string	Annak a dedikált gazdagépnek az erőforrás-azonosítója, amelyen a virtuális gép automatikus elhelyezéssel van lefoglalva, ha a virtuális gép egy dedikált gazdagépcsoporthoz van társítva, amelyen engedélyezve van az automatikus elhelyezés. Minimális API-verzió: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	A rendszerindítási diagnosztika egy hibakeresési funkció, amely lehetővé teszi a konzol kimenetének és képernyőképének megtekintését a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.
computerName	string	A virtuális géphez rendelt számítógépnév.
disks	DiskInstanceView[]	A virtuális gép lemezadatai.
extensions	VirtualMachineExtensionInstanceView[]	A bővítmények adatai.
hyperVGeneration	HyperVGenerationType	Az erőforráshoz társított HyperVGeneration-típust adja meg
isVMInStandbyPool	boolean	[Előzetes verziójú funkció] Megadja, hogy a virtuális gép jelenleg a készenléti készletben vagy azon kívül van-e.
maintenanceRedeployStatus	MaintenanceRedeployStatus	A karbantartási művelet állapota a virtuális gépen.
osName	string	A virtuális gépen futó operációs rendszer.
osVersion	string	A virtuális gépen futó operációs rendszer verziója.
patchStatus	VirtualMachinePatchStatus	[Előzetes verziójú funkció] A virtuális gépek javításműveleteinek állapota.
platformFaultDomain	integer (int32)	Megadja a virtuális gép tartalék tartományát.
platformUpdateDomain	integer (int32)	Megadja a virtuális gép frissítési tartományát.
rdpThumbPrint	string	A távoli asztali tanúsítvány ujjlenyomata.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.
vmAgent	VirtualMachineAgentInstanceView	A virtuális gépen futó virtuálisgép-ügynök.
vmHealth	VirtualMachineHealthStatus	A virtuális gép állapotának állapota.

VirtualMachinePatchStatus

Objektum

[Előzetes verziójú funkció] A virtuális gépek javításműveleteinek állapota.

Name	Típus	Description
availablePatchSummary	AvailablePatchSummary	A virtuális gép legújabb értékelési műveletének elérhető javítás-összefoglalása.
configurationStatuses	InstanceViewStatus[]	A megadott patchMode engedélyezési állapota
lastPatchInstallationSummary	LastPatchInstallationSummary	A virtuális gép legújabb telepítési műveletének telepítési összefoglalása.

Megosztás a következőn keresztül:

Virtual Machines - Instance View

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

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

Mintakérelem

Mintaválasz

Get Virtual Machine Instance View.

Mintakérelem

Mintaválasz

Definíciók

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus

További források