Virtual Machines - Instance View

Referência

Service:: Compute

API Version:: 2024-03-01

Obtém informações sobre o estado de tempo de execução de uma 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 do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
vmName	path	True	string	O nome da máquina virtual.
api-version	query	True	string	Versão da API do Cliente.

Respostas

Name	Tipo	Description
200 OK	VirtualMachineInstanceView	OK
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Definições

Name	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros da API.
AvailablePatchSummary	O resumo do patch disponível da operação de avaliação mais recente da máquina virtual.
BootDiagnosticsInstanceView	O Diagnóstico de Arranque é uma funcionalidade de depuração que lhe permite ver a Saída da Consola e a Captura de Ecrã para diagnosticar o estado da VM. Pode ver facilmente o resultado do registo da consola. O Azure também lhe permite ver uma captura de ecrã da VM a partir do hipervisor.
CloudError	Uma resposta de erro do serviço de Computação.
DiskEncryptionSettings	Especifica as definições de encriptação para o Disco do SO. Versão mínima da API: 2015-06-15
DiskInstanceView	As informações do disco da máquina virtual.
HyperVGenerationType	Especifica o Tipo de HyperVGeneration associado a um recurso
InnerError	Detalhes do erro interno.
InstanceViewStatus	Estado da vista de instância.
KeyVaultKeyReference	Especifica a localização da chave de encriptação de chave no Key Vault.
KeyVaultSecretReference	Especifica a localização da chave de encriptação do disco, que é um segredo Key Vault.
LastPatchInstallationSummary	O resumo de instalação da operação de instalação mais recente da máquina virtual.
MaintenanceOperationResultCodeTypes	O código de resultado da última operação de manutenção.
MaintenanceRedeployStatus	O estado da Operação de Manutenção na máquina virtual.
PatchOperationStatus	O estado geral de êxito ou falha da operação. Permanece "InProgress" até que a operação seja concluída. Nessa altura, tornar-se-á "Desconhecido", "Com Falhas", "Com Êxito" ou "CompletedWithWarnings".
StatusLevelTypes	O código de nível.
SubResource	O URL relativo do Key Vault que contém o segredo.
VirtualMachineAgentInstanceView	O Agente da VM em execução na máquina virtual.
VirtualMachineExtensionHandlerInstanceView	A vista de instância do processador de extensões da máquina virtual.
VirtualMachineExtensionInstanceView	As informações das extensões.
VirtualMachineHealthStatus	O estado de funcionamento da VM.
VirtualMachineInstanceView	A vista de instância de uma máquina virtual.
VirtualMachinePatchStatus	[Funcionalidade de Pré-visualização] O estado das operações de patch da máquina virtual.

ApiError

Erro de API.

Name	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro da API
innererror	InnerError	O erro interno da API
message	string	A mensagem de erro.
target	string	O destino do erro específico.

ApiErrorBase

Base de erros da API.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

AvailablePatchSummary

O resumo do patch disponível da operação de avaliação mais recente da máquina virtual.

Name	Tipo	Description
assessmentActivityId	string	O ID de atividade da operação que produziu este resultado. É utilizado para correlacionar entre registos de CRP e extensões.
criticalAndSecurityPatchCount	integer	O número de patches críticos ou de segurança que foram detetados como disponíveis e ainda não instalados.
error	ApiError	Os erros encontrados durante a execução da operação. A matriz de detalhes contém a lista dos mesmos.
lastModifiedTime	string	O carimbo de data/hora UTC quando a operação começou.
otherPatchCount	integer	O número de todos os patches disponíveis, excluindo crítico e segurança.
rebootPending	boolean	O estado de reinício geral da VM. Será verdade quando os patches parcialmente instalados exigirem um reinício para concluir a instalação, mas o reinício ainda não tiver ocorrido.
startTime	string	O carimbo de data/hora UTC quando a operação começou.
status	PatchOperationStatus	O estado geral de êxito ou falha da operação. Permanece "InProgress" até que a operação seja concluída. Nessa altura, tornar-se-á "Desconhecido", "Com Falhas", "Com Êxito" ou "CompletedWithWarnings".

BootDiagnosticsInstanceView

O Diagnóstico de Arranque é uma funcionalidade de depuração que lhe permite ver a Saída da Consola e a Captura de Ecrã para diagnosticar o estado da VM. Pode ver facilmente o resultado do registo da consola. O Azure também lhe permite ver uma captura de ecrã da VM a partir do hipervisor.

Name	Tipo	Description
consoleScreenshotBlobUri	string	O URI do blob de captura de ecrã da consola. Nota: Isto não será definido se o diagnóstico de arranque estiver atualmente ativado com o armazenamento gerido.
serialConsoleLogBlobUri	string	O URI do blob de registo da consola de série. Nota: Isto não será definido se o diagnóstico de arranque estiver atualmente ativado com o armazenamento gerido.
status	InstanceViewStatus	As informações de estado do diagnóstico de arranque da VM. Nota: Só será definido se forem encontrados erros ao ativar o diagnóstico de arranque.

CloudError

Uma resposta de erro do serviço de Computação.

Name	Tipo	Description
error	ApiError	Erro de API.

DiskEncryptionSettings

Especifica as definições de encriptação para o Disco do SO.

Versão mínima da API: 2015-06-15

Name	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica a localização da chave de encriptação do disco, que é um segredo Key Vault.
enabled	boolean	Especifica se a encriptação de disco deve ser ativada na máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica a localização da chave de encriptação de chave no Key Vault.

DiskInstanceView

As informações do disco da máquina virtual.

Name	Tipo	Description
encryptionSettings	DiskEncryptionSettings[]	Especifica as definições de encriptação para o Disco do SO. Versão mínima da API: 2015-06-15
name	string	O nome do disco.
statuses	InstanceViewStatus[]	As informações de estado do recurso.

HyperVGenerationType

Especifica o Tipo de HyperVGeneration associado a um recurso

Name	Tipo	Description
V1	string
V2	string

InnerError

Detalhes do erro interno.

Name	Tipo	Description
errordetail	string	A mensagem de erro interna ou a informação de falha de sistema da exceção.
exceptiontype	string	O tipo de exceção.

InstanceViewStatus

Estado da vista de instância.

Name	Tipo	Description
code	string	O código de estado.
displayStatus	string	A etiqueta localizável curta para o estado.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de estado detalhada, incluindo para alertas e mensagens de erro.
time	string	A hora do estado.

KeyVaultKeyReference

Especifica a localização da chave de encriptação de chave no Key Vault.

Name	Tipo	Description
keyUrl	string	O URL que referencia uma chave de encriptação de chave no Key Vault.
sourceVault	SubResource	O URL relativo do Key Vault que contém a chave.

KeyVaultSecretReference

Especifica a localização da chave de encriptação do disco, que é um segredo Key Vault.

Name	Tipo	Description
secretUrl	string	O URL que referencia um segredo numa Key Vault.
sourceVault	SubResource	O URL relativo do Key Vault que contém o segredo.

LastPatchInstallationSummary

O resumo de instalação da operação de instalação mais recente da máquina virtual.

Name	Tipo	Description
error	ApiError	Os erros encontrados durante a execução da operação. A matriz de detalhes contém a lista dos mesmos.
excludedPatchCount	integer	O número de todos os patches disponíveis, mas excluídos explicitamente por uma lista de exclusão especificada pelo cliente, corresponde.
failedPatchCount	integer	A contagem de patches que falharam na instalação.
installationActivityId	string	O ID de atividade da operação que produziu este resultado. É utilizado para correlacionar entre registos de CRP e extensões.
installedPatchCount	integer	A contagem de patches que foram instalados com êxito.
lastModifiedTime	string	O carimbo de data/hora UTC quando a operação começou.
maintenanceWindowExceeded	boolean	Descreve se a operação esgotou o tempo antes de concluir todas as ações pretendidas
notSelectedPatchCount	integer	O número de todos os patches disponíveis, mas não serão instalados porque não correspondem a uma entrada de lista de classificação ou inclusão.
pendingPatchCount	integer	Espera-se que o número de todos os patches disponíveis seja instalado ao longo da operação de instalação do patch.
startTime	string	O carimbo de data/hora UTC quando a operação começou.
status	PatchOperationStatus	O estado geral de êxito ou falha da operação. Permanece "InProgress" até que a operação seja concluída. Nessa altura, tornar-se-á "Desconhecido", "Com Falhas", "Com Êxito" ou "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

O código de resultado da última operação de manutenção.

Name	Tipo	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

O estado da Operação de Manutenção na máquina virtual.

Name	Tipo	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Verdadeiro, se o cliente tiver permissão para efetuar a Manutenção.
lastOperationMessage	string	Mensagem devolvida para a última Operação de Manutenção.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	O código de resultado da última operação de manutenção.
maintenanceWindowEndTime	string	Hora de Fim da Janela de Manutenção.
maintenanceWindowStartTime	string	Hora de Início da Janela de Manutenção.
preMaintenanceWindowEndTime	string	Hora de Fim da Janela de Pré-Manutenção.
preMaintenanceWindowStartTime	string	Hora de Início da Janela de Pré-Manutenção.

PatchOperationStatus

O estado geral de êxito ou falha da operação. Permanece "InProgress" até que a operação seja concluída. Nessa altura, tornar-se-á "Desconhecido", "Com Falhas", "Com Êxito" ou "CompletedWithWarnings".

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

StatusLevelTypes

O código de nível.

Name	Tipo	Description
Error	string
Info	string
Warning	string

SubResource

O URL relativo do Key Vault que contém o segredo.

Name	Tipo	Description
id	string	ID do Recurso

VirtualMachineAgentInstanceView

O Agente da VM em execução na máquina virtual.

Name	Tipo	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	A vista de instância do processador de extensões da máquina virtual.
statuses	InstanceViewStatus[]	As informações de estado do recurso.
vmAgentVersion	string	A versão completa do Agente da VM.

VirtualMachineExtensionHandlerInstanceView

A vista de instância do processador de extensões da máquina virtual.

Name	Tipo	Description
status	InstanceViewStatus	O estado do processador de extensões.
type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do processador de scripts.

VirtualMachineExtensionInstanceView

As informações das extensões.

Name	Tipo	Description
name	string	O nome da extensão da máquina virtual.
statuses	InstanceViewStatus[]	As informações de estado do recurso.
substatuses	InstanceViewStatus[]	As informações de estado do recurso.
type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do processador de scripts.

VirtualMachineHealthStatus

O estado de funcionamento da VM.

Name	Tipo	Description
status	InstanceViewStatus	As informações de estado de funcionamento da VM.

VirtualMachineInstanceView

A vista de instância de uma máquina virtual.

Name	Tipo	Description
assignedHost	string	ID de recurso do anfitrião dedicado, no qual a máquina virtual é alocada através da colocação automática, quando a máquina virtual está associada a um grupo de anfitriões dedicado que tem a colocação automática ativada. Versão mínima da API: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	O Diagnóstico de Arranque é uma funcionalidade de depuração que lhe permite ver a Saída da Consola e a Captura de Ecrã para diagnosticar o estado da VM. Pode ver facilmente o resultado do registo da consola. O Azure também lhe permite ver uma captura de ecrã da VM a partir do hipervisor.
computerName	string	O nome do computador atribuído à máquina virtual.
disks	DiskInstanceView[]	As informações do disco da máquina virtual.
extensions	VirtualMachineExtensionInstanceView[]	As informações das extensões.
hyperVGeneration	HyperVGenerationType	Especifica o Tipo de HyperVGeneration associado a um recurso
isVMInStandbyPool	boolean	[Funcionalidade de Pré-visualização] Especifica se a VM está atualmente dentro ou fora do Conjunto de Espera.
maintenanceRedeployStatus	MaintenanceRedeployStatus	O estado da Operação de Manutenção na máquina virtual.
osName	string	O Sistema Operativo em execução na máquina virtual.
osVersion	string	A versão do Sistema Operativo em execução na máquina virtual.
patchStatus	VirtualMachinePatchStatus	[Funcionalidade de Pré-visualização] O estado das operações de patch da máquina virtual.
platformFaultDomain	integer	Especifica o domínio de falha da máquina virtual.
platformUpdateDomain	integer	Especifica o domínio de atualização da máquina virtual.
rdpThumbPrint	string	O thumbprint do certificado de ambiente de trabalho remoto.
statuses	InstanceViewStatus[]	As informações de estado do recurso.
vmAgent	VirtualMachineAgentInstanceView	O Agente da VM em execução na máquina virtual.
vmHealth	VirtualMachineHealthStatus	O estado de funcionamento da VM.

VirtualMachinePatchStatus

[Funcionalidade de Pré-visualização] O estado das operações de patch da máquina virtual.

Name	Tipo	Description
availablePatchSummary	AvailablePatchSummary	O resumo do patch disponível da operação de avaliação mais recente da máquina virtual.
configurationStatuses	InstanceViewStatus[]	O estado de ativação do patchMode especificado
lastPatchInstallationSummary	LastPatchInstallationSummary	O resumo de instalação da operação de instalação mais recente da máquina virtual.

Virtual Machines - Instance View

Parâmetros do URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

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

Definições

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 adicionais