Virtual Machine Scale Set VMs - Get Instance View

Referenz

Service:: Compute

API Version:: 2024-03-01

Ruft die status eines virtuellen Computers aus einer VM-Skalierungsgruppe ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instanceId	path	True	string	Die instance-ID des virtuellen Computers.
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.
vmScaleSetName	path	True	string	Der Name der VM-Skalierungsgruppe.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineScaleSetVMInstanceView	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 from a VM scale set placed on a dedicated host group through automatic placement.

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

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/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachineScaleSetVMsClient_GetInstanceView() {
	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.NewVirtualMachineScaleSetVMsClient().GetInstanceView(ctx, "myResourceGroup", "myVirtualMachineScaleSet", "0", 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.VirtualMachineScaleSetVMInstanceView = armcompute.VirtualMachineScaleSetVMInstanceView{
	// 	AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 	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-01T04:58:58.088Z"); return t}()),
	// 			}},
	// 	}},
	// 	PlatformFaultDomain: to.Ptr[int32](0),
	// 	PlatformUpdateDomain: to.Ptr[int32](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, "2020-06-05T04:59:58.185Z"); 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/Unavailable"),
	// 				DisplayStatus: to.Ptr("Not Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesWarning),
	// 				Message: to.Ptr("VM status blob is found but not yet populated."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-03-01T05:00:32.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("Unknown"),
	// 	},
	// }
}

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": 0,
  "platformFaultDomain": 0,
  "rdpThumbPrint": null,
  "vmAgent": {
    "vmAgentVersion": "Unknown",
    "statuses": [
      {
        "code": "ProvisioningState/Unavailable",
        "level": "Warning",
        "displayStatus": "Not Ready",
        "message": "VM status blob is found but not yet populated.",
        "time": "2024-03-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2024-03-01T04:58:58.0882815+00:00"
        }
      ]
    }
  ],
  "extensions": null,
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "bootDiagnostics": null,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": null,
      "time": "2020-06-05T04:59:58.1852966+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running",
      "message": null,
      "time": null
    }
  ]
}

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
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.
HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers [V1, V2]
InnerError	Details zu inneren Fehlern.
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, der ein Key Vault Geheimnis ist.
MaintenanceOperationResultCodeTypes	Der Ergebniscode des letzten Wartungsvorgangs.
MaintenanceRedeployStatus	Der Wartungsvorgang status auf dem virtuellen Computer.
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.
VirtualMachineScaleSetVMInstanceView	Die instance Ansicht einer VM-Skalierungsgruppe.

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 bestimmten Fehlers.

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.

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.

HyperVGeneration

Die Hypervisorgenerierung des virtuellen Computers [V1, V2]

Name	Typ	Beschreibung
V1	string
V2	string

InnerError

Details zu inneren Fehlern.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
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, der ein Key Vault Geheimnis ist.

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

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.

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.

VirtualMachineScaleSetVMInstanceView

Die instance Ansicht einer VM-Skalierungsgruppe.

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	Gibt den Hostnamen des virtuellen Computers an. Dieser Name kann nicht aktualisiert werden, nachdem der virtuelle Computer erstellt wurde. Maximale Länge (Windows): 15 Zeichen Maximale Länge (Linux): 64 Zeichen. Benennungskonventionen und Einschränkungen finden Sie unter Implementierungsrichtlinien für Azure-Infrastrukturdienste.
disks	DiskInstanceView[]	Die Datenträgerinformationen.
extensions	VirtualMachineExtensionInstanceView[]	Die Erweiterungsinformationen.
hyperVGeneration	HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Der Wartungsvorgang status auf dem virtuellen Computer.
osName	string	Das Betriebssystem, das auf dem Hybridcomputer ausgeführt wird.
osVersion	string	Die Version des Betriebssystems, das auf dem Hybridcomputer ausgeführt wird.
placementGroupId	string	Die Platzierungsgruppe, in der die VM ausgeführt wird. Wenn die Zuordnung des virtuellen Computers aufgehoben wird, verfügt er nicht über eine placementGroupId.
platformFaultDomain	integer	Die Anzahl der Fehlerdomänen.
platformUpdateDomain	integer	Die Anzahl der Updatedomänen.
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.