Virtual Machines - Instance View

Referentie

Service:: Compute

API Version:: 2024-03-01

Hiermee haalt u informatie op over de runtimestatus van een virtuele machine.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
vmName	path	True	string	De naam van de virtuele machine.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	VirtualMachineInstanceView	OK
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

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.

Sample Request

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


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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

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


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

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachinesClient_InstanceView_getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachinesClient().InstanceView(ctx, "myResourceGroup", "myVM", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineInstanceView = armcompute.VirtualMachineInstanceView{
	// 	AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 	ComputerName: to.Ptr("myVM"),
	// 	Disks: []*armcompute.DiskInstanceView{
	// 		{
	// 			Name: to.Ptr("myOsDisk"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-03-01T21:29:47.477Z"); return t}()),
	// 			}},
	// 	}},
	// 	HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypeV1),
	// 	OSName: to.Ptr("Windows Server 2016 Datacenter"),
	// 	OSVersion: to.Ptr("Microsoft Windows NT 10.0.14393.0"),
	// 	Statuses: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ProvisioningState/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-03-01T21:30:12.805Z"); return t}()),
	// 		},
	// 		{
	// 			Code: to.Ptr("PowerState/running"),
	// 			DisplayStatus: to.Ptr("VM running"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 	}},
	// 	VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/succeeded"),
	// 				DisplayStatus: to.Ptr("Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Message: to.Ptr("GuestAgent is running and accepting new configurations."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-03-01T23:11:22.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Retrieves information about the run-time state of a virtual machine.
 *
 * @summary Retrieves information about the run-time state of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.instanceView(resourceGroupName, vmName);
  console.log(result);
}

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

Sample Response

Status code:: 200

{
  "computerName": "myVM",
  "osName": "Windows Server 2016 Datacenter",
  "osVersion": "Microsoft Windows NT 10.0.14393.0",
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.949",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and accepting new configurations.",
        "time": "2024-03-01T23:11:22+00:00"
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2024-03-01T21:29:47.477089+00:00"
        }
      ]
    }
  ],
  "hyperVGeneration": "V1",
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2024-03-01T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Get Virtual Machine Instance View.

Sample Request

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


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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

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


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

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

package armcompute_test

import (
	"context"
	"log"

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

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

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

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

/**
 * This sample demonstrates how to Retrieves information about the run-time state of a virtual machine.
 *
 * @summary Retrieves information about the run-time state of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
 */
async function getVirtualMachineInstanceView() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.instanceView(resourceGroupName, vmName);
  console.log(result);
}

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

Sample Response

Status code:: 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"
    }
  ]
}

Definities

Name	Description
ApiError	API-fout.
ApiErrorBase	API-foutbasis.
AvailablePatchSummary	De beschikbare patchsamenvatting van de meest recente evaluatiebewerking voor de virtuele machine.
BootDiagnosticsInstanceView	Diagnostische gegevens over opstarten is een foutopsporingsfunctie waarmee u console-uitvoer en schermopname kunt weergeven om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. In Azure kunt u ook een schermopname van de virtuele machine zien vanuit de hypervisor.
CloudError	Een foutreactie van de Compute-service.
DiskEncryptionSettings	Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf. Minimale API-versie: 2015-06-15
DiskInstanceView	De schijfgegevens van de virtuele machine.
HyperVGenerationType	Hiermee geeft u het HyperVGeneration-type dat is gekoppeld aan een resource
InnerError	Details van interne fout.
InstanceViewStatus	Status van exemplaarweergave.
KeyVaultKeyReference	Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.
KeyVaultSecretReference	Hiermee geeft u de locatie van de schijfversleutelingssleutel op. Dit is een Key Vault Geheim.
LastPatchInstallationSummary	Het installatieoverzicht van de meest recente installatiebewerking voor de virtuele machine.
MaintenanceOperationResultCodeTypes	De resultaatcode van de laatste onderhoudsbewerking.
MaintenanceRedeployStatus	De onderhoudsbewerkingsstatus op de virtuele machine.
PatchOperationStatus	De algehele geslaagde of mislukte status van de bewerking. Het blijft 'InProgress' totdat de bewerking is voltooid. Op dat moment wordt het 'Onbekend', 'Mislukt', 'Geslaagd' of 'CompletedWithWarnings'.
StatusLevelTypes	De niveaucode.
SubResource	De relatieve URL van de Key Vault die het geheim bevat.
VirtualMachineAgentInstanceView	De VM-agent die wordt uitgevoerd op de virtuele machine.
VirtualMachineExtensionHandlerInstanceView	De instantieweergave van de extensie-handler van de virtuele machine.
VirtualMachineExtensionInstanceView	De informatie over extensies.
VirtualMachineHealthStatus	De status van de VM.
VirtualMachineInstanceView	De exemplaarweergave van een virtuele machine.
VirtualMachinePatchStatus	[Preview-functie] De status van patchbewerkingen voor virtuele machines.

ApiError

API-fout.

Name	Type	Description
code	string	De foutcode.
details	ApiErrorBase[]	De API-foutdetails
innererror	InnerError	De interne api-fout
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

ApiErrorBase

API-foutbasis.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

AvailablePatchSummary

De beschikbare patchsamenvatting van de meest recente evaluatiebewerking voor de virtuele machine.

Name	Type	Description
assessmentActivityId	string	De activiteits-id van de bewerking die dit resultaat heeft gegenereerd. Het wordt gebruikt om te correleren tussen CRP- en extensielogboeken.
criticalAndSecurityPatchCount	integer	Het aantal kritieke patches of beveiligingspatches dat is gedetecteerd als beschikbaar en nog niet geïnstalleerd.
error	ApiError	De fouten die zijn opgetreden tijdens het uitvoeren van de bewerking. De matrix met details bevat de lijst ervan.
lastModifiedTime	string	De UTC-tijdstempel wanneer de bewerking is gestart.
otherPatchCount	integer	Het aantal beschikbare patches, met uitzondering van kritiek en beveiliging.
rebootPending	boolean	De algehele status van opnieuw opstarten van de VM. Dit is waar wanneer gedeeltelijk geïnstalleerde patches opnieuw moeten worden opgestart om de installatie te voltooien, maar het opnieuw opstarten nog niet is opgetreden.
startTime	string	De UTC-tijdstempel wanneer de bewerking is gestart.
status	PatchOperationStatus	De algehele geslaagde of mislukte status van de bewerking. Het blijft 'InProgress' totdat de bewerking is voltooid. Op dat moment wordt het 'Onbekend', 'Mislukt', 'Geslaagd' of 'CompletedWithWarnings'.

BootDiagnosticsInstanceView

Diagnostische gegevens over opstarten is een foutopsporingsfunctie waarmee u console-uitvoer en schermopname kunt weergeven om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. In Azure kunt u ook een schermopname van de virtuele machine zien vanuit de hypervisor.

Name	Type	Description
consoleScreenshotBlobUri	string	De blob-URI voor schermopname van de console. Opmerking: Dit wordt niet ingesteld als diagnostische gegevens over opstarten momenteel zijn ingeschakeld met beheerde opslag.
serialConsoleLogBlobUri	string	De blob-URI van het seriële consolelogboek. Opmerking: Dit wordt niet ingesteld als diagnostische gegevens over opstarten momenteel zijn ingeschakeld met beheerde opslag.
status	InstanceViewStatus	De statusinformatie over diagnostische opstartgegevens voor de VM. Opmerking: Deze wordt alleen ingesteld als er fouten zijn opgetreden bij het inschakelen van diagnostische gegevens over opstarten.

CloudError

Een foutreactie van de Compute-service.

Name	Type	Description
error	ApiError	API-fout.

DiskEncryptionSettings

Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf.

Minimale API-versie: 2015-06-15

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Hiermee geeft u de locatie van de schijfversleutelingssleutel op. Dit is een Key Vault Geheim.
enabled	boolean	Hiermee geeft u op of schijfversleuteling moet worden ingeschakeld op de virtuele machine.
keyEncryptionKey	KeyVaultKeyReference	Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.

DiskInstanceView

De schijfgegevens van de virtuele machine.

Name	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf. Minimale API-versie: 2015-06-15
name	string	De schijfnaam.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.

HyperVGenerationType

Hiermee geeft u het HyperVGeneration-type dat is gekoppeld aan een resource

Name	Type	Description
V1	string
V2	string

InnerError

Details van interne fout.

Name	Type	Description
errordetail	string	Het interne foutbericht of de uitzonderingsdump.
exceptiontype	string	Het uitzonderingstype.

InstanceViewStatus

Status van exemplaarweergave.

Name	Type	Description
code	string	De statuscode.
displayStatus	string	Het korte lokaliseerbare label voor de status.
level	StatusLevelTypes	De niveaucode.
message	string	Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten.
time	string	Het tijdstip van de status.

KeyVaultKeyReference

Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.

Name	Type	Description
keyUrl	string	De URL die verwijst naar een sleutelversleutelingssleutel in Key Vault.
sourceVault	SubResource	De relatieve URL van de Key Vault die de sleutel bevat.

KeyVaultSecretReference

Hiermee geeft u de locatie van de schijfversleutelingssleutel op. Dit is een Key Vault Geheim.

Name	Type	Description
secretUrl	string	De URL die verwijst naar een geheim in een Key Vault.
sourceVault	SubResource	De relatieve URL van de Key Vault die het geheim bevat.

LastPatchInstallationSummary

Het installatieoverzicht van de meest recente installatiebewerking voor de virtuele machine.

Name	Type	Description
error	ApiError	De fouten die zijn opgetreden tijdens het uitvoeren van de bewerking. De detailmatrix bevat de lijst met de details.
excludedPatchCount	integer	Het aantal beschikbare patches dat expliciet is uitgesloten door een door de klant opgegeven uitsluitingslijst komt overeen.
failedPatchCount	integer	Het aantal patches waarvoor de installatie is mislukt.
installationActivityId	string	De activiteits-id van de bewerking die dit resultaat heeft geproduceerd. Het wordt gebruikt om te correleren tussen CRP- en extensielogboeken.
installedPatchCount	integer	Het aantal patches dat is geïnstalleerd.
lastModifiedTime	string	De UTC-tijdstempel wanneer de bewerking is gestart.
maintenanceWindowExceeded	boolean	Beschrijft of de bewerking te veel tijd heeft bereikt voordat alle beoogde acties zijn voltooid
notSelectedPatchCount	integer	Het aantal beschikbare patches dat niet wordt geïnstalleerd omdat het niet overeenkomt met een vermelding in een classificatie- of opnamelijst.
pendingPatchCount	integer	Het aantal beschikbare patches dat naar verwachting tijdens de installatie van de patch moet worden geïnstalleerd.
startTime	string	De UTC-tijdstempel wanneer de bewerking is gestart.
status	PatchOperationStatus	De algehele geslaagde of mislukte status van de bewerking. Het blijft 'InProgress' totdat de bewerking is voltooid. Op dat moment wordt het 'Onbekend', 'Mislukt', 'Geslaagd' of 'CompletedWithWarnings'.

MaintenanceOperationResultCodeTypes

De resultaatcode van de laatste onderhoudsbewerking.

Name	Type	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

De onderhoudsbewerkingsstatus op de virtuele machine.

Name	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Waar, als de klant onderhoud mag uitvoeren.
lastOperationMessage	string	Bericht geretourneerd voor de laatste onderhoudsbewerking.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	De resultaatcode van de laatste onderhoudsbewerking.
maintenanceWindowEndTime	string	Eindtijd voor het onderhoudsvenster.
maintenanceWindowStartTime	string	Begintijd voor het onderhoudsvenster.
preMaintenanceWindowEndTime	string	Eindtijd voor het venster Pre-onderhoud.
preMaintenanceWindowStartTime	string	Begintijd voor het pre-onderhoudsvenster.

PatchOperationStatus

De algehele geslaagde of mislukte status van de bewerking. Het blijft 'InProgress' totdat de bewerking is voltooid. Op dat moment wordt het 'Onbekend', 'Mislukt', 'Geslaagd' of 'CompletedWithWarnings'.

Name	Type	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

StatusLevelTypes

De niveaucode.

Name	Type	Description
Error	string
Info	string
Warning	string

SubResource

De relatieve URL van de Key Vault die het geheim bevat.

Name	Type	Description
id	string	Resource-id

VirtualMachineAgentInstanceView

De VM-agent die wordt uitgevoerd op de virtuele machine.

Name	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	De instantieweergave van de extensie-handler van de virtuele machine.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
vmAgentVersion	string	De volledige versie van de VM-agent.

VirtualMachineExtensionHandlerInstanceView

De instantieweergave van de extensie-handler van de virtuele machine.

Name	Type	Description
status	InstanceViewStatus	De status van de extensie-handler.
type	string	Hiermee geeft u het type van de extensie; Een voorbeeld is CustomScriptExtension.
typeHandlerVersion	string	Hiermee geeft u de versie van de scripthandler op.

VirtualMachineExtensionInstanceView

De informatie over extensies.

Name	Type	Description
name	string	De naam van de extensie van de virtuele machine.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
substatuses	InstanceViewStatus[]	De informatie over de resourcestatus.
type	string	Hiermee geeft u het type van de extensie; Een voorbeeld is CustomScriptExtension.
typeHandlerVersion	string	Hiermee geeft u de versie van de scripthandler op.

VirtualMachineHealthStatus

De status van de VM.

Name	Type	Description
status	InstanceViewStatus	De statusinformatie voor de VM.

VirtualMachineInstanceView

De exemplaarweergave van een virtuele machine.

Name	Type	Description
assignedHost	string	Resource-id van de toegewezen host, waarop de virtuele machine is toegewezen via automatische plaatsing, wanneer de virtuele machine is gekoppeld aan een toegewezen hostgroep waarvoor automatische plaatsing is ingeschakeld. Minimale API-versie: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostische gegevens over opstarten is een foutopsporingsfunctie waarmee u console-uitvoer en schermopname kunt weergeven om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. In Azure kunt u ook een schermopname van de virtuele machine zien vanuit de hypervisor.
computerName	string	De computernaam die is toegewezen aan de virtuele machine.
disks	DiskInstanceView[]	De schijfgegevens van de virtuele machine.
extensions	VirtualMachineExtensionInstanceView[]	De informatie over extensies.
hyperVGeneration	HyperVGenerationType	Hiermee geeft u het HyperVGeneration-type dat is gekoppeld aan een resource
isVMInStandbyPool	boolean	[Preview-functie] Hiermee geeft u op of de VM zich momenteel in of buiten de stand-bygroep bevindt.
maintenanceRedeployStatus	MaintenanceRedeployStatus	De onderhoudsbewerkingsstatus op de virtuele machine.
osName	string	Het besturingssysteem dat wordt uitgevoerd op de virtuele machine.
osVersion	string	De versie van het besturingssysteem dat wordt uitgevoerd op de virtuele machine.
patchStatus	VirtualMachinePatchStatus	[Preview-functie] De status van patchbewerkingen voor virtuele machines.
platformFaultDomain	integer	Hiermee geeft u het foutdomein van de virtuele machine.
platformUpdateDomain	integer	Hiermee geeft u het updatedomein van de virtuele machine.
rdpThumbPrint	string	De vingerafdruk van het extern bureaublad-certificaat.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
vmAgent	VirtualMachineAgentInstanceView	De VM-agent die wordt uitgevoerd op de virtuele machine.
vmHealth	VirtualMachineHealthStatus	De status van de VM.

VirtualMachinePatchStatus

[Preview-functie] De status van patchbewerkingen voor virtuele machines.

Name	Type	Description
availablePatchSummary	AvailablePatchSummary	De beschikbare patchsamenvatting van de meest recente evaluatiebewerking voor de virtuele machine.
configurationStatuses	InstanceViewStatus[]	De activeringsstatus van de opgegeven patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Het installatieoverzicht van de meest recente installatiebewerking voor de virtuele machine.

Virtual Machines - Instance View

URI-parameters

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

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

Sample Request

Sample Response

Get Virtual Machine Instance View.

Sample Request

Sample Response

Definities

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus

Aanvullende resources