Virtual Machines - Instance View

Odwołanie

Service:: Compute

API Version:: 2024-03-01

Pobiera informacje o stanie czasu wykonywania maszyny wirtualnej.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
vmName	path	True	string	Nazwa maszyny wirtualnej.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VirtualMachineInstanceView	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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"
    }
  ]
}

Definicje

Nazwa	Opis
ApiError	Błąd interfejsu API.
ApiErrorBase	Baza błędów interfejsu API.
AvailablePatchSummary	Dostępne podsumowanie poprawki najnowszej operacji oceny dla maszyny wirtualnej.
BootDiagnosticsInstanceView	Diagnostyka rozruchu to funkcja debugowania, która umożliwia wyświetlenie danych wyjściowych konsoli i zrzutu ekranu w celu zdiagnozowania stanu maszyny wirtualnej. Możesz łatwo wyświetlić dane wyjściowe dziennika konsoli. Platforma Azure umożliwia również wyświetlanie zrzutu ekranu maszyny wirtualnej z funkcji hypervisor.
CloudError	Odpowiedź o błędzie z usługi Compute.
DiskEncryptionSettings	Określa ustawienia szyfrowania dysku systemu operacyjnego. Minimalna wersja interfejsu API: 2015-06-15
DiskInstanceView	Informacje o dysku maszyny wirtualnej.
HyperVGenerationType	Określa typ funkcji HyperVGeneration skojarzony z zasobem
InnerError	Szczegóły błędu wewnętrznego.
InstanceViewStatus	Stan widoku wystąpienia.
KeyVaultKeyReference	Określa lokalizację klucza szyfrowania klucza w Key Vault.
KeyVaultSecretReference	Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.
LastPatchInstallationSummary	Podsumowanie instalacji najnowszej operacji instalacji maszyny wirtualnej.
MaintenanceOperationResultCodeTypes	Kod wyniku ostatniej operacji konserwacji.
MaintenanceRedeployStatus	Stan operacja konserwacji na maszynie wirtualnej.
PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress" do momentu zakończenia operacji. W tym momencie stanie się "Nieznany", "Niepowodzenie", "Powodzenie" lub "CompletedWithWarnings".
StatusLevelTypes	Kod poziomu.
SubResource	Względny adres URL Key Vault zawierający wpis tajny.
VirtualMachineAgentInstanceView	Agent maszyny wirtualnej uruchomiony na maszynie wirtualnej.
VirtualMachineExtensionHandlerInstanceView	Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.
VirtualMachineExtensionInstanceView	Informacje o rozszerzeniach.
VirtualMachineHealthStatus	Stan kondycji maszyny wirtualnej.
VirtualMachineInstanceView	Widok wystąpienia maszyny wirtualnej.
VirtualMachinePatchStatus	[Funkcja w wersji zapoznawczej] Stan operacji poprawek maszyny wirtualnej.

ApiError

Błąd interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Wewnętrzny błąd interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

AvailablePatchSummary

Dostępne podsumowanie poprawki najnowszej operacji oceny dla maszyny wirtualnej.

Nazwa	Typ	Opis
assessmentActivityId	string	Identyfikator działania operacji, która wygenerowała ten wynik. Służy do korelowania dzienników CRP i rozszerzeń.
criticalAndSecurityPatchCount	integer	Liczba krytycznych lub wykrytych poprawek zabezpieczeń, które zostały wykryte jako dostępne i nie zostały jeszcze zainstalowane.
error	ApiError	Błędy, które wystąpiły podczas wykonywania operacji. Tablica szczegółów zawiera listę.
lastModifiedTime	string	Znacznik czasu UTC po rozpoczęciu operacji.
otherPatchCount	integer	Liczba wszystkich dostępnych poprawek z wyłączeniem krytycznych i zabezpieczeń.
rebootPending	boolean	Ogólny stan ponownego uruchomienia maszyny wirtualnej. Będzie to miało miejsce, gdy częściowo zainstalowane poprawki wymagają ponownego uruchomienia w celu ukończenia instalacji, ale nie wystąpił jeszcze ponowny rozruch.
startTime	string	Znacznik czasu UTC po rozpoczęciu operacji.
status	PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress" do momentu zakończenia operacji. W tym momencie stanie się "Nieznany", "Niepowodzenie", "Powodzenie" lub "CompletedWithWarnings".

BootDiagnosticsInstanceView

Diagnostyka rozruchu to funkcja debugowania, która umożliwia wyświetlenie danych wyjściowych konsoli i zrzutu ekranu w celu zdiagnozowania stanu maszyny wirtualnej. Możesz łatwo wyświetlić dane wyjściowe dziennika konsoli. Platforma Azure umożliwia również wyświetlanie zrzutu ekranu maszyny wirtualnej z funkcji hypervisor.

Nazwa	Typ	Opis
consoleScreenshotBlobUri	string	Identyfikator URI zrzutu ekranu konsoli obiektu blob. Uwaga: Nie zostanie to ustawione, jeśli diagnostyka rozruchu jest obecnie włączona z magazynem zarządzanym.
serialConsoleLogBlobUri	string	Identyfikator URI dziennika konsoli szeregowej obiektu blob. Uwaga: Nie zostanie to ustawione, jeśli diagnostyka rozruchu jest obecnie włączona z magazynem zarządzanym.
status	InstanceViewStatus	Informacje o stanie diagnostyki rozruchu maszyny wirtualnej. Uwaga: Zostanie ona ustawiona tylko wtedy, gdy wystąpią błędy podczas włączania diagnostyki rozruchu.

CloudError

Odpowiedź o błędzie z usługi Compute.

Nazwa	Typ	Opis
error	ApiError	Błąd interfejsu API.

DiskEncryptionSettings

Określa ustawienia szyfrowania dysku systemu operacyjnego.

Minimalna wersja interfejsu API: 2015-06-15

Nazwa	Typ	Opis
diskEncryptionKey	KeyVaultSecretReference	Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.
enabled	boolean	Określa, czy szyfrowanie dysków powinno być włączone na maszynie wirtualnej.
keyEncryptionKey	KeyVaultKeyReference	Określa lokalizację klucza szyfrowania klucza w Key Vault.

DiskInstanceView

Informacje o dysku maszyny wirtualnej.

Nazwa	Typ	Opis
encryptionSettings	DiskEncryptionSettings[]	Określa ustawienia szyfrowania dysku systemu operacyjnego. Minimalna wersja interfejsu API: 2015-06-15
name	string	Nazwa dysku.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.

HyperVGenerationType

Określa typ funkcji HyperVGeneration skojarzony z zasobem

Nazwa	Typ	Opis
V1	string
V2	string

InnerError

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

InstanceViewStatus

Stan widoku wystąpienia.

Nazwa	Typ	Opis
code	string	Kod stanu.
displayStatus	string	Krótka etykieta lokalizowalna dla stanu.
level	StatusLevelTypes	Kod poziomu.
message	string	Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach.
time	string	Czas stanu.

KeyVaultKeyReference

Określa lokalizację klucza szyfrowania klucza w Key Vault.

Nazwa	Typ	Opis
keyUrl	string	Adres URL odwołującego się do klucza szyfrowania kluczy w Key Vault.
sourceVault	SubResource	Względny adres URL Key Vault zawierający klucz.

KeyVaultSecretReference

Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.

Nazwa	Typ	Opis
secretUrl	string	Adres URL odwołujące się do wpisu tajnego w Key Vault.
sourceVault	SubResource	Względny adres URL Key Vault zawierający wpis tajny.

LastPatchInstallationSummary

Podsumowanie instalacji najnowszej operacji instalacji maszyny wirtualnej.

Nazwa	Typ	Opis
error	ApiError	Błędy, które wystąpiły podczas wykonywania operacji. Tablica szczegółów zawiera listę.
excludedPatchCount	integer	Liczba wszystkich dostępnych poprawek, ale wykluczona jawnie przez dopasowanie listy wykluczeń określonych przez klienta.
failedPatchCount	integer	Liczba poprawek, które zakończyły się niepowodzeniem podczas instalacji.
installationActivityId	string	Identyfikator działania operacji, która wygenerowała ten wynik. Służy do korelowania dzienników CRP i rozszerzeń.
installedPatchCount	integer	Liczba poprawek, które zostały pomyślnie zainstalowane.
lastModifiedTime	string	Znacznik czasu UTC po rozpoczęciu operacji.
maintenanceWindowExceeded	boolean	Opisuje, czy operacja zabrakła czasu przed ukończeniem wszystkich zamierzonych akcji
notSelectedPatchCount	integer	Liczba wszystkich dostępnych poprawek, ale nie zostanie zainstalowana, ponieważ nie jest zgodna z wpisem klasyfikacji ani listy dołączania.
pendingPatchCount	integer	Liczba wszystkich dostępnych poprawek, które mają zostać zainstalowane w trakcie operacji instalacji poprawek.
startTime	string	Znacznik czasu UTC po rozpoczęciu operacji.
status	PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress" do momentu zakończenia operacji. W tym momencie stanie się "Nieznany", "Niepowodzenie", "Powodzenie" lub "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

Kod wyniku ostatniej operacji konserwacji.

Nazwa	Typ	Opis
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Stan operacja konserwacji na maszynie wirtualnej.

Nazwa	Typ	Opis
isCustomerInitiatedMaintenanceAllowed	boolean	Prawda, jeśli klient może wykonać konserwację.
lastOperationMessage	string	Komunikat zwrócony dla ostatniej operacji konserwacji.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Kod wyniku ostatniej operacji konserwacji.
maintenanceWindowEndTime	string	Godzina zakończenia okna obsługi.
maintenanceWindowStartTime	string	Godzina rozpoczęcia okna obsługi.
preMaintenanceWindowEndTime	string	Godzina zakończenia okna przed konserwacją.
preMaintenanceWindowStartTime	string	Godzina rozpoczęcia okna przed konserwacją.

PatchOperationStatus

Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress" do momentu zakończenia operacji. W tym momencie stanie się "Nieznany", "Niepowodzenie", "Powodzenie" lub "CompletedWithWarnings".

Nazwa	Typ	Opis
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

StatusLevelTypes

Kod poziomu.

Nazwa	Typ	Opis
Error	string
Info	string
Warning	string

SubResource

Względny adres URL Key Vault zawierający wpis tajny.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu

VirtualMachineAgentInstanceView

Agent maszyny wirtualnej uruchomiony na maszynie wirtualnej.

Nazwa	Typ	Opis
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.
vmAgentVersion	string	Pełna wersja agenta maszyny wirtualnej.

VirtualMachineExtensionHandlerInstanceView

Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.

Nazwa	Typ	Opis
status	InstanceViewStatus	Stan procedury obsługi rozszerzeń.
type	string	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".
typeHandlerVersion	string	Określa wersję programu obsługi skryptów.

VirtualMachineExtensionInstanceView

Informacje o rozszerzeniach.

Nazwa	Typ	Opis
name	string	Nazwa rozszerzenia maszyny wirtualnej.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.
substatuses	InstanceViewStatus[]	Informacje o stanie zasobu.
type	string	Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".
typeHandlerVersion	string	Określa wersję programu obsługi skryptów.

VirtualMachineHealthStatus

Stan kondycji maszyny wirtualnej.

Nazwa	Typ	Opis
status	InstanceViewStatus	Informacje o stanie kondycji maszyny wirtualnej.

VirtualMachineInstanceView

Widok wystąpienia maszyny wirtualnej.

Nazwa	Typ	Opis
assignedHost	string	Identyfikator zasobu dedykowanego hosta, na którym maszyna wirtualna jest przydzielana przez automatyczne umieszczanie, gdy maszyna wirtualna jest skojarzona z dedykowaną grupą hostów z włączoną automatyczną umieszczaniem. Minimalna wersja interfejsu API: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostyka rozruchu to funkcja debugowania, która umożliwia wyświetlenie danych wyjściowych konsoli i zrzutu ekranu w celu zdiagnozowania stanu maszyny wirtualnej. Możesz łatwo wyświetlić dane wyjściowe dziennika konsoli. Platforma Azure umożliwia również wyświetlanie zrzutu ekranu maszyny wirtualnej z funkcji hypervisor.
computerName	string	Nazwa komputera przypisana do maszyny wirtualnej.
disks	DiskInstanceView[]	Informacje o dysku maszyny wirtualnej.
extensions	VirtualMachineExtensionInstanceView[]	Informacje o rozszerzeniach.
hyperVGeneration	HyperVGenerationType	Określa typ funkcji HyperVGeneration skojarzony z zasobem
isVMInStandbyPool	boolean	[Funkcja w wersji zapoznawczej] Określa, czy maszyna wirtualna znajduje się obecnie w puli rezerwowej, czy poza nie.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Stan operacja konserwacji na maszynie wirtualnej.
osName	string	System operacyjny uruchomiony na maszynie wirtualnej.
osVersion	string	Wersja systemu operacyjnego uruchomiona na maszynie wirtualnej.
patchStatus	VirtualMachinePatchStatus	[Funkcja w wersji zapoznawczej] Stan operacji poprawek maszyny wirtualnej.
platformFaultDomain	integer	Określa domenę błędów maszyny wirtualnej.
platformUpdateDomain	integer	Określa domenę aktualizacji maszyny wirtualnej.
rdpThumbPrint	string	Odcisk palca certyfikatu pulpitu zdalnego.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.
vmAgent	VirtualMachineAgentInstanceView	Agent maszyny wirtualnej uruchomiony na maszynie wirtualnej.
vmHealth	VirtualMachineHealthStatus	Stan kondycji maszyny wirtualnej.

VirtualMachinePatchStatus

[Funkcja w wersji zapoznawczej] Stan operacji poprawek maszyny wirtualnej.

Nazwa	Typ	Opis
availablePatchSummary	AvailablePatchSummary	Dostępne podsumowanie poprawki najnowszej operacji oceny dla maszyny wirtualnej.
configurationStatuses	InstanceViewStatus[]	Stan włączania określonej funkcji patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Podsumowanie instalacji najnowszej operacji instalacji maszyny wirtualnej.

Virtual Machines - Instance View

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

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

Definicje

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus

Dodatkowe zasoby