Virtual Machines - Instance View

Referencia

Service:: Compute

API Version:: 2024-03-01

Recupera información sobre el estado en tiempo de ejecución de una máquina virtual.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
vmName	path	True	string	El nombre de la máquina virtual.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineInstanceView	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

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

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

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

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

Definiciones

Nombre	Description
ApiError	Error de api.
ApiErrorBase	Base de errores de API.
AvailablePatchSummary	El resumen de revisión disponible de la operación de evaluación más reciente para la máquina virtual.
BootDiagnosticsInstanceView	Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.
CloudError	Respuesta de error del servicio Compute.
DiskEncryptionSettings	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15
DiskInstanceView	Información del disco de la máquina virtual.
HyperVGenerationType	Especifica el tipo de hyperVGeneration asociado a un recurso.
InnerError	Detalles del error interno.
InstanceViewStatus	Estado de la vista de instancia.
KeyVaultKeyReference	Especifica la ubicación de la clave de cifrado de claves en Key Vault.
KeyVaultSecretReference	Especifica la ubicación de la clave de cifrado de disco, que es un secreto Key Vault.
LastPatchInstallationSummary	El resumen de instalación de la operación de instalación más reciente para la máquina virtual.
MaintenanceOperationResultCodeTypes	Código de resultado de la última operación de mantenimiento.
MaintenanceRedeployStatus	Estado de la operación de mantenimiento en la máquina virtual.
PatchOperationStatus	Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Desconocido", "Failed", "Succeeded" o "CompletedWithWarnings".
StatusLevelTypes	El código de nivel.
SubResource	Dirección URL relativa del Key Vault que contiene el secreto.
VirtualMachineAgentInstanceView	Agente de máquina virtual que se ejecuta en la máquina virtual.
VirtualMachineExtensionHandlerInstanceView	Vista de instancia del controlador de extensión de máquina virtual.
VirtualMachineExtensionInstanceView	Información de extensiones.
VirtualMachineHealthStatus	Estado de mantenimiento de la máquina virtual.
VirtualMachineInstanceView	Vista de instancia de una máquina virtual.
VirtualMachinePatchStatus	[Característica de vista previa] Estado de las operaciones de revisión de máquina virtual.

ApiError

Error de api.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de api
innererror	InnerError	Error interno de api
message	string	El mensaje de error.
target	string	Destino del error determinado.

ApiErrorBase

Base de errores de API.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.
target	string	Destino del error concreto.

AvailablePatchSummary

El resumen de revisión disponible de la operación de evaluación más reciente para la máquina virtual.

Nombre	Tipo	Description
assessmentActivityId	string	Identificador de actividad de la operación que generó este resultado. Se usa para correlacionar entre los registros de CRP y de extensión.
criticalAndSecurityPatchCount	integer	Número de revisiones críticas o de seguridad que se han detectado como disponibles y que aún no están instaladas.
error	ApiError	Errores que se encontraron durante la ejecución de la operación. La matriz de detalles contiene la lista de ellos.
lastModifiedTime	string	Marca de tiempo UTC cuando se inició la operación.
otherPatchCount	integer	El número de todas las revisiones disponibles, excepto las críticas y la seguridad.
rebootPending	boolean	Estado de reinicio general de la máquina virtual. Será true cuando las revisiones instaladas parcialmente requieran un reinicio para completar la instalación, pero el reinicio aún no se ha producido.
startTime	string	Marca de tiempo UTC cuando se inició la operación.
status	PatchOperationStatus	Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Unknown", "Failed", "Succeeded" o "CompletedWithWarnings".

BootDiagnosticsInstanceView

Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

Nombre	Tipo	Description
consoleScreenshotBlobUri	string	URI del blob de la consola. Nota: Esto no se establecerá si el diagnóstico de arranque está habilitado actualmente con el almacenamiento administrado.
serialConsoleLogBlobUri	string	Uri del blob de registro de la consola serie. Nota: Esto no se establecerá si el diagnóstico de arranque está habilitado actualmente con el almacenamiento administrado.
status	InstanceViewStatus	Información de estado de diagnóstico de arranque de la máquina virtual. Nota: Solo se establecerá si se producen errores en la habilitación de diagnósticos de arranque.

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de api.

DiskEncryptionSettings

Especifica la configuración de cifrado del disco del sistema operativo.

Versión mínima de api: 2015-06-15

Nombre	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.
enabled	boolean	Especifica si se debe habilitar el cifrado de disco en la máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica la ubicación de la clave de cifrado de claves en Key Vault.

DiskInstanceView

Información del disco de la máquina virtual.

Nombre	Tipo	Description
encryptionSettings	DiskEncryptionSettings[]	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15
name	string	El nombre del disco.
statuses	InstanceViewStatus[]	Información de estado del recurso.

HyperVGenerationType

Especifica el tipo de hyperVGeneration asociado a un recurso.

Nombre	Tipo	Description
V1	string
V2	string

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de la excepción.

InstanceViewStatus

Estado de la vista de instancia.

Nombre	Tipo	Description
code	string	Código de estado.
displayStatus	string	Etiqueta localizable corta para el estado.
level	StatusLevelTypes	El código de nivel.
message	string	Mensaje de estado detallado, incluidas las alertas y los mensajes de error.
time	string	Hora del estado.

KeyVaultKeyReference

Especifica la ubicación de la clave de cifrado de claves en Key Vault.

Nombre	Tipo	Description
keyUrl	string	Dirección URL que hace referencia a una clave de cifrado de claves en Key Vault.
sourceVault	SubResource	Dirección URL relativa del Key Vault que contiene la clave.

KeyVaultSecretReference

Especifica la ubicación de la clave de cifrado de disco, que es un secreto Key Vault.

Nombre	Tipo	Description
secretUrl	string	Dirección URL que hace referencia a un secreto en un Key Vault.
sourceVault	SubResource	Dirección URL relativa del Key Vault que contiene el secreto.

LastPatchInstallationSummary

El resumen de instalación de la operación de instalación más reciente para la máquina virtual.

Nombre	Tipo	Description
error	ApiError	Errores que se encontraron durante la ejecución de la operación. La matriz de detalles contiene la lista de ellos.
excludedPatchCount	integer	Número de todas las revisiones disponibles pero excluidas explícitamente por una coincidencia de lista de exclusión especificada por el cliente.
failedPatchCount	integer	Recuento de revisiones que no se pudieron instalar.
installationActivityId	string	Identificador de actividad de la operación que generó este resultado. Se usa para correlacionar los registros de CRP y de extensión.
installedPatchCount	integer	Recuento de revisiones que se instalaron correctamente.
lastModifiedTime	string	Marca de tiempo UTC cuando se inició la operación.
maintenanceWindowExceeded	boolean	Describe si la operación se agotó el tiempo antes de completar todas sus acciones previstas.
notSelectedPatchCount	integer	Número de todas las revisiones disponibles, pero no se instalarán porque no coincidía con una entrada de lista de clasificación o inclusión.
pendingPatchCount	integer	Número de todas las revisiones disponibles que se espera que se instalen durante la operación de instalación de revisiones.
startTime	string	Marca de tiempo UTC cuando se inició la operación.
status	PatchOperationStatus	Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Desconocido", "Failed", "Succeeded" o "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

Código de resultado de la última operación de mantenimiento.

Nombre	Tipo	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Estado de la operación de mantenimiento en la máquina virtual.

Nombre	Tipo	Description
isCustomerInitiatedMaintenanceAllowed	boolean	True, si el cliente puede realizar mantenimiento.
lastOperationMessage	string	Mensaje devuelto para la última operación de mantenimiento.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Código de resultado de la última operación de mantenimiento.
maintenanceWindowEndTime	string	Hora de finalización de la ventana de mantenimiento.
maintenanceWindowStartTime	string	Hora de inicio de la ventana de mantenimiento.
preMaintenanceWindowEndTime	string	Hora de finalización de la ventana de mantenimiento previo.
preMaintenanceWindowStartTime	string	Hora de inicio de la ventana de mantenimiento previo.

PatchOperationStatus

Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Desconocido", "Failed", "Succeeded" o "CompletedWithWarnings".

Nombre	Tipo	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

StatusLevelTypes

El código de nivel.

Nombre	Tipo	Description
Error	string
Info	string
Warning	string

SubResource

Dirección URL relativa del Key Vault que contiene el secreto.

Nombre	Tipo	Description
id	string	Id. de recurso

VirtualMachineAgentInstanceView

Agente de máquina virtual que se ejecuta en la máquina virtual.

Nombre	Tipo	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Vista de instancia del controlador de extensión de máquina virtual.
statuses	InstanceViewStatus[]	Información de estado del recurso.
vmAgentVersion	string	Versión completa del agente de máquina virtual.

VirtualMachineExtensionHandlerInstanceView

Vista de instancia del controlador de extensión de máquina virtual.

Nombre	Tipo	Description
status	InstanceViewStatus	Estado del controlador de extensión.
type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
typeHandlerVersion	string	Especifica la versión del controlador de script.

VirtualMachineExtensionInstanceView

Información de extensiones.

Nombre	Tipo	Description
name	string	Nombre de la extensión de máquina virtual.
statuses	InstanceViewStatus[]	Información de estado del recurso.
substatuses	InstanceViewStatus[]	Información de estado del recurso.
type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
typeHandlerVersion	string	Especifica la versión del controlador de script.

VirtualMachineHealthStatus

Estado de mantenimiento de la máquina virtual.

Nombre	Tipo	Description
status	InstanceViewStatus	Información de estado de mantenimiento de la máquina virtual.

VirtualMachineInstanceView

Vista de instancia de una máquina virtual.

Nombre	Tipo	Description
assignedHost	string	Identificador de recurso del host dedicado, en el que se asigna la máquina virtual a través de la selección de ubicación automática, cuando la máquina virtual está asociada a un grupo host dedicado que tiene habilitada la selección de ubicación automática. Versión mínima de api: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnósticos de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.
computerName	string	Nombre del equipo asignado a la máquina virtual.
disks	DiskInstanceView[]	Información del disco de la máquina virtual.
extensions	VirtualMachineExtensionInstanceView[]	Información de extensiones.
hyperVGeneration	HyperVGenerationType	Especifica el tipo de hyperVGeneration asociado a un recurso.
isVMInStandbyPool	boolean	[Característica de vista previa] Especifica si la máquina virtual está actualmente dentro o fuera del grupo en espera.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Estado de la operación de mantenimiento en la máquina virtual.
osName	string	Sistema operativo que se ejecuta en la máquina virtual.
osVersion	string	Versión del sistema operativo que se ejecuta en la máquina virtual.
patchStatus	VirtualMachinePatchStatus	[Característica de vista previa] Estado de las operaciones de revisión de máquina virtual.
platformFaultDomain	integer	Especifica el dominio con error de la máquina virtual.
platformUpdateDomain	integer	Especifica el dominio de actualización de la máquina virtual.
rdpThumbPrint	string	Huella digital del certificado de Escritorio remoto.
statuses	InstanceViewStatus[]	Información de estado del recurso.
vmAgent	VirtualMachineAgentInstanceView	Agente de máquina virtual que se ejecuta en la máquina virtual.
vmHealth	VirtualMachineHealthStatus	Estado de mantenimiento de la máquina virtual.

VirtualMachinePatchStatus

[Característica de vista previa] Estado de las operaciones de revisión de máquina virtual.

Nombre	Tipo	Description
availablePatchSummary	AvailablePatchSummary	El resumen de revisión disponible de la operación de evaluación más reciente para la máquina virtual.
configurationStatuses	InstanceViewStatus[]	Estado de habilitación del patchMode especificado
lastPatchInstallationSummary	LastPatchInstallationSummary	El resumen de instalación de la operación de instalación más reciente para la máquina virtual.

Virtual Machines - Instance View

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

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

Definiciones

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus

Recursos adicionales