Virtual Machines - Instance View

참조

서비스:: Compute

API 버전:: 2024-07-01

가상 머신의 런타임 상태에 대한 정보를 검색합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
vmName	path	True	string	가상 머신의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	VirtualMachineInstanceView	그래
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

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.

샘플 요청

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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/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");

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

샘플 응답

상태 코드:: 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.

샘플 요청

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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/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");

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

샘플 응답

상태 코드:: 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"
    }
  ]
}

정의

Name	Description
ApiError	API 오류입니다.
ApiErrorBase	API 오류 기준입니다.
AvailablePatchSummary	가상 머신에 대한 최신 평가 작업의 사용 가능한 패치 요약입니다.
BootDiagnosticsInstanceView	부팅 진단은 콘솔 출력 및 스크린샷을 보고 VM 상태를 진단할 수 있는 디버깅 기능입니다. 콘솔 로그의 출력을 쉽게 볼 수 있습니다. 또한 Azure를 사용하면 하이퍼바이저에서 VM의 스크린샷을 볼 수 있습니다.
CloudError	Compute 서비스의 오류 응답입니다.
DiskEncryptionSettings	OS 디스크에 대한 암호화 설정을 지정합니다. 최소 api-version: 2015-06-15
DiskInstanceView	가상 머신 디스크 정보입니다.
HyperVGenerationType	리소스와 연결된 HyperVGeneration 형식을 지정합니다.
InnerError	내부 오류 세부 정보입니다.
InstanceViewStatus	인스턴스 보기 상태입니다.
KeyVaultKeyReference	Key Vault에서 키 암호화 키의 위치를 지정합니다.
KeyVaultSecretReference	키 자격 증명 모음 비밀인 디스크 암호화 키의 위치를 지정합니다.
LastPatchInstallationSummary	가상 머신에 대한 최신 설치 작업의 설치 요약입니다.
MaintenanceOperationResultCodeTypes	마지막 유지 관리 작업 결과 코드입니다.
MaintenanceRedeployStatus	가상 머신의 유지 관리 작업 상태입니다.
PatchOperationStatus	작업의 전체 성공 또는 실패 상태입니다. 작업이 완료될 때까지 "InProgress"로 유지됩니다. 이 시점에서 "알 수 없음", "실패", "성공" 또는 "CompletedWithWarnings"가 됩니다.
StatusLevelTypes	수준 코드입니다.
SubResource	비밀을 포함하는 Key Vault의 상대 URL입니다.
VirtualMachineAgentInstanceView	가상 머신에서 실행되는 VM 에이전트입니다.
VirtualMachineExtensionHandlerInstanceView	가상 머신 확장 처리기 인스턴스 보기입니다.
VirtualMachineExtensionInstanceView	확장 정보입니다.
VirtualMachineHealthStatus	VM의 상태입니다.
VirtualMachineInstanceView	가상 머신의 인스턴스 뷰입니다.
VirtualMachinePatchStatus	[미리 보기 기능] 가상 머신 패치 작업의 상태입니다.

ApiError

API 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ApiErrorBase[]	API 오류 세부 정보
innererror	InnerError	API 내부 오류
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

AvailablePatchSummary

가상 머신에 대한 최신 평가 작업의 사용 가능한 패치 요약입니다.

Name	형식	Description
assessmentActivityId	string	이 결과를 생성한 작업의 활동 ID입니다. CRP 및 확장 로그 간에 상관 관계를 지정하는 데 사용됩니다.
criticalAndSecurityPatchCount	integer	사용 가능하고 아직 설치되지 않은 것으로 검색된 중요 또는 보안 패치의 수입니다.
error	ApiError	작업을 실행하는 동안 발생한 오류입니다. 세부 정보 배열에는 해당 목록이 포함됩니다.
lastModifiedTime	string	작업이 시작된 UTC 타임스탬프입니다.
otherPatchCount	integer	중요 및 보안을 제외한 사용 가능한 모든 패치의 수입니다.
rebootPending	boolean	VM의 전체 재부팅 상태입니다. 부분적으로 설치된 패치가 설치를 완료하기 위해 다시 부팅해야 하지만 다시 부팅이 아직 발생하지 않은 경우 적용됩니다.
startTime	string	작업이 시작된 UTC 타임스탬프입니다.
status	PatchOperationStatus	작업의 전체 성공 또는 실패 상태입니다. 작업이 완료될 때까지 "InProgress"로 유지됩니다. 이 시점에서 "알 수 없음", "실패", "성공" 또는 "CompletedWithWarnings"가 됩니다.

BootDiagnosticsInstanceView

부팅 진단은 콘솔 출력 및 스크린샷을 보고 VM 상태를 진단할 수 있는 디버깅 기능입니다. 콘솔 로그의 출력을 쉽게 볼 수 있습니다. 또한 Azure를 사용하면 하이퍼바이저에서 VM의 스크린샷을 볼 수 있습니다.

Name	형식	Description
consoleScreenshotBlobUri	string	콘솔 스크린샷 Blob URI입니다. 참고: 부팅 진단이 현재 관리되는 스토리지에서 사용하도록 설정된 경우 설정되지 .
serialConsoleLogBlobUri	string	직렬 콘솔 로그 Blob Uri입니다. 참고: 부팅 진단이 현재 관리되는 스토리지에서 사용하도록 설정된 경우 설정되지 .
status	InstanceViewStatus	VM에 대한 부팅 진단 상태 정보입니다. 참고: 부팅 진단을 사용하도록 설정하는 데 오류가 발생한 경우에만 설정됩니다.

CloudError

Compute 서비스의 오류 응답입니다.

Name	형식	Description
error	ApiError	API 오류입니다.

DiskEncryptionSettings

OS 디스크에 대한 암호화 설정을 지정합니다.

최소 api-version: 2015-06-15

Name	형식	Description
diskEncryptionKey	KeyVaultSecretReference	키 자격 증명 모음 비밀인 디스크 암호화 키의 위치를 지정합니다.
enabled	boolean	가상 머신에서 디스크 암호화를 사용할지 여부를 지정합니다.
keyEncryptionKey	KeyVaultKeyReference	Key Vault에서 키 암호화 키의 위치를 지정합니다.

DiskInstanceView

가상 머신 디스크 정보입니다.

Name	형식	Description
encryptionSettings	DiskEncryptionSettings[]	OS 디스크에 대한 암호화 설정을 지정합니다. 최소 api-version: 2015-06-15
name	string	디스크 이름입니다.
statuses	InstanceViewStatus[]	리소스 상태 정보입니다.

HyperVGenerationType

리소스와 연결된 HyperVGeneration 형식을 지정합니다.

Name	형식	Description
V1	string
V2	string

InnerError

내부 오류 세부 정보입니다.

Name	형식	Description
errordetail	string	내부 오류 메시지 또는 예외 덤프입니다.
exceptiontype	string	예외 형식입니다.

InstanceViewStatus

인스턴스 보기 상태입니다.

Name	형식	Description
code	string	상태 코드입니다.
displayStatus	string	상태에 대한 짧은 지역화 가능 레이블입니다.
level	StatusLevelTypes	수준 코드입니다.
message	string	경고 및 오류 메시지를 포함한 자세한 상태 메시지입니다.
time	string	상태의 시간입니다.

KeyVaultKeyReference

Key Vault에서 키 암호화 키의 위치를 지정합니다.

Name	형식	Description
keyUrl	string	Key Vault에서 키 암호화 키를 참조하는 URL입니다.
sourceVault	SubResource	키를 포함하는 Key Vault의 상대 URL입니다.

KeyVaultSecretReference

키 자격 증명 모음 비밀인 디스크 암호화 키의 위치를 지정합니다.

Name	형식	Description
secretUrl	string	Key Vault의 비밀을 참조하는 URL입니다.
sourceVault	SubResource	비밀을 포함하는 Key Vault의 상대 URL입니다.

LastPatchInstallationSummary

가상 머신에 대한 최신 설치 작업의 설치 요약입니다.

Name	형식	Description
error	ApiError	작업을 실행하는 동안 발생한 오류입니다. 세부 정보 배열에는 해당 목록이 포함됩니다.
excludedPatchCount	integer	고객이 지정한 제외 목록 일치 항목에 의해 명시적으로 제외되었지만 사용 가능한 모든 패치의 수입니다.
failedPatchCount	integer	설치에 실패한 패치의 수입니다.
installationActivityId	string	이 결과를 생성한 작업의 활동 ID입니다. CRP 및 확장 로그 간에 상관 관계를 지정하는 데 사용됩니다.
installedPatchCount	integer	성공적으로 설치된 패치의 수입니다.
lastModifiedTime	string	작업이 시작된 UTC 타임스탬프입니다.
maintenanceWindowExceeded	boolean	작업이 의도한 모든 작업을 완료하기 전에 시간이 부족했는지 여부를 설명합니다.
notSelectedPatchCount	integer	사용 가능한 모든 패치의 수이지만 분류 또는 포함 목록 항목과 일치하지 않아 설치되지 않을 수 있습니다.
pendingPatchCount	integer	패치 설치 작업 과정에서 설치될 것으로 예상되는 사용 가능한 모든 패치의 수입니다.
startTime	string	작업이 시작된 UTC 타임스탬프입니다.
status	PatchOperationStatus	작업의 전체 성공 또는 실패 상태입니다. 작업이 완료될 때까지 "InProgress"로 유지됩니다. 이 시점에서 "알 수 없음", "실패", "성공" 또는 "CompletedWithWarnings"가 됩니다.

MaintenanceOperationResultCodeTypes

마지막 유지 관리 작업 결과 코드입니다.

Name	형식	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

가상 머신의 유지 관리 작업 상태입니다.

Name	형식	Description
isCustomerInitiatedMaintenanceAllowed	boolean	고객이 유지 관리를 수행할 수 있는 경우 True입니다.
lastOperationMessage	string	마지막 유지 관리 작업을 위해 반환된 메시지입니다.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	마지막 유지 관리 작업 결과 코드입니다.
maintenanceWindowEndTime	string	유지 관리 기간의 종료 시간입니다.
maintenanceWindowStartTime	string	유지 관리 기간의 시작 시간입니다.
preMaintenanceWindowEndTime	string	유지 관리 전 기간의 종료 시간입니다.
preMaintenanceWindowStartTime	string	사전 유지 관리 기간의 시작 시간입니다.

PatchOperationStatus

작업의 전체 성공 또는 실패 상태입니다. 작업이 완료될 때까지 "InProgress"로 유지됩니다. 이 시점에서 "알 수 없음", "실패", "성공" 또는 "CompletedWithWarnings"가 됩니다.

Name	형식	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

StatusLevelTypes

수준 코드입니다.

Name	형식	Description
Error	string
Info	string
Warning	string

SubResource

비밀을 포함하는 Key Vault의 상대 URL입니다.

Name	형식	Description
id	string	리소스 ID

VirtualMachineAgentInstanceView

가상 머신에서 실행되는 VM 에이전트입니다.

Name	형식	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	가상 머신 확장 처리기 인스턴스 보기입니다.
statuses	InstanceViewStatus[]	리소스 상태 정보입니다.
vmAgentVersion	string	VM 에이전트 전체 버전입니다.

VirtualMachineExtensionHandlerInstanceView

가상 머신 확장 처리기 인스턴스 보기입니다.

Name	형식	Description
status	InstanceViewStatus	확장 처리기 상태입니다.
type	string	확장의 형식을 지정합니다. 예를 들어 "CustomScriptExtension"이 있습니다.
typeHandlerVersion	string	스크립트 처리기의 버전을 지정합니다.

VirtualMachineExtensionInstanceView

확장 정보입니다.

Name	형식	Description
name	string	가상 머신 확장 이름입니다.
statuses	InstanceViewStatus[]	리소스 상태 정보입니다.
substatuses	InstanceViewStatus[]	리소스 상태 정보입니다.
type	string	확장의 형식을 지정합니다. 예를 들어 "CustomScriptExtension"이 있습니다.
typeHandlerVersion	string	스크립트 처리기의 버전을 지정합니다.

VirtualMachineHealthStatus

VM의 상태입니다.

Name	형식	Description
status	InstanceViewStatus	VM의 상태 정보입니다.

VirtualMachineInstanceView

가상 머신의 인스턴스 뷰입니다.

Name	형식	Description
assignedHost	string	가상 머신이 자동 배치를 사용하도록 설정된 전용 호스트 그룹과 연결된 경우 가상 머신이 자동 배치를 통해 할당되는 전용 호스트의 리소스 ID입니다. 최소 api-version: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	부팅 진단은 콘솔 출력 및 스크린샷을 보고 VM 상태를 진단할 수 있는 디버깅 기능입니다. 콘솔 로그의 출력을 쉽게 볼 수 있습니다. 또한 Azure를 사용하면 하이퍼바이저에서 VM의 스크린샷을 볼 수 있습니다.
computerName	string	가상 머신에 할당된 컴퓨터 이름입니다.
disks	DiskInstanceView[]	가상 머신 디스크 정보입니다.
extensions	VirtualMachineExtensionInstanceView[]	확장 정보입니다.
hyperVGeneration	HyperVGenerationType	리소스와 연결된 HyperVGeneration 형식을 지정합니다.
isVMInStandbyPool	boolean	[미리 보기 기능] VM이 현재 대기 풀에 있는지 여부를 지정합니다.
maintenanceRedeployStatus	MaintenanceRedeployStatus	가상 머신의 유지 관리 작업 상태입니다.
osName	string	가상 머신에서 실행되는 운영 체제입니다.
osVersion	string	가상 머신에서 실행되는 운영 체제의 버전입니다.
patchStatus	VirtualMachinePatchStatus	[미리 보기 기능] 가상 머신 패치 작업의 상태입니다.
platformFaultDomain	integer	가상 머신의 장애 도메인을 지정합니다.
platformUpdateDomain	integer	가상 머신의 업데이트 도메인을 지정합니다.
rdpThumbPrint	string	원격 데스크톱 인증서 지문입니다.
statuses	InstanceViewStatus[]	리소스 상태 정보입니다.
vmAgent	VirtualMachineAgentInstanceView	가상 머신에서 실행되는 VM 에이전트입니다.
vmHealth	VirtualMachineHealthStatus	VM의 상태입니다.

VirtualMachinePatchStatus

[미리 보기 기능] 가상 머신 패치 작업의 상태입니다.

Name	형식	Description
availablePatchSummary	AvailablePatchSummary	가상 머신에 대한 최신 평가 작업의 사용 가능한 패치 요약입니다.
configurationStatuses	InstanceViewStatus[]	지정된 patchMode의 사용 상태
lastPatchInstallationSummary	LastPatchInstallationSummary	가상 머신에 대한 최신 설치 작업의 설치 요약입니다.

다음을 통해 공유

Virtual Machines - Instance View

URI 매개 변수

응답

보안

azure_auth

범위

예제

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

샘플 요청

샘플 응답

Get Virtual Machine Instance View.

샘플 요청

샘플 응답

정의

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus

추가 리소스