Virtual Machines - Instance View

Service:

Compute

API Version:

2024-03-01

Ruft Informationen zum Laufzeitzustand eines virtuellen Computers ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vmName	path	True	string	Der Name des virtuellen Computers.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineInstanceView	OK
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

HTTP

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

Java

/**
 * 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

Go

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

HTTP

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

Java

/**
 * 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

Go

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

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
AvailablePatchSummary	Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.
BootDiagnosticsInstanceView	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.
CloudError	Eine Fehlerantwort des Computediensts.
DiskEncryptionSettings	Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Api-Mindestversion: 2015-06-15
DiskInstanceView	Die Datenträgerinformationen des virtuellen Computers.
HyperVGenerationType	Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist.
InnerError	Innere Fehlerdetails.
InstanceViewStatus	Instanzansicht status.
KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.
KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Key Vault Geheimnis handelt.
LastPatchInstallationSummary	Die Installationszusammenfassung des neuesten Installationsvorgangs für den virtuellen Computer.
MaintenanceOperationResultCodeTypes	Der Ergebniscode des letzten Wartungsvorgangs.
MaintenanceRedeployStatus	Der Wartungsvorgang status auf dem virtuellen Computer.
PatchOperationStatus	Der Gesamterfolg oder Fehler status des Vorgangs. Es bleibt "InProgress", bis der Vorgang abgeschlossen ist. An diesem Punkt wird es zu "Unbekannt", "Failed", "Succeeded" oder "CompletedWithWarnings".
StatusLevelTypes	Der Ebenencode.
SubResource	Die relative URL der Key Vault, die das Geheimnis enthält.
VirtualMachineAgentInstanceView	Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.
VirtualMachineExtensionHandlerInstanceView	Der Vm-Erweiterungshandler instance Ansicht.
VirtualMachineExtensionInstanceView	Die Erweiterungsinformationen.
VirtualMachineHealthStatus	Die Integrität status für den virtuellen Computer.
VirtualMachineInstanceView	Die instance Ansicht eines virtuellen Computers.
VirtualMachinePatchStatus	[Vorschaufunktion] Die status von Vm-Patchvorgängen.

ApiError

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Details zu API-Fehlern
innererror	InnerError	Innerer API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des jeweiligen Fehlers.

AvailablePatchSummary

Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.

Name	Typ	Beschreibung
assessmentActivityId	string	Die Aktivitäts-ID des Vorgangs, der dieses Ergebnis erzeugt hat. Es wird verwendet, um CRP- und Erweiterungsprotokolle hinweg zu korrelieren.
criticalAndSecurityPatchCount	integer	Die Anzahl kritischer Patches oder Sicherheitspatches, die als verfügbar erkannt und noch nicht installiert wurden.
error	ApiError	Die Fehler, die während der Ausführung des Vorgangs aufgetreten sind. Das Detailarray enthält die Liste dieser Daten.
lastModifiedTime	string	Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde.
otherPatchCount	integer	Die Anzahl aller verfügbaren Patches mit Ausnahme von "Kritisch" und "Sicherheit".
rebootPending	boolean	Der allgemeine Neustart status des virtuellen Computers. Dies trifft zu, wenn teilweise installierte Patches einen Neustart erfordern, um die Installation abzuschließen, der Neustart jedoch noch nicht erfolgt ist.
startTime	string	Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde.
status	PatchOperationStatus	Der gesamte Erfolg oder Fehler status des Vorgangs. Es bleibt "InProgress", bis der Vorgang abgeschlossen ist. An diesem Punkt wird es zu "Unknown", "Failed", "Succeeded" oder "CompletedWithWarnings".

BootDiagnosticsInstanceView

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.

Name	Typ	Beschreibung
consoleScreenshotBlobUri	string	Der Blob-URI der Konsole. Hinweis: Dies wird nicht festgelegt, wenn der Start Diagnose derzeit mit verwaltetem Speicher aktiviert ist.
serialConsoleLogBlobUri	string	Der Protokollblob-URI der seriellen Konsole. Hinweis: Dies wird nicht festgelegt, wenn der Start Diagnose derzeit mit verwaltetem Speicher aktiviert ist.
status	InstanceViewStatus	Der Start Diagnose status Informationen für den virtuellen Computer. Hinweis: Sie wird nur festgelegt, wenn Fehler beim Aktivieren des Startvorgangs Diagnose auftreten.

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

DiskEncryptionSettings

Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an.

Api-Mindestversion: 2015-06-15

Name	Typ	Beschreibung
diskEncryptionKey	KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, der ein Key Vault Geheimnis ist.
enabled	boolean	Gibt an, ob die Datenträgerverschlüsselung auf dem virtuellen Computer aktiviert werden soll.
keyEncryptionKey	KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.

DiskInstanceView

Die Datenträgerinformationen des virtuellen Computers.

Name	Typ	Beschreibung
encryptionSettings	DiskEncryptionSettings[]	Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Api-Mindestversion: 2015-06-15
name	string	Der Name des Datenträgers
statuses	InstanceViewStatus[]	Die Ressource status Informationen.

HyperVGenerationType

Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist.

Name	Typ	Beschreibung
V1	string
V2	string

InnerError

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Das interne Fehlermeldungs- oder Ausnahmedump.
exceptiontype	string	Der Ausnahmetyp.

InstanceViewStatus

Instanzansicht status.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die kurze lokalisierbare Bezeichnung für die status.
level	StatusLevelTypes	Der Ebenencode.
message	string	Die detaillierte status Meldung, einschließlich Warnungen und Fehlermeldungen.
time	string	Die Zeit der status.

KeyVaultKeyReference

Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.

Name	Typ	Beschreibung
keyUrl	string	Die URL, die auf einen Schlüsselverschlüsselungsschlüssel in Key Vault verweist.
sourceVault	SubResource	Die relative URL der Key Vault, die den Schlüssel enthält.

KeyVaultSecretReference

Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Key Vault Geheimnis handelt.

Name	Typ	Beschreibung
secretUrl	string	Die URL, die auf ein Geheimnis in einer Key Vault verweist.
sourceVault	SubResource	Die relative URL der Key Vault, die das Geheimnis enthält.

LastPatchInstallationSummary

Die Installationszusammenfassung des neuesten Installationsvorgangs für den virtuellen Computer.

Name	Typ	Beschreibung
error	ApiError	Die Fehler, die während der Ausführung des Vorgangs aufgetreten sind. Das Detailarray enthält die Liste dieser Elemente.
excludedPatchCount	integer	Die Anzahl aller verfügbaren Patches, die jedoch explizit durch eine vom Kunden angegebene Ausschlussliste übereinstimmen.
failedPatchCount	integer	Die Anzahl der Patches, bei denen die Installation fehlgeschlagen ist.
installationActivityId	string	Die Aktivitäts-ID des Vorgangs, der dieses Ergebnis erzeugt hat. Es wird verwendet, um CRP- und Erweiterungsprotokolle hinweg zu korrelieren.
installedPatchCount	integer	Die Anzahl der Patches, die erfolgreich installiert wurden.
lastModifiedTime	string	Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde.
maintenanceWindowExceeded	boolean	Beschreibt, ob der Vorgang keine Zeit mehr hatte, bevor er alle beabsichtigten Aktionen abgeschlossen hat.
notSelectedPatchCount	integer	Die Anzahl aller verfügbaren Patches, die jedoch nicht installiert werden sollen, da sie nicht mit einem Klassifizierungs- oder Einschlusslisteneintrag übereinstimmten.
pendingPatchCount	integer	Die Anzahl aller verfügbaren Patches, die während des Patchinstallationsvorgangs installiert werden sollen.
startTime	string	Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde.
status	PatchOperationStatus	Der Gesamterfolg oder Fehler status des Vorgangs. Es bleibt "InProgress", bis der Vorgang abgeschlossen ist. An diesem Punkt wird es zu "Unbekannt", "Failed", "Succeeded" oder "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

Der Ergebniscode des letzten Wartungsvorgangs.

Name	Typ	Beschreibung
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Der Wartungsvorgang status auf dem virtuellen Computer.

Name	Typ	Beschreibung
isCustomerInitiatedMaintenanceAllowed	boolean	True, wenn der Kunde die Wartung durchführen darf.
lastOperationMessage	string	Meldung, die für den letzten Wartungsvorgang zurückgegeben wird.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Der Ergebniscode des letzten Wartungsvorgangs.
maintenanceWindowEndTime	string	Endzeit für das Wartungsfenster.
maintenanceWindowStartTime	string	Startzeit für das Wartungsfenster.
preMaintenanceWindowEndTime	string	Endzeit für das Fenster "Vorwartung".
preMaintenanceWindowStartTime	string	Startzeit für das Fenster vor der Wartung.

PatchOperationStatus

Der Gesamterfolg oder Fehler status des Vorgangs. Es bleibt "InProgress", bis der Vorgang abgeschlossen ist. An diesem Punkt wird es zu "Unbekannt", "Failed", "Succeeded" oder "CompletedWithWarnings".

Name	Typ	Beschreibung
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

StatusLevelTypes

Der Ebenencode.

Name	Typ	Beschreibung
Error	string
Info	string
Warning	string

SubResource

Die relative URL der Key Vault, die das Geheimnis enthält.

Name	Typ	Beschreibung
id	string	Ressourcen-ID

VirtualMachineAgentInstanceView

Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.

Name	Typ	Beschreibung
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Der Vm-Erweiterungshandler instance Ansicht.
statuses	InstanceViewStatus[]	Die Ressource status Informationen.
vmAgentVersion	string	Die Vollversion des VM-Agents.

VirtualMachineExtensionHandlerInstanceView

Der Vm-Erweiterungshandler instance Ansicht.

Name	Typ	Beschreibung
status	InstanceViewStatus	Der Erweiterungshandler status.
type	string	Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension".
typeHandlerVersion	string	Gibt die Version des Skripthandlers an.

VirtualMachineExtensionInstanceView

Die Erweiterungsinformationen.

Name	Typ	Beschreibung
name	string	Der Name der VM-Erweiterung.
statuses	InstanceViewStatus[]	Die Ressource status Informationen.
substatuses	InstanceViewStatus[]	Die Ressource status Informationen.
type	string	Gibt den Typ der Erweiterung an. Ein Beispiel ist "CustomScriptExtension".
typeHandlerVersion	string	Gibt die Version des Skripthandlers an.

VirtualMachineHealthStatus

Die Integrität status für den virtuellen Computer.

Name	Typ	Beschreibung
status	InstanceViewStatus	Die Integrität status Informationen für den virtuellen Computer.

VirtualMachineInstanceView

Die instance Ansicht eines virtuellen Computers.

Name	Typ	Beschreibung
assignedHost	string	Ressourcen-ID des dedizierten Hosts, auf dem der virtuelle Computer durch automatische Platzierung zugeordnet wird, wenn der virtuelle Computer einer dedizierten Hostgruppe zugeordnet ist, für die die automatische Platzierung aktiviert ist. Api-Mindestversion: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um vm-status zu diagnostizieren. Sie können die Ausgabe Ihres Konsolenprotokolls problemlos anzeigen. Mit Azure können Sie auch einen Screenshot des virtuellen Computers aus dem Hypervisor anzeigen.
computerName	string	Der Computername, der dem virtuellen Computer zugewiesen ist.
disks	DiskInstanceView[]	Die Datenträgerinformationen des virtuellen Computers.
extensions	VirtualMachineExtensionInstanceView[]	Die Erweiterungsinformationen.
hyperVGeneration	HyperVGenerationType	Gibt den HyperVGeneration-Typ an, der einer Ressource zugeordnet ist.
isVMInStandbyPool	boolean	[Vorschaufunktion] Gibt an, ob sich der virtuelle Computer derzeit im Standbypool befindet oder nicht.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Der Wartungsvorgang status auf dem virtuellen Computer.
osName	string	Das Betriebssystem, das auf dem virtuellen Computer ausgeführt wird.
osVersion	string	Die Version des Betriebssystems, das auf dem virtuellen Computer ausgeführt wird.
patchStatus	VirtualMachinePatchStatus	[Vorschaufunktion] Die status von Vm-Patchvorgängen.
platformFaultDomain	integer	Gibt die Fehlerdomäne des virtuellen Computers an.
platformUpdateDomain	integer	Gibt die Updatedomäne des virtuellen Computers an.
rdpThumbPrint	string	Der Remotedesktop-Zertifikatfingerabdruck.
statuses	InstanceViewStatus[]	Die Ressource status Informationen.
vmAgent	VirtualMachineAgentInstanceView	Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.
vmHealth	VirtualMachineHealthStatus	Die Integrität status für den virtuellen Computer.

VirtualMachinePatchStatus

[Vorschaufunktion] Die status von Vm-Patchvorgängen.

Name	Typ	Beschreibung
availablePatchSummary	AvailablePatchSummary	Die verfügbare Patchzusammenfassung des neuesten Bewertungsvorgangs für den virtuellen Computer.
configurationStatuses	InstanceViewStatus[]	Die aktivierungs-status des angegebenen patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Die Installationszusammenfassung des letzten Installationsvorgangs für den virtuellen Computer.