Virtual Machines - Instance View

Référence

Service:: Compute

API Version:: 2024-03-01

Récupère des informations sur l’état d’exécution d’une machine virtuelle.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
vmName	path	True	string	Nom de la machine virtuelle.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	VirtualMachineInstanceView	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreurs de l’API.
AvailablePatchSummary	Résumé du correctif disponible de la dernière opération d’évaluation pour la machine virtuelle.
BootDiagnosticsInstanceView	Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer les status de machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.
CloudError	Réponse d’erreur du service de calcul.
DiskEncryptionSettings	Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’api : 15/06/2015
DiskInstanceView	Informations sur le disque de machine virtuelle.
HyperVGenerationType	Spécifie le type HyperVGeneration associé à une ressource
InnerError	Détails internes de l’erreur.
InstanceViewStatus	Vue d’instance status.
KeyVaultKeyReference	Spécifie l’emplacement de la clé de chiffrement de clé dans Key Vault.
KeyVaultSecretReference	Spécifie l’emplacement de la clé de chiffrement de disque, qui est un secret Key Vault.
LastPatchInstallationSummary	Résumé de l’installation de la dernière opération d’installation de la machine virtuelle.
MaintenanceOperationResultCodeTypes	Code de résultat de la dernière opération de maintenance.
MaintenanceRedeployStatus	L’opération de maintenance status sur la machine virtuelle.
PatchOperationStatus	Status de réussite ou d’échec global de l’opération. Elle reste « InProgress » jusqu’à la fin de l’opération. À ce stade, il deviendra « Unknown », « Failed », « Succeeded » ou « CompletedWithWarnings ».
StatusLevelTypes	Code de niveau.
SubResource	URL relative du Key Vault contenant le secret.
VirtualMachineAgentInstanceView	Agent de machine virtuelle en cours d’exécution sur la machine virtuelle.
VirtualMachineExtensionHandlerInstanceView	Le gestionnaire d’extension de machine virtuelle instance vue.
VirtualMachineExtensionInstanceView	Informations sur les extensions.
VirtualMachineHealthStatus	Le status d’intégrité de la machine virtuelle.
VirtualMachineInstanceView	Vue instance d’une machine virtuelle.
VirtualMachinePatchStatus	[Fonctionnalité en préversion] Status des opérations correctives de machine virtuelle.

ApiError

Erreur d’API.

Nom	Type	Description
code	string	Code d'erreur.
details	ApiErrorBase[]	Détails de l’erreur api
innererror	InnerError	Erreur interne de l’API
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

ApiErrorBase

Base d’erreurs de l’API.

Nom	Type	Description
code	string	Code d'erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

AvailablePatchSummary

Résumé du correctif disponible de la dernière opération d’évaluation pour la machine virtuelle.

Nom	Type	Description
assessmentActivityId	string	ID d’activité de l’opération qui a produit ce résultat. Il est utilisé pour mettre en corrélation les journaux d’activité crp et d’extension.
criticalAndSecurityPatchCount	integer	Nombre de correctifs critiques ou de sécurité qui ont été détectés comme disponibles et qui n’ont pas encore été installés.
error	ApiError	Erreurs rencontrées lors de l’exécution de l’opération. Le tableau de détails contient la liste de ceux-ci.
lastModifiedTime	string	Horodatage UTC au début de l’opération.
otherPatchCount	integer	Nombre de tous les correctifs disponibles, à l’exception des correctifs critiques et de la sécurité.
rebootPending	boolean	Redémarrage global status de la machine virtuelle. Cela sera vrai lorsque des correctifs partiellement installés nécessitent un redémarrage pour terminer l’installation, mais que le redémarrage n’a pas encore eu lieu.
startTime	string	Horodatage UTC au début de l’opération.
status	PatchOperationStatus	Status de réussite ou d’échec global de l’opération. Elle reste « InProgress » jusqu’à la fin de l’opération. À ce stade, il deviendra « Unknown », « Failed », « Succeeded » ou « CompletedWithWarnings ».

BootDiagnosticsInstanceView

Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer les status de machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

Nom	Type	Description
consoleScreenshotBlobUri	string	URI d’objet blob de capture d’écran de la console. Note: Cela ne sera pas défini si le diagnostics de démarrage est actuellement activé avec le stockage managé.
serialConsoleLogBlobUri	string	URI d’objet blob de journal de console série. Note: Cela ne sera pas défini si le diagnostics de démarrage est actuellement activé avec le stockage managé.
status	InstanceViewStatus	Le démarrage diagnostics status informations pour la machine virtuelle. Note: Il sera défini uniquement si des erreurs sont rencontrées lors de l’activation de l’diagnostics de démarrage.

CloudError

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

DiskEncryptionSettings

Spécifie les paramètres de chiffrement du disque du système d’exploitation.

Version minimale de l’api : 15/06/2015

Nom	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Spécifie l’emplacement de la clé de chiffrement de disque, qui est un secret Key Vault.
enabled	boolean	Spécifie si le chiffrement de disque doit être activé sur la machine virtuelle.
keyEncryptionKey	KeyVaultKeyReference	Spécifie l’emplacement de la clé de chiffrement de clé dans Key Vault.

DiskInstanceView

Informations sur le disque de machine virtuelle.

Nom	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’api : 15/06/2015
name	string	Nom du disque.
statuses	InstanceViewStatus[]	La ressource status informations.

HyperVGenerationType

Spécifie le type HyperVGeneration associé à une ressource

Nom	Type	Description
V1	string
V2	string

InnerError

Détails internes de l’erreur.

Nom	Type	Description
errordetail	string	Message d’erreur interne ou vidage d’exception.
exceptiontype	string	Type d'exception.

InstanceViewStatus

Vue d’instance status.

Nom	Type	Description
code	string	Code d'état.
displayStatus	string	Étiquette courte localisable pour le status.
level	StatusLevelTypes	Code de niveau.
message	string	Message de status détaillé, y compris pour les alertes et les messages d’erreur.
time	string	Heure du status.

KeyVaultKeyReference

Spécifie l’emplacement de la clé de chiffrement de clé dans Key Vault.

Nom	Type	Description
keyUrl	string	URL référençant une clé de chiffrement de clé dans Key Vault.
sourceVault	SubResource	URL relative du Key Vault contenant la clé.

KeyVaultSecretReference

Spécifie l’emplacement de la clé de chiffrement de disque, qui est un secret Key Vault.

Nom	Type	Description
secretUrl	string	URL référençant un secret dans un Key Vault.
sourceVault	SubResource	URL relative du Key Vault contenant le secret.

LastPatchInstallationSummary

Résumé de l’installation de la dernière opération d’installation de la machine virtuelle.

Nom	Type	Description
error	ApiError	Erreurs rencontrées lors de l’exécution de l’opération. Le tableau de détails contient la liste de ceux-ci.
excludedPatchCount	integer	Nombre de tous les correctifs disponibles mais exclus explicitement par une liste d’exclusions spécifiée par le client correspond.
failedPatchCount	integer	Nombre de correctifs ayant échoué l’installation.
installationActivityId	string	ID d’activité de l’opération qui a produit ce résultat. Il est utilisé pour mettre en corrélation les journaux d’activité crp et d’extension.
installedPatchCount	integer	Nombre de correctifs installés avec succès.
lastModifiedTime	string	Horodatage UTC au début de l’opération.
maintenanceWindowExceeded	boolean	Décrit si l’opération a expiré avant d’effectuer toutes les actions prévues.
notSelectedPatchCount	integer	Nombre de tous les correctifs disponibles, mais qui ne seront pas installés, car ils ne correspondent pas à une entrée de classification ou de liste d’inclusion.
pendingPatchCount	integer	Nombre de tous les correctifs disponibles qui doivent être installés au cours de l’opération d’installation du correctif.
startTime	string	Horodatage UTC au début de l’opération.
status	PatchOperationStatus	Status de réussite ou d’échec global de l’opération. Elle reste « InProgress » jusqu’à la fin de l’opération. À ce stade, il deviendra « Unknown », « Failed », « Succeeded » ou « CompletedWithWarnings ».

MaintenanceOperationResultCodeTypes

Code de résultat de la dernière opération de maintenance.

Nom	Type	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

L’opération de maintenance status sur la machine virtuelle.

Nom	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	True, si le client est autorisé à effectuer la maintenance.
lastOperationMessage	string	Message retourné pour la dernière opération de maintenance.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Code de résultat de la dernière opération de maintenance.
maintenanceWindowEndTime	string	Heure de fin de la fenêtre Maintenance.
maintenanceWindowStartTime	string	Heure de début de la fenêtre Maintenance.
preMaintenanceWindowEndTime	string	Heure de fin de la fenêtre De pré maintenance.
preMaintenanceWindowStartTime	string	Heure de début de la fenêtre Pré maintenance.

PatchOperationStatus

Status de réussite ou d’échec global de l’opération. Elle reste « InProgress » jusqu’à la fin de l’opération. À ce stade, il deviendra « Unknown », « Failed », « Succeeded » ou « CompletedWithWarnings ».

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

StatusLevelTypes

Code de niveau.

Nom	Type	Description
Error	string
Info	string
Warning	string

SubResource

URL relative du Key Vault contenant le secret.

Nom	Type	Description
id	string	ID de ressource

VirtualMachineAgentInstanceView

Agent de machine virtuelle en cours d’exécution sur la machine virtuelle.

Nom	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Le gestionnaire d’extension de machine virtuelle instance vue.
statuses	InstanceViewStatus[]	La ressource status informations.
vmAgentVersion	string	Version complète de l’agent de machine virtuelle.

VirtualMachineExtensionHandlerInstanceView

Le gestionnaire d’extension de machine virtuelle instance vue.

Nom	Type	Description
status	InstanceViewStatus	Le gestionnaire d’extensions status.
type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
typeHandlerVersion	string	Spécifie la version du gestionnaire de script.

VirtualMachineExtensionInstanceView

Informations sur les extensions.

Nom	Type	Description
name	string	Nom de l’extension de machine virtuelle.
statuses	InstanceViewStatus[]	La ressource status informations.
substatuses	InstanceViewStatus[]	La ressource status informations.
type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
typeHandlerVersion	string	Spécifie la version du gestionnaire de script.

VirtualMachineHealthStatus

Le status d’intégrité de la machine virtuelle.

Nom	Type	Description
status	InstanceViewStatus	L’intégrité status informations pour la machine virtuelle.

VirtualMachineInstanceView

Vue instance d’une machine virtuelle.

Nom	Type	Description
assignedHost	string	ID de ressource de l’hôte dédié, sur lequel la machine virtuelle est allouée via le placement automatique, lorsque la machine virtuelle est associée à un groupe hôte dédié pour lequel le placement automatique est activé. Version minimale de l’api : 01/06/2020.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer les status de machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.
computerName	string	Nom de l’ordinateur attribué à la machine virtuelle.
disks	DiskInstanceView[]	Informations sur le disque de machine virtuelle.
extensions	VirtualMachineExtensionInstanceView[]	Informations sur les extensions.
hyperVGeneration	HyperVGenerationType	Spécifie le type HyperVGeneration associé à une ressource
isVMInStandbyPool	boolean	[Fonctionnalité en préversion] Spécifie si la machine virtuelle est actuellement dans ou hors du pool de secours.
maintenanceRedeployStatus	MaintenanceRedeployStatus	L’opération de maintenance status sur la machine virtuelle.
osName	string	Système d’exploitation s’exécutant sur la machine virtuelle.
osVersion	string	Version du système d’exploitation s’exécutant sur la machine virtuelle.
patchStatus	VirtualMachinePatchStatus	[Fonctionnalité en préversion] Status des opérations correctives de machine virtuelle.
platformFaultDomain	integer	Spécifie le domaine par défaut de la machine virtuelle.
platformUpdateDomain	integer	Spécifie le domaine de mise à jour de la machine virtuelle.
rdpThumbPrint	string	Empreinte du certificat Bureau à distance.
statuses	InstanceViewStatus[]	La ressource status informations.
vmAgent	VirtualMachineAgentInstanceView	Agent de machine virtuelle en cours d’exécution sur la machine virtuelle.
vmHealth	VirtualMachineHealthStatus	Le status d’intégrité de la machine virtuelle.

VirtualMachinePatchStatus

[Fonctionnalité en préversion] Status des opérations correctives de machine virtuelle.

Nom	Type	Description
availablePatchSummary	AvailablePatchSummary	Résumé du correctif disponible de la dernière opération d’évaluation pour la machine virtuelle.
configurationStatuses	InstanceViewStatus[]	Status d’activation du patchMode spécifié
lastPatchInstallationSummary	LastPatchInstallationSummary	Résumé de l’installation de la dernière opération d’installation de la machine virtuelle.

Virtual Machines - Instance View

Paramètres URI

Réponses

Sécurité

azure_auth

Scopes

Exemples

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

Définitions

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus

Ressources supplémentaires