Virtual Machines - Instance View

Başvuru

Hizmet:: Compute

API Sürümü:: 2024-07-01

Bir sanal makinenin çalışma zamanı durumu hakkındaki bilgileri alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
vmName	path	True	string	Sanal makinenin adı.
api-version	query	True	string	İstemci Api Sürümü.

Yanıtlar

Name	Tür	Description
200 OK	VirtualMachineInstanceView	TAMAM
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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.

Örnek isteği

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://zcusa.951200.xyz/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

Örnek yanıt

Durum kodu:: 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.

Örnek isteği

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://zcusa.951200.xyz/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

Örnek yanıt

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

Tanımlar

Name	Description
ApiError	API hatası.
ApiErrorBase	Api hata tabanı.
AvailablePatchSummary	Sanal makine için en son değerlendirme işleminin kullanılabilir düzeltme eki özeti.
BootDiagnosticsInstanceView	Önyükleme Tanılama, VM durumunu tanılamak için Konsol Çıkışını ve Ekran Görüntüsünü görüntülemenizi sağlayan bir hata ayıklama özelliğidir. Konsol günlüğünüzün çıkışını kolayca görüntüleyebilirsiniz. Azure ayrıca hiper yöneticiden VM'nin ekran görüntüsünü görmenizi sağlar.
CloudError	İşlem hizmetinden bir hata yanıtı.
DiskEncryptionSettings	İşletim sistemi diskinin şifreleme ayarlarını belirtir. En düşük api sürümü: 2015-06-15
DiskInstanceView	Sanal makine disk bilgileri.
HyperVGenerationType	Bir kaynakla ilişkilendirilmiş HyperVGeneration Türünü belirtir
InnerError	İç hata ayrıntıları.
InstanceViewStatus	Örnek görünümü durumu.
KeyVaultKeyReference	Anahtar şifreleme anahtarının Key Vault'taki konumunu belirtir.
KeyVaultSecretReference	Anahtar Kasası Gizli Anahtarı olan disk şifreleme anahtarının konumunu belirtir.
LastPatchInstallationSummary	Sanal makine için en son yükleme işleminin yükleme özeti.
MaintenanceOperationResultCodeTypes	Son Bakım İşlemi Sonuç Kodu.
MaintenanceRedeployStatus	Sanal makinedeki Bakım İşlemi durumu.
PatchOperationStatus	İşlemin genel başarı veya başarısızlık durumu. İşlem tamamlanana kadar "InProgress" olarak kalır. Bu noktada "Bilinmiyor", "Başarısız", "Başarılı" veya "CompletedWithWarnings" olur.
StatusLevelTypes	Düzey kodu.
SubResource	Gizli diziyi içeren Key Vault'un göreli URL'si.
VirtualMachineAgentInstanceView	Sanal makinede çalışan VM Aracısı.
VirtualMachineExtensionHandlerInstanceView	Sanal makine uzantısı işleyici örneği görünümü.
VirtualMachineExtensionInstanceView	Uzantı bilgileri.
VirtualMachineHealthStatus	VM'nin sistem durumu.
VirtualMachineInstanceView	Sanal makinenin örnek görünümü.
VirtualMachinePatchStatus	[Önizleme Özelliği] Sanal makine düzeltme eki işlemlerinin durumu.

ApiError

API hatası.

Name	Tür	Description
code	string	Hata kodu.
details	ApiErrorBase[]	Api hata ayrıntıları
innererror	InnerError	Api iç hatası
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

ApiErrorBase

Api hata tabanı.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

AvailablePatchSummary

Sanal makine için en son değerlendirme işleminin kullanılabilir düzeltme eki özeti.

Name	Tür	Description
assessmentActivityId	string	Bu sonucu oluşturan işlemin etkinlik kimliği. CRP ve uzantı günlükleri arasında bağıntı sağlamak için kullanılır.
criticalAndSecurityPatchCount	integer	Kullanılabilir olarak algılanan ve henüz yüklenmemiş kritik veya güvenlik düzeltme eklerinin sayısı.
error	ApiError	İşlemin yürütülmesi sırasında karşılaşılan hatalar. Details dizisi bunların listesini içerir.
lastModifiedTime	string	İşlemin başladığı UTC zaman damgası.
otherPatchCount	integer	Kritik ve güvenlik hariç tüm kullanılabilir düzeltme eklerinin sayısı.
rebootPending	boolean	VM'nin genel yeniden başlatma durumu. Kısmen yüklenen düzeltme ekleri yüklemeyi tamamlamak için yeniden başlatma gerektirdiğinde ancak yeniden başlatma henüz gerçekleşmediğinde doğru olacaktır.
startTime	string	İşlemin başladığı UTC zaman damgası.
status	PatchOperationStatus	İşlemin genel başarı veya başarısızlık durumu. İşlem tamamlanana kadar "InProgress" olarak kalır. Bu noktada "Bilinmiyor", "Başarısız", "Başarılı" veya "CompletedWithWarnings" olur.

BootDiagnosticsInstanceView

Önyükleme Tanılama, VM durumunu tanılamak için Konsol Çıkışını ve Ekran Görüntüsünü görüntülemenizi sağlayan bir hata ayıklama özelliğidir. Konsol günlüğünüzün çıkışını kolayca görüntüleyebilirsiniz. Azure ayrıca hiper yöneticiden VM'nin ekran görüntüsünü görmenizi sağlar.

Name	Tür	Description
consoleScreenshotBlobUri	string	Konsol ekran görüntüsü blob URI'si. Not: Önyükleme tanılaması şu anda yönetilen depolama ile etkinleştirildiyse bu ayar .
serialConsoleLogBlobUri	string	Seri konsol günlük blobu Uri'si. Not: Önyükleme tanılaması şu anda yönetilen depolama ile etkinleştirildiyse bu ayar .
status	InstanceViewStatus	VM için önyükleme tanılama durumu bilgileri. Not: Yalnızca önyükleme tanılamasını etkinleştirirken karşılaşılan hatalar varsa ayarlanır.

CloudError

İşlem hizmetinden bir hata yanıtı.

Name	Tür	Description
error	ApiError	API hatası.

DiskEncryptionSettings

İşletim sistemi diskinin şifreleme ayarlarını belirtir.

En düşük api sürümü: 2015-06-15

Name	Tür	Description
diskEncryptionKey	KeyVaultSecretReference	Anahtar Kasası Gizli Anahtarı olan disk şifreleme anahtarının konumunu belirtir.
enabled	boolean	Sanal makinede disk şifrelemesinin etkinleştirilip etkinleştirilmeymeyeceğini belirtir.
keyEncryptionKey	KeyVaultKeyReference	Anahtar şifreleme anahtarının Key Vault'taki konumunu belirtir.

DiskInstanceView

Sanal makine disk bilgileri.

Name	Tür	Description
encryptionSettings	DiskEncryptionSettings[]	İşletim sistemi diskinin şifreleme ayarlarını belirtir. En düşük api sürümü: 2015-06-15
name	string	Disk adı.
statuses	InstanceViewStatus[]	Kaynak durumu bilgileri.

HyperVGenerationType

Bir kaynakla ilişkilendirilmiş HyperVGeneration Türünü belirtir

Name	Tür	Description
V1	string
V2	string

InnerError

İç hata ayrıntıları.

Name	Tür	Description
errordetail	string	İç hata iletisi veya özel durum dökümü.
exceptiontype	string	Özel durum türü.

InstanceViewStatus

Örnek görünümü durumu.

Name	Tür	Description
code	string	Durum kodu.
displayStatus	string	Durum için kısa yerelleştirilebilir etiket.
level	StatusLevelTypes	Düzey kodu.
message	string	Uyarılar ve hata iletileri dahil olmak üzere ayrıntılı durum iletisi.
time	string	Durum zamanı.

KeyVaultKeyReference

Anahtar şifreleme anahtarının Key Vault'taki konumunu belirtir.

Name	Tür	Description
keyUrl	string	Key Vault'ta anahtar şifreleme anahtarına başvuran URL.
sourceVault	SubResource	Anahtarı içeren Key Vault'un göreli URL'si.

KeyVaultSecretReference

Anahtar Kasası Gizli Anahtarı olan disk şifreleme anahtarının konumunu belirtir.

Name	Tür	Description
secretUrl	string	Key Vault'ta gizli diziye başvuran URL.
sourceVault	SubResource	Gizli diziyi içeren Key Vault'un göreli URL'si.

LastPatchInstallationSummary

Sanal makine için en son yükleme işleminin yükleme özeti.

Name	Tür	Description
error	ApiError	İşlemin yürütülmesi sırasında karşılaşılan hatalar. Details dizisi bunların listesini içerir.
excludedPatchCount	integer	Müşteri tarafından belirtilen dışlama listesi eşleşmesi tarafından açıkça hariç tutulan tüm kullanılabilir düzeltme eklerinin sayısı.
failedPatchCount	integer	Yüklemede başarısız olan düzeltme eklerinin sayısı.
installationActivityId	string	Bu sonucu oluşturan işlemin etkinlik kimliği. CRP ve uzantı günlükleri arasında bağıntı sağlamak için kullanılır.
installedPatchCount	integer	Başarıyla yüklenen düzeltme eklerinin sayısı.
lastModifiedTime	string	İşlemin başladığı UTC zaman damgası.
maintenanceWindowExceeded	boolean	İşlemin amaçlanan tüm eylemlerini tamamlamadan önce süresinin tükenip bitmediğini açıklar
notSelectedPatchCount	integer	Kullanılabilir tüm düzeltme eklerinin sayısıdır, ancak bir sınıflandırma veya ekleme listesi girişiyle eşleşmediğinden yüklenmez.
pendingPatchCount	integer	Düzeltme eki yükleme işlemi boyunca yüklenmesi beklenen tüm kullanılabilir düzeltme eklerinin sayısı.
startTime	string	İşlemin başladığı UTC zaman damgası.
status	PatchOperationStatus	İşlemin genel başarı veya başarısızlık durumu. İşlem tamamlanana kadar "InProgress" olarak kalır. Bu noktada "Bilinmiyor", "Başarısız", "Başarılı" veya "CompletedWithWarnings" olur.

MaintenanceOperationResultCodeTypes

Son Bakım İşlemi Sonuç Kodu.

Name	Tür	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Sanal makinedeki Bakım İşlemi durumu.

Name	Tür	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Doğru, müşterinin Bakım gerçekleştirmesine izin veriliyorsa.
lastOperationMessage	string	Son Bakım İşlemi için ileti döndürüldü.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Son Bakım İşlemi Sonuç Kodu.
maintenanceWindowEndTime	string	Bakım Penceresi için Bitiş Saati.
maintenanceWindowStartTime	string	Bakım Penceresi için Başlangıç Saati.
preMaintenanceWindowEndTime	string	Bakım Öncesi Penceresi için Bitiş Zamanı.
preMaintenanceWindowStartTime	string	Bakım Öncesi Penceresi için Başlangıç Saati.

PatchOperationStatus

İşlemin genel başarı veya başarısızlık durumu. İşlem tamamlanana kadar "InProgress" olarak kalır. Bu noktada "Bilinmiyor", "Başarısız", "Başarılı" veya "CompletedWithWarnings" olur.

Name	Tür	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

StatusLevelTypes

Düzey kodu.

Name	Tür	Description
Error	string
Info	string
Warning	string

SubResource

Gizli diziyi içeren Key Vault'un göreli URL'si.

Name	Tür	Description
id	string	Kaynak Kimliği

VirtualMachineAgentInstanceView

Sanal makinede çalışan VM Aracısı.

Name	Tür	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Sanal makine uzantısı işleyici örneği görünümü.
statuses	InstanceViewStatus[]	Kaynak durumu bilgileri.
vmAgentVersion	string	VM Aracısı tam sürümü.

VirtualMachineExtensionHandlerInstanceView

Sanal makine uzantısı işleyici örneği görünümü.

Name	Tür	Description
status	InstanceViewStatus	Uzantı işleyici durumu.
type	string	Uzantının türünü belirtir; "CustomScriptExtension" örnektir.
typeHandlerVersion	string	Betik işleyicisinin sürümünü belirtir.

VirtualMachineExtensionInstanceView

Uzantı bilgileri.

Name	Tür	Description
name	string	Sanal makine uzantısı adı.
statuses	InstanceViewStatus[]	Kaynak durumu bilgileri.
substatuses	InstanceViewStatus[]	Kaynak durumu bilgileri.
type	string	Uzantının türünü belirtir; "CustomScriptExtension" örnektir.
typeHandlerVersion	string	Betik işleyicisinin sürümünü belirtir.

VirtualMachineHealthStatus

VM'nin sistem durumu.

Name	Tür	Description
status	InstanceViewStatus	VM'nin sistem durumu bilgileri.

VirtualMachineInstanceView

Sanal makinenin örnek görünümü.

Name	Tür	Description
assignedHost	string	Sanal makine, otomatik yerleştirmeyi etkinleştirmiş ayrılmış bir konak grubuyla ilişkilendirildiğinde, sanal makinenin otomatik yerleştirme yoluyla ayrıldığı ayrılmış konağın kaynak kimliği. En düşük api sürümü: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Önyükleme Tanılama, VM durumunu tanılamak için Konsol Çıkışını ve Ekran Görüntüsünü görüntülemenizi sağlayan bir hata ayıklama özelliğidir. Konsol günlüğünüzün çıkışını kolayca görüntüleyebilirsiniz. Azure ayrıca hiper yöneticiden VM'nin ekran görüntüsünü görmenizi sağlar.
computerName	string	Sanal makineye atanan bilgisayar adı.
disks	DiskInstanceView[]	Sanal makine disk bilgileri.
extensions	VirtualMachineExtensionInstanceView[]	Uzantı bilgileri.
hyperVGeneration	HyperVGenerationType	Bir kaynakla ilişkilendirilmiş HyperVGeneration Türünü belirtir
isVMInStandbyPool	boolean	[Önizleme Özelliği] VM'nin şu anda Bekleme Havuzu'nda mı yoksa dışında mı olduğunu belirtir.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Sanal makinedeki Bakım İşlemi durumu.
osName	string	Sanal makinede çalışan İşletim Sistemi.
osVersion	string	Sanal makinede çalışan İşletim Sistemi sürümü.
patchStatus	VirtualMachinePatchStatus	[Önizleme Özelliği] Sanal makine düzeltme eki işlemlerinin durumu.
platformFaultDomain	integer	Sanal makinenin hata etki alanını belirtir.
platformUpdateDomain	integer	Sanal makinenin güncelleştirme etki alanını belirtir.
rdpThumbPrint	string	Uzak masaüstü sertifikası parmak izi.
statuses	InstanceViewStatus[]	Kaynak durumu bilgileri.
vmAgent	VirtualMachineAgentInstanceView	Sanal makinede çalışan VM Aracısı.
vmHealth	VirtualMachineHealthStatus	VM'nin sistem durumu.

VirtualMachinePatchStatus

[Önizleme Özelliği] Sanal makine düzeltme eki işlemlerinin durumu.

Name	Tür	Description
availablePatchSummary	AvailablePatchSummary	Sanal makine için en son değerlendirme işleminin kullanılabilir düzeltme eki özeti.
configurationStatuses	InstanceViewStatus[]	Belirtilen patchMode'un etkinleştirme durumu
lastPatchInstallationSummary	LastPatchInstallationSummary	Sanal makine için en son yükleme işleminin yükleme özeti.

Aracılığıyla paylaş

Virtual Machines - Instance View

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

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

Örnek isteği

Örnek yanıt

Get Virtual Machine Instance View.

Örnek isteği

Örnek yanıt

Tanımlar

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus

Ek kaynaklar